hosting

DELETE /v1/sites/{siteId}/deletion

Stop a site's scheduled deletion.

Усі кінцеві точки hosting

Уся документація для розробників

Автентифікація

Надішліть ключ 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_idstringТакThe site this deletion state belongs to.
primary_domainstringТак⛔ 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…
statestring<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…
deletablebooleanТак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_forstringТакWhen the teardown fires, or null when nothing is scheduled.
requested_atstringТакWhen the deletion was requested, or null when nothing is scheduled.
grace_daysintegerТак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_reasonstring<, 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_cancelbooleanТак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