Skip to main content

Instance

A customer VM.

uuidstring<uuid>required
hostnamestringrequired
Example: web-01.example.com
statusstringrequired

Effective status. Raw guest states are on/off; the API also surfaces transitional states derived from the desired state.

Possible values: [on, off, deploy, booting, poweringdown, task]

desiredstringrequired

The desired guest state.

Possible values: [on, off, task]

createdinteger<int64>required

Unix timestamp when the instance was created.

provisionedbooleanrequired
suspendedbooleanrequired
ip_primary_v4stringnullablerequired

Primary IPv4 address, or null before allocation.

Example: 203.0.113.42
ip_primary_v6stringnullablerequired

Primary IPv6 address, or null before allocation.

Example: 2001:db8::1
location objectrequired

The location object embedded in an instance. Unlike the catalogue Location, the display name is carried in place.

idintegerrequired
Example: 1
placestringrequired
Example: Prague
countrystringrequired
Example: CZ
versionintegerrequired
Example: 3
package objectnullablerequired

The package object embedded in an instance. On the list endpoint only name is populated; the single-instance endpoint fills the rest.

idinteger
Example: 4
namestringrequired
Example: VPS-2
coresinteger
Example: 2
raminteger
Example: 2048
diskinteger
Example: 40
bandwidthinteger
Example: 2000
pricenumber<float>
Example: 0.012
price_monthlynumber<float>
Example: 8
os objectnullablerequired

The OS image, or null (e.g. instances deployed from a snapshot).

idintegerrequired
Example: 7
namestringrequired
Example: Debian 12
costnumber<float>

Month-to-date cost. Present only on the single-instance endpoint (GET /instances/{uuid}).

Instance
{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hostname": "web-01.example.com",
  "status": "on",
  "desired": "on",
  "created": 0,
  "provisioned": true,
  "suspended": true,
  "ip_primary_v4": "203.0.113.42",
  "ip_primary_v6": "2001:db8::1",
  "location": {
    "id": 1,
    "place": "Prague",
    "country": "CZ",
    "version": 3
  },
  "package": {
    "id": 4,
    "name": "VPS-2",
    "cores": 2,
    "ram": 2048,
    "disk": 40,
    "bandwidth": 2000,
    "price": 0.012,
    "price_monthly": 8
  },
  "os": {
    "id": 7,
    "name": "Debian 12"
  },
  "cost": 0
}