Skip to main content
POST
/
api
/
v2
/
external
/
vms
/
create
Create Vm
curl --request POST \
  --url https://api.example.com/api/v2/external/vms/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_public_key": "<string>",
  "hardware_profile": "<string>",
  "instance_specs": {},
  "display_name": "<string>",
  "instance_type": "on-demand"
}
'
{
  "vm_id": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "instance_specs": {},
  "ip_address": "<string>",
  "hardware_profile": "<string>",
  "gpu_count": 123,
  "instance_type": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "billed": 123,
  "croesus_billed": 123,
  "status_check_url": "<string>",
  "polling_message": "<string>",
  "user_id": "<string>",
  "org_id": "<string>"
}

Body

application/json

Request model for creating a new VM.

user_public_key
string
required
Minimum string length: 1
hardware_profile
string
required
instance_specs
Instance Specs · object
display_name
string | null
instance_type
enum<string>
default:on-demand
Available options:
on-demand,
spot

Response

Successful Response

Response model for VM operations.

vm_id
string
required
status
string
required
created_at
string<date-time>
required
instance_specs
Instance Specs · object
required
ip_address
string | null
hardware_profile
string | null
gpu_count
integer | null
instance_type
string | null
name
string | null
display_name
string | null
billed
number | null
croesus_billed
number | null
status_check_url
string | null
polling_message
string | null
user_id
string | null
org_id
string | null