compute
POST /v1/compute/servers/{serverId}/cancel
Retire a server at the provider.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso sites.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/cancel \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
**A scheduled retirement, not an immediate deletion, and a client MUST say so.** The machine keeps running until the term already paid for runs out; the provider then powers it down 24 hours later and deletes it after a further six days. The response carries `renews_at`, which is the date that countdown starts from - a "Cancel" button that silently means "in 31 days" is worse than no button at all. The row is deliberately **not** marked terminated: it is still a working machine the customer is entitled to use, and marking it otherwise would strip every control off a server they are still paying for. Requires `sites.view` **and** `sites.delete` - ending a machine is a different order of trust from paying for one.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
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. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
contract_id | string | Sí | The provider's contract identifier. |
auto_renew | boolean | Sí | Whether **Zinn®** will charge for this machine again — `Subscription.auto_renew` for the subscription that pays for it, reached through the paid order line. It is **not** the pr… |
subscription_id | string | Sí | The subscription whose switch `auto_renew` reports, to send the customer to `POST /v1/subscriptions/{subscriptionId}/auto-renew`. `""` when the machine was provisioned outside a… |
renews_at | string | Sí | **The provider's date** - when the machine lapses at them, as they state it, or `""` when they state none. Blank means "not stated" - never "never". It is what the "runs until X… |
charge_at | string | Sí | **Zinn®'s date** - when the customer's card is charged next, ISO-8601, or `""` when the machine has no Zinn® subscription. This is `Subscription.current_period_end`: the rebill… |
price_amount_minor | object | Sí | What the customer will be charged at `charge_at`, in **integer minor units** of `price_currency`, taken from the subscription's captured price (a live subscriber keeps the price… |
price_currency | string | Sí | The ISO-4217 code `price_amount_minor` is denominated in, or `""` when there is no subscription. Never rendered apart from the amount, and the amount never without it. |
period | string | Sí | The renewal cadence as the provider spells it, or `""`. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429 · 503