Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
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> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
serverId (path) | Uuid | Ja | 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. |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
term_months | integer | Ja | Months to add to the existing term. Outside 1…36 is refused `422` before the provider is called. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | **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 | Ja | 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 | Ja | Which compute range the machine belongs to. |
plan_code | string | Ja | The tier it was bought on, or `""` when it was ordered by size alone. |
provider | string | Ja | Our provider id. |
spec | string | Ja | The machine size it currently runs. |
zone | string | Ja | The data centre it runs in. |
status | string<pending, provisioning, active, failed, suspended, terminated> | Ja | 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 | Ja | Why the order failed, in a sentence the customer reads. Blank unless `failed`. |
vendor_status | string | Ja | 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> | Ja | 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[] | Ja | 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 | Ja | The stack optimisation profile it was built with, or `""` for none. |
term_months | integer | Ja | The term it was bought on, or null when the provider states none. |
renews_at | string | Ja | ⛔ **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 | Ja | When the row was created, or `""` when not stated. |
operable | boolean | Ja | 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 | Ja | The provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice. |
suspended | boolean | Ja | ⛔⛔ **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 | Ja | Why, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing. |
capabilities | string[] | Ja | ⭐⭐ **What this machine's provider can actually do** — capability tokens such as `compute:snapshots`, `compute:console`, `compute:firewall`, `compute:backups_manage` and `compute… |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422 · 429 · 503