compute

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

Retire a server at the provider.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/cancel \
  -H "Authorization: Bearer zdk_live_…"

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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

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