hosting
GET /v1/sites/{siteId}/deletion
Get a site's scheduled deletion.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar sites.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deletion \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
Whether anything is scheduled for this site, when it fires, and whether it can still be stopped. This is also where the client reads primary_domain — the value the customer must type into deleteSite — so the instruction on screen and the check on the server come from one place and cannot drift apart. ⛔ can_cancel is its own field and must never be recomputed as state == "scheduled". Once the teardown starts, the request row still says scheduled while the site is already being deleted; a client doing its own arithmetic would offer the cancel button at the exact moment it can only fail. Requires sites.view only — a read-only member learning that their site is about to be deleted is the whole point, and hiding the countdown from them would mean the first they hear of it is the site being gone. 404 for a site with no vendor hosting package, or one that is not theirs.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
siteId (path) | Uuid | Evet | Site ID (UUIDv7). |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
site_id | string | Evet | The site this deletion state belongs to. |
primary_domain | string | Evet | ⛔ What the customer must type into deleteSite, and what the engine compares against. Read it from here rather than from a Site object already on screen: one value on both… |
state | string<none, scheduled, running, stalled, deleted> | Evet | Where the site is in its lifecycle. A stable machine value the client turns into a localised sentence — never English composed by the engine (§2.19). ⛔ stalled is running that… |
deletable | boolean | Evet | Whether a deletion could be requested right now. False on a site whose state does not allow it, so the form is explained rather than offered and refused. |
scheduled_for | string | Evet | When the teardown fires, or null when nothing is scheduled. |
requested_at | string | Evet | When the deletion was requested, or null when nothing is scheduled. |
grace_days | integer | Evet | How many days the countdown runs. Clamped at both ends — a floor of one day is what stops a misconfiguration meaning delete now. |
grace_free_reason | string<, internal, never_provisioned> | Evet | Why this site would skip the grace period entirely, or "" when it would not. never_provisioned means the site is failed — provisioning never completed, so nothing was ever… |
can_cancel | boolean | Evet | ⛔ Its own field, and never recomputed as state == "scheduled". Once the teardown starts, the request row still says scheduled while the site is already being deleted; a… |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 429 · 503