Skip to main content
POST
Create a VM

Authorizations

Authorization
string
header
required

Send your API token (Dashboard → Settings → API Token) as Authorization: Bearer <token>.

Body

application/json
name
string
required
password
string
required
description
string
template
string

A VPS template's id, from the dashboard's template list. When set, ram and distro come from the template and don't need to be provided.

distro
string

A distro value from GET /vms/distros. Required when template is not set.

ram
integer

RAM in MB. Required (min 4096) when template is not set.

Response

VM created successfully

id
string<uuid>
addon
object

The subscription addon created to bill for this VM's extra RAM/vCPU, if any.

invoice
object
invoice_payment_info
object