Skip to main content
POST
/
api
/
v1
/
vm
/
new_root
cURL
curl --request POST \
  --url https://api.example.com/api/v1/vm/new_root \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vm_config": {
    "fs_size_mib": 1,
    "image_name": "<string>",
    "kernel_name": "<string>",
    "labels": {},
    "mem_size_mib": 1,
    "vcpu_count": 1
  }
}
'
{
  "vm_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
wait_boot
boolean

If true, wait for the newly-created VM to finish booting before returning. Default: false.

Body

application/json
​
vm_config
object
required

Struct representing configuration options common to all VMs

Response

VM created successfully

Response body for new VM requests (new_root, from_commit, branch)

​
vm_id
string
required