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.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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 \
-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
Every machine the caller can see, or — with ?org_id= — one organisation's. The scoped form is what a reseller's console sends. An organisation outside the readable scope narrows to nothing rather than 403-ing, exactly as listSites does: a 403 would confirm the organisation exists. ⛔ Resolved from our own rows, not from the provider's listing, which is every customer on the reseller account. status is ours (how far the order got) and power_state is the machine's (what it is doing now); they are separate facts and rounding the provider's word into ours would silently make an unrecognised state active, which is what unlocks the power and resize controls. operable is read rather than re-derived from status, so a screen never offers a control the engine refuses. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | Narrow the list to one organisation the caller can read. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | ComputeServer[] | Yes | The machines, across every organisation the caller can read. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503