hosting
GET /v1/sites/{siteId}/deletion
Get a site's scheduled deletion.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь sites.view эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.
Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deletion \
-H "Authorization: Bearer zdk_live_…"Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх
Дэлгэрэнгүй
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.
Параметрүүд
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
siteId (path) | Uuid | Тийм | Site ID (UUIDv7). |
Хариу үйлдэл
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
site_id | string | Тийм | The site this deletion state belongs to. |
primary_domain | string | Тийм | ⛔ 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> | Тийм | 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 | Тийм | 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 | Тийм | When the teardown fires, or null when nothing is scheduled. |
requested_at | string | Тийм | When the deletion was requested, or null when nothing is scheduled. |
grace_days | integer | Тийм | 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> | Тийм | 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 | Тийм | ⛔ 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… |
Энэ төгсгөл цэгээс буцааж болох алдаанууд
401 · 403 · 404 · 429 · 503