compute
GET /v1/compute/servers/{serverId}/metrics
How hard a server has worked over a window — CPU, network and disk rates.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/metrics \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Read live from the provider and stored nowhere. window is one of 1h, 24h, 7d or 30d (default 24h); anything else is a 422 naming the four, never widened to the nearest. ⛔ A sample the provider did not have is null — a gap in the line, never zero. ⛔ A quantity this range does not measure is ABSENT from series, which is a different state from a series with no points. 503 on a range with no metrics history (see the compute:metrics_history capability). Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
serverId (path) | Uuid | Yes | The server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
window (query) | string<1h, 24h, 7d, 30d> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
window | string<1h, 24h, 7d, 30d> | Yes | — |
step_seconds | integer | Yes | The spacing between samples, as the provider answered it. |
series | object[] | Yes | ⛔ A quantity this range does not measure is absent, not empty. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503