hosting
GET /v1/sites/{siteId}/deletion
Get a site's scheduled deletion.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen sites.view; një çelës pa të refuzohet me 403, jo 404.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deletion \
-H "Authorization: Bearer zdk_live_…"Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
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.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
siteId (path) | Uuid | Po | Site ID (UUIDv7). |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
site_id | string | Po | The site this deletion state belongs to. |
primary_domain | string | Po | ⛔ 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 si… |
state | string<none, scheduled, running, stalled, deleted> | Po | 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` th… |
deletable | boolean | Po | 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 | Po | When the teardown fires, or null when nothing is scheduled. |
requested_at | string | Po | When the deletion was requested, or null when nothing is scheduled. |
grace_days | integer | Po | 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> | Po | 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 | Po | ⛔ **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 cl… |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 429 · 503