Skip to main content
POST
/
api
/
public
/
v1
/
vms
Create a virtual machine
curl --request POST \
  --url https://api.vmarea.com/api/v1/api/public/v1/vms \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "regionId": "<string>",
  "osTemplateId": "<string>",
  "hostname": "<string>",
  "planId": "<string>",
  "password": "<string>",
  "sshKeyIds": [
    "<string>"
  ],
  "name": "<string>",
  "dailyBackupEnabled": false,
  "network10gEnabled": false,
  "isProtected": false,
  "firewallIds": [],
  "privateNetworkIds": []
}
'
{
  "success": true,
  "data": {
    "vm": {
      "id": "<string>",
      "name": "<string>",
      "hostname": "<string>",
      "status": "<string>",
      "vcpu": 123,
      "ram": 123,
      "disk": 123,
      "bandwidth": 123,
      "networkSpeed": 123,
      "network10gEnabled": true,
      "dailyBackupEnabled": true,
      "isProtected": true,
      "ipAddress": "<string>",
      "region": {
        "slug": "<string>",
        "name": "<string>"
      },
      "plan": {
        "slug": "<string>",
        "name": "<string>",
        "priceMonthly": "<unknown>"
      },
      "osTemplate": {
        "slug": "<string>",
        "name": "<string>",
        "version": "<string>"
      },
      "billing": {
        "nextRenewalAt": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "priceMonthly": "<unknown>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "bandwidthUsedBytes": 123,
      "bandwidthPackBytes": "<string>",
      "sshKeys": [
        {
          "id": "<string>",
          "name": "<string>",
          "fingerprint": "<string>"
        }
      ],
      "firewalls": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "privateNetworks": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "actionId": "<string>"
  }
}

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