DeluxHostAPI Reference
Services & monitoring

Get service details

GET
/v1/services/{id}

Authorization

apiToken services:read
headerAuthorizationBearer <token>

A personal API token: Authorization: Bearer dh_live_…. See Authentication for scopes.

Scope: services:read

Path Parameters

id*integer

The service id, as returned by GET /v1/services.

Response Body

The service.

application/json
  1. response
id*integer

What every other service endpoint takes.

orderNumber*|

The 10-digit public order number, as printed on invoices.

name*string

Your own label, or the product name.

productSlug*string|null
productName*string|null
status*string

active | pending | suspended | cancelled | terminated

cycle*string

monthly | annually | … as sold.

priceCents*integer
nextDueAt*|
Formatdate-time
createdAt*string
Formatdate-time
platform*|

Which panel backs the service, or null when none does. VirtFusion and TenantOS accept power controls. TenantOS graceful shutdown is unavailable; use explicit poweroff.

provisioned*boolean

Whether a machine has actually been created for it yet.

curl -X GET 'https://api.deluxhost.net/v1/services/0' \  -H "Authorization: Bearer $DELUXHOST_TOKEN"
Example Response
{  "id": 0,  "orderNumber": 0,  "name": "string",  "productSlug": "string",  "productName": "string",  "status": "string",  "cycle": "string",  "priceCents": 0,  "nextDueAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "platform": "string",  "provisioned": true}

List services GET

Newest first, and not paginated: this is a list of things somebody pays for monthly, so it is small by nature. The invoice list, which grows forever, is paginated.

Get server status GET

Read from the panel on every call, so it is slower than the service itself and can fail on its own. `powerState` is `running`, `stopped` or `unknown` — the last means we could not read it (usually an unreachable hypervisor), not that the server is off. Answers for **VirtFusion and TenantOS services alike**: same question, same shape, different source. `building` is only ever true on VirtFusion; `cpuModel` is only ever set on TenantOS. Shared hosting is not a machine and lives at `/v1/services/{id}/hosting`. A suspended service answers 400 here while still appearing in `GET /v1/services`.