compute
POST /v1/compute/servers/{serverId}/power
Start, stop or reboot a server.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na sites.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/power \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "action": <string<start, stop, reboot>> }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
Asks the provider to change the machine's power state and returns the server's whole new state, which the client writes straight into its cache. ⛔ **The answer carries the transitional state, never the destination.** Power at the provider is asynchronous — the request is accepted long before the machine is up — so writing `on` the instant Start is accepted would be a dashboard asserting an observation it never made. The engine answers `starting`, the detail screen begins polling on that, and nothing in between ever renders the old state as if the button had done nothing. `404` for a server that is not the caller's; `422` for a machine that is not `active`. Requires `sites.view` **and** `sites.restart`, which is already the "make this thing stop and start again" authority.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
serverId (path) | Uuid | Oo | 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. |
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
action | string<start, stop, reboot> | Oo | Vendor-neutral by design — no provider's verb. The response carries the **transitional** power state, never the destination. |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | Uuid | Oo | **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 | Oo | 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 | Oo | Which compute range the machine belongs to. |
plan_code | string | Oo | The tier it was bought on, or `""` when it was ordered by size alone. |
provider | string | Oo | Our provider id. |
spec | string | Oo | The machine size it currently runs. |
zone | string | Oo | The data centre it runs in. |
status | string<pending, provisioning, active, failed, suspended, terminated> | Oo | 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 | Oo | Why the order failed, in a sentence the customer reads. Blank unless `failed`. |
vendor_status | string | Oo | 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> | Oo | 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[] | Oo | 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 | Oo | The stack optimisation profile it was built with, or `""` for none. |
term_months | integer | Oo | The term it was bought on, or null when the provider states none. |
renews_at | string | Oo | ⛔ **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 | Oo | When the row was created, or `""` when not stated. |
operable | boolean | Oo | 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 | Oo | The provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice. |
suspended | boolean | Oo | ⛔⛔ **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 | Oo | Why, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing. |
capabilities | string[] | Oo | ⭐⭐ **What this machine's provider can actually do** — capability tokens such as `compute:snapshots`, `compute:console`, `compute:firewall`, `compute:backups_manage` and `compute… |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 422 · 429 · 503