compute
POST /v1/compute/servers/{serverId}/cancel
Retire a server at the provider.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/cancel \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
contract_id | string | 是 | The provider's contract identifier. |
auto_renew | boolean | 是 | 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… |
subscription_id | string | 是 | 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 | 是 | 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 | 是 | 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 | 是 | 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 | 是 | 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 | 是 | The renewal cadence as the provider spells it, or "". |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429 · 503