For the complete documentation index, see llms.txt. This page is also available as Markdown.

Server Inventory

Informative inventory endpoints

Get inventory availability numbers for all instance types in all locations

get

Get inventory availability numbers for all instance types in all locations

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Responses
200

Successful operation

application/json
get/api/inventory/availability
GET /api/inventory/availability HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*
{
  "items": [
    {
      "locationId": 18,
      "locationName": "EU: Rotterdam",
      "instanceTypeId": 117,
      "instanceTypeName": "bm1-std-4",
      "available": 20,
      "allocated": 10,
      "allocatedLegacy": 10,
      "committedUnderContract": 30,
      "allocatedUnderContract": 19,
      "isolated": 2,
      "baseline": 4
    }
  ]
}

Get isolated (problematic) servers

get

Get all isolated servers, except "legacy rented"

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Responses
200

Successful operation

application/json
get/api/inventory/isolated
GET /api/inventory/isolated HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*
{
  "items": [
    {
      "serverId": 79186,
      "serial": "HYX3XD2",
      "name": "Server 12653",
      "hostname": "host.example.com",
      "locationId": 18,
      "instanceTypeId": 126,
      "state": "isolated",
      "subState": "brokenHardware",
      "operationUuid": "0194bc95-e1a4-73a0-81be-ae17c3a7e92b",
      "isolationReason": "Server encountered error in PXE ...",
      "isolationDate": "2018-03-20T09:12:28.000Z"
    }
  ]
}

Last updated

Was this helpful?