compute

POST `/v1/compute/servers/{serverId}/renew`

Extend a server's term.

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/renew \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "term_months": <integer> }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Buys more months on an existing machine and returns the server with term_months grown by what was asked. ⛔ This charges immediately, and — unlike a resize — there is deliberately no quote operation to read first. That asymmetry is real rather than an omission: a resize is priced by the provider, whereas a renewal is priced by the plan the customer is already on, and no figure on this surface carries it (a machine size has no price by design, and a server carries only a plan_code). A client says out loud that it cannot show a figure rather than inventing one (§2.8). The engine attaches an idempotency key derived from the server and the term, so a retry cannot buy the extension twice. 404 for a server that is not the caller's; 422 for a term outside 1…36 months, or a machine that is not active. Requires sites.view and billing.payment.manage — ⛔ not sites.create, which is what this was until #1682.

Параметры

Имя	Тип	Обязательно	Что это
`serverId (path)`	`Uuid`	Да	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.

Тело запроса

Имя	Тип	Обязательно	Что это
`term_months`	`integer`	Да	Months to add to the existing term. Outside 1…36 is refused `422` before the provider is called.

Ответ

Имя	Тип	Обязательно	Что это
`id`	`Uuid`	Да	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`	Да	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`	Да	Which compute range the machine belongs to.
`plan_code`	`string`	Да	The tier it was bought on, or `""` when it was ordered by size alone.
`provider`	`string`	Да	Our provider id.
`spec`	`string`	Да	The machine size it currently runs.
`zone`	`string`	Да	The data centre it runs in.
`status`	`string<pending, provisioning, active, failed, suspended, terminated, resizing, terminating>`	Да	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 the…
`message`	`string`	Да	Why the order failed, in a sentence the customer reads. Blank unless `failed`.
`vendor_status`	`string`	Да	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>`	Да	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[]`	Да	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`	Да	The stack optimisation profile it was built with, or `""` for none.
`term_months`	`integer`	Да	The term it was bought on, or null when the provider states none.
`renews_at`	`string`	Да	⛔ 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's…
`created_at`	`string`	Да	When the row was created, or `""` when not stated.
`operable`	`boolean`	Да	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`	Да	The provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice.
`suspended`	`boolean`	Да	⛔⛔ 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 and…
`suspension_reason`	`string`	Да	Why, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing.
`capabilities`	`string[]`	Да	⭐⭐ What this machine's provider can actually do — capability tokens such as `compute:snapshots`, `compute:console`, `compute:firewall`, `compute:backups_manage` and…
`billing`	`ComputeServerBilling`	Да	How a machine is paid for (W43-47, `docs/687`). `term` machines are charged ahead by a per-machine subscription. `metered` machines are charged per started hour from the account…
`login_user`	`string`	Да	The account to sign in as (W43-49, `docs/689`). `admin` — key-only, passwordless `sudo`, root login refused — on a Zinn® Cloud machine built under the access model; `root` on one…
`blueprint`	`string<, docker, k3s, k3s_argocd>`	Да	The software stack installed at first boot. Blank for none.
`cluster_id`	`string`	Да	The cluster this machine is a node of, or blank.
`cluster_role`	`string<, server, agent>`	Да	—

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422 · 429 · 503

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