hosting
DELETE /v1/sites/{siteId}/deletion
Stop a site's scheduled deletion.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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… |
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 · 409 · 422 · 429 · 503