Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.restart; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/name \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
Set the machine's display name. The provider is changed first and our own record only if it agreed, so a customer is never shown a name their provider has never heard of. Names are limited to 37 characters because that is what the provider enforces. A name the provider refuses - too long, or already used on the account - returns 422 and changes nothing. Requires `sites.restart`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
serverId (path) | Uuid | Sì | 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. |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
name | string | Sì | The machine's new display name. 37 characters is the provider's own limit, mirrored here so the refusal comes from this form rather than from the supplier. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | Uuid | Sì | **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 | Sì | 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 | Sì | Which compute range the machine belongs to. |
plan_code | string | Sì | The tier it was bought on, or `""` when it was ordered by size alone. |
provider | string | Sì | Our provider id. |
spec | string | Sì | The machine size it currently runs. |
zone | string | Sì | The data centre it runs in. |
status | string<pending, provisioning, active, failed, suspended, terminated> | Sì | 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 | Sì | Why the order failed, in a sentence the customer reads. Blank unless `failed`. |
vendor_status | string | Sì | 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> | Sì | 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[] | Sì | 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 | Sì | The stack optimisation profile it was built with, or `""` for none. |
term_months | integer | Sì | The term it was bought on, or null when the provider states none. |
renews_at | string | Sì | ⛔ **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 | Sì | When the row was created, or `""` when not stated. |
operable | boolean | Sì | 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 | Sì | The provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice. |
suspended | boolean | Sì | ⛔⛔ **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 | Sì | Why, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing. |
capabilities | string[] | Sì | ⭐⭐ **What this machine's provider can actually do** — capability tokens such as `compute:snapshots`, `compute:console`, `compute:firewall`, `compute:backups_manage` and `compute… |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422 · 429 · 503