Create Bare Metal Instances

Creates one bare metal instances with the specified custom configuration and features provided in the request body.

HTTP Request

POST {API_URL}bare-metal/instances

Body parameters

Parameters	Requirements	Type	Description
name	Required	string	Name of the bare metal instance being deployed.
image_id	Required	string	Id of the operating system image to be installed on your bare metal instance. Use the GET /bare-metal/images endpoint to retrieve a list of images offered by API.
flavor_id	Required	string	Id of the flavor corresponding to the hardware configuration (CPUs, memory, GPUs, storage and network devices) for your bare metal instance. Use the GET /bare-metal/flavors endpoint to retrieve a list of available flavors.
ssh_key	Required	Object	Detail of the SSH keypair to be used in gaining secure access to the bare metal instance. e.g., {"name":"sshkey","public_key":"ssh-ed25519 AAAA"}

NOTE

image_id and flavor_id must be from the same region; otherwise, creation will fail.

Reponse Attributes

status boolean

Indicates the result of the request to create bare metal instance. true signifies success, while false indicates an error.

message string

A description of the status of the request.

data object

An instance object, containing name and id about the request to create bare metal instance.

Example

Request

curl -X POST '{API_URL}bare-metal/instances' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json' \
-d '{
    "name":"rtx4090",
    "image_id":"6331d0eb805fd15079b6b182",
    "flavor_id":"6523bd891c8a89630712e423",
    "ssh_key":{
        "name":"sshkey",
        "public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIB6EQ4uTrwo2w+ZEBBgkAZN9kOX/sWMb5biqCet77m3q sshusername"
    }
}'

Response

{
    "status": true,
    "message": "Creating bare metal instance successful",
    "data": {
        "name": "BM-dhSqf5qh",
        "id": "66bd5a1299f01e419f5ad5ae"
    }
}