compute

POST /v1/compute/servers/{serverId}/power

Start, stop or reboot a server.

모든 compute 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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>> }'

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

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.

매개변수

이름유형필수설명
serverId (path)UuidThe 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.

요청 본문

이름유형필수설명
actionstring<start, stop, reboot>Vendor-neutral by design — no provider's verb. The response carries the **transitional** power state, never the destination.

응답

이름유형필수설명
idUuid**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.
namestringWhat 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_targetstringWhich compute range the machine belongs to.
plan_codestringThe tier it was bought on, or `""` when it was ordered by size alone.
providerstringOur provider id.
specstringThe machine size it currently runs.
zonestringThe data centre it runs in.
statusstring<pending, provisioning, active, failed, suspended, terminated>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…
messagestringWhy the order failed, in a sentence the customer reads. Blank unless `failed`.
vendor_statusstringThe provider's own word, verbatim and unrounded. Staff-facing detail; a customer client renders `status` and never this.
power_statestring<unknown, on, off, starting, stopping, rebooting>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…
addressesstring[]Public addresses **if the provider states them**. Empty means *not stated*, never "none" — a machine rendered as having no address reads as broken.
optimisationstringThe stack optimisation profile it was built with, or `""` for none.
term_monthsintegerThe term it was bought on, or null when the provider states none.
renews_atstring⛔ **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_atstringWhen the row was created, or `""` when not stated.
operablebooleanWhether 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…
imagestringThe provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice.
suspendedboolean⛔⛔ **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_reasonstringWhy, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing.
capabilitiesstring[]⭐⭐ **What this machine's provider can actually do** — capability tokens such as `compute:snapshots`, `compute:console`, `compute:firewall`, `compute:backups_manage` and `compute…

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 422 · 429 · 503