Skip to main content
POST
Create a virtual machine

Authorizations

x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Body

application/json
regionId
string
required
Pattern: ^[cC][^\s-]{8,}$
osTemplateId
string
required
Pattern: ^[cC][^\s-]{8,}$
hostname
string
required
Required string length: 1 - 63
Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?$
planId
string
Pattern: ^[cC][^\s-]{8,}$
customConfig
object
password
string
Required string length: 8 - 128
sshKeyIds
string[]
Maximum array length: 20
Pattern: ^[cC][^\s-]{8,}$
name
string
Required string length: 1 - 100
dailyBackupEnabled
boolean
default:false
network10gEnabled
boolean
default:false
isProtected
boolean
default:false
firewallIds
string[]
Maximum array length: 10
Pattern: ^[cC][^\s-]{8,}$
privateNetworkIds
string[]
Maximum array length: 5
Pattern: ^[cC][^\s-]{8,}$

Response

Default Response

success
enum<boolean>
required
Available options:
true
data
object
required