احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/deletion \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Cancels the countdown and returns the site's deletion state, which will read `none`. Takes no body. ⛔ **`DELETE` on the *deletion*, not `POST …/cancel`.** The resource being removed is the scheduled request, and giving the undo its own noun means no request body can ever turn a cancel into a delete by being slightly wrong. The teardown is stopped **before** the row is marked cancelled, never the other way round: a failed stop leaves a still-scheduled row the customer can retry, while the reverse leaves a row saying "cancelled" above a workflow that deletes their site. `422` when nothing is scheduled or the teardown has already started; `503` when the stop could not be performed, in which case the deletion is still scheduled and the request is safe to repeat. `404` for a site with no vendor hosting package, or one that is not theirs. Requires `sites.view` **and** `sites.delete`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 si… |
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` th… |
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 cl… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 409 · 422 · 429 · 503