compute
GET /v1/compute/servers/{serverId}
Get one server, with the provider's live state merged in.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
One machine, refreshed against the provider. The refresh is best-effort and never fails the screen: the row is what we know, the merge is an improvement on it, and a `503` on a detail page would hide a server the customer owns. `power_state` has six values rather than two, and the four extra ones are the whole point — a machine mid-transition is not "on". A `stopping` server rendered as running with an enabled Stop button is a customer pressing Stop twice and filing a ticket, and an unread state rendered as "off" is worse: it invites a Start on a machine that is already running. `unknown` is the honest answer when the provider stated none and is never collapsed into `off`. A client polls on the three transitional values and on `status: provisioning`. `404` for a server that is not the caller's or does not exist — the tenancy boundary of this surface is our own rows, and out-of-scope and nonexistent give the same answer on purpose. Requires `sites.view`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
serverId (path) | Uuid | Sim | 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. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | **Ours**, and also the provisioning workflow's id and the machine's name at the provider — which is what makes the whole purchase path idempotent. |
name | string | Sim | What the customer called it. ⛔ At the provider a machine's name is its row id; confusing the two is a cross-tenant defect, so this is the customer's string and nothing else. |
deploy_target | string | Sim | Which compute range the machine belongs to. |
plan_code | string | Sim | The tier it was bought on, or `""` when it was ordered by size alone. |
provider | string | Sim | Our provider id. |
spec | string | Sim | The machine size it currently runs. |
zone | string | Sim | The data centre it runs in. |
status | string<pending, provisioning, active, failed, suspended, terminated> | Sim | How far the order got — **ours**, and a different fact from `power_state`. `pending` is a row with nothing bought and nothing charged; `failed` is the state whose `message` is t… |
message | string | Sim | Why the order failed, in a sentence the customer reads. Blank unless `failed`. |
vendor_status | string | Sim | The provider's own word, verbatim and unrounded. Staff-facing detail; a customer client renders `status` and never this. |
power_state | string<unknown, on, off, starting, stopping, rebooting> | Sim | What the machine is doing right now. ⛔ **Six values, not two, and the four extra ones are the point: a machine mid-transition is not "on".** `unknown` is the honest answer when… |
addresses | string[] | Sim | Public addresses **if the provider states them**. Empty means *not stated*, never "none" — a machine rendered as having no address reads as broken. |
optimisation | string | Sim | The stack optimisation profile it was built with, or `""` for none. |
term_months | integer | Sim | The term it was bought on, or null when the provider states none. |
renews_at | string | Sim | ⛔ **Always null today, and honestly so**: the provider publishes no renewal date, and one computed from the order plus the term would be our arithmetic rendered as the provider'… |
created_at | string | Sim | When the row was created, or `""` when not stated. |
operable | boolean | Sim | Whether the customer may act on this machine — power, resize, renew, rebuild. ⛔ Read rather than re-derived from `status`: the engine refuses every one of those on anything but… |
image | string | Sim | The provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice. |
suspended | boolean | Sim | ⛔⛔ **Whether WE stopped it, which is not the same fact as `power_state`.** A stopped machine is the customer's own choice and they may start it again; a suspended one is ours an… |
suspension_reason | string | Sim | Why, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing. |
capabilities | string[] | Sim | ⭐⭐ **What this machine's provider can actually do** — capability tokens such as `compute:snapshots`, `compute:console`, `compute:firewall`, `compute:backups_manage` and `compute… |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429 · 503