DeluxHostAPI Reference
Services & monitoring

Get server status

GET
/v1/services/{id}/server

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.

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

Live state.

application/json
  1. response
powerState*string
Value in"running""stopped""unknown"
hostname*string|null
suspended*boolean
building*boolean

True while the machine is still being built.

ips*array<string>
cpuCores*integer|null
memoryMb*integer|null
storageGb*integer|null
osTemplate*|

The OS as installed.

osRunning*|

What the running system reports.

cpuModel*|

The physical CPU, on platforms that report one. Null on VirtFusion.

curl -X GET 'https://api.deluxhost.net/v1/services/0/server' \  -H "Authorization: Bearer $DELUXHOST_TOKEN"
Example Response
{  "powerState": "running",  "hostname": "string",  "suspended": true,  "building": true,  "ips": [    "string"  ],  "cpuCores": 0,  "memoryMb": 0,  "storageGb": 0,  "osTemplate": "string",  "osRunning": "string",  "cpuModel": "string"}