Skip to main content

InstanceDetail

An instance with full plan details and month-to-date plan cost, returned by GET /instances/{uuid}.

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

Current reported state. Common values are on (running), off (stopped), deploy (provisioning), booting (starting), poweringdown (stopping), task (an operation is in progress), suspended (paused), and N/A (state unavailable). Clients should tolerate additional values. This value can lag behind an accepted action, and a reboot may continue to report on.

Example: on
desiredstringrequired

Requested state, normally on or off, or task while an operation such as deletion or snapshot creation is in progress. Clients should tolerate additional values. This value alone does not confirm completion.

Example: on
createdinteger<int64>required

Unix timestamp when the instance was created.

provisionedbooleanrequired

Whether initial deployment has completed.

suspendedbooleanrequired

Whether the instance is suspended.

ip_primary_v4stringnullablerequired

Primary IPv4 address, or null if none is assigned.

Example: 203.0.113.42
ip_primary_v6stringnullablerequired

Primary IPv6 address, or null if none is assigned.

Example: 2001:db8::1
location objectrequired

The instance's location. Its display name is returned in place.

idintegerrequired
Example: 1
placestringrequired
Example: Prague
countrystringrequired

Two-letter country code.

Example: CZ
versionintegerrequired

Location version. Values of 3 or greater support snapshots.

Example: 3
package objectrequired

A plan's resources, location, and prices.

namestringrequired
Example: VPS-2
idintegerrequired
Example: 4
locationintegerrequired

The location id this plan belongs to.

Example: 1
coresintegerrequired

Number of virtual CPU cores.

Example: 2
ramintegerrequired

Memory in MB.

Example: 2048
diskintegerrequired

Disk in GB.

Example: 40
bandwidthintegerrequired

Included monthly data transfer in GB.

Example: 2000
pricenumber<float>required

Hourly instance price in EUR.

Example: 0.012
price_monthlynumber<float>required

Monthly cap for instance plan charges in EUR.

Example: 8
os objectrequired

An operating system image's ID and display name.

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

Month-to-date plan charge in EUR, capped at the monthly plan price. Excludes bandwidth overage, services, and snapshots. May be zero while provisioning or if the cost is unavailable.

Example: 1.44
InstanceDetail
{
  "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": {
    "name": "VPS-2",
    "id": 4,
    "location": 1,
    "cores": 2,
    "ram": 2048,
    "disk": 40,
    "bandwidth": 2000,
    "price": 0.012,
    "price_monthly": 8
  },
  "os": {
    "id": 7,
    "name": "Debian 12"
  },
  "cost": 1.44
}