DeluxHostAPI Reference
Services & monitoring

List server tasks

GET
/v1/services/{id}/tasks

What the panel has done to this server, newest first: the way to find out whether the action POST /v1/services/{id}/power accepted actually finished. Match the taskId that call returned against id here, and read status.

A task is running until the panel finishes it, then completed or failed. Why a task failed is not published — the upstream message is not ours to hand out. Staff-side rows (an operator suspending the service) are not in this feed.

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.

Query Parameters

limit?integer
Range1 <= value <= 100
Default20

Response Body

The most recent tasks.

application/json
  1. response
items*array<>
curl -X GET 'https://api.deluxhost.net/v1/services/0/tasks' \  -H "Authorization: Bearer $DELUXHOST_TOKEN"
Example Response
{  "items": [    {      "id": 0,      "action": "string",      "status": "running",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Get service metrics GET

What the server has been doing, from samples taken about every ten minutes. `/usage` answers the same question about *right now* with a live call to the panel; this one never leaves our process, which is why it can be polled and `/usage` cannot. `rxDeltaBytes` and `txDeltaBytes` are traffic **in that interval**, not since the beginning: the panel's counters are cumulative and reset monthly. They are null on the first point, which has no previous sample to subtract. An empty `points` is a normal answer — a service provisioned ten minutes ago has no samples, and one that is not a VirtFusion server never will.

Get server details GET