hosting

DELETE `/v1/sites/{siteId}`

Schedule a site's permanent deletion.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền sites.view; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "confirm_domain": <string> }'

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

Starts the grace period after which the site, its vendor hosting package and everything on them are destroyed. Until this operation existed the driver could delete a package and the teardown workflow was in place, and a customer who wanted their own site gone had to open a ticket. The site is **not** suspended while the countdown runs — it serves normally, so waiting costs nothing. ⛔ **This operation carries a request body on `DELETE`.** RFC 9110 permits it and it is deliberate: the typed confirmation must travel with the request that acts on it, because a "confirm" call followed by an unconfirmed delete is two requests and the second one is the whole vulnerability. `confirm_domain` is compared against `SiteDeletion.primary_domain` — case-insensitively, ignoring surrounding whitespace and a trailing root dot, and never against an alias. `202` and not `200`: nothing has been destroyed yet. The body is the same `SiteDeletion` resource `getSiteDeletion` returns, so the client renders the countdown from the server's answer rather than from what it asked for. A deletion already scheduled is `409`. A confirmation that does not match, an absent `confirm_domain`, or a site whose state does not allow deletion is `422`. `503` means the teardown could not be armed and **nothing was scheduled** — the request is safe to repeat. A site with no vendor hosting package — anything on our own fleet, or a Zinn® VPS — has no such operation and returns `404`, exactly as an out-of-scope or unknown id does. Requires `sites.view` **and** `sites.delete`; the site lookup is scoped on `sites.delete`, so holding it in one organisation does not reach a site in another.

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`siteId (path)`	`Uuid`	Có	Site ID (UUIDv7).

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`confirm_domain`	`string`	Có	The site's primary domain, as the customer typed it. Read the value to prompt for from `SiteDeletion.primary_domain` rather than from a `Site` object already on screen: one valu…

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`site_id`	`string`	Có	The site this deletion state belongs to.
`primary_domain`	`string`	Có	⛔ 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>`	Có	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`	Có	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`	Có	When the teardown fires, or null when nothing is scheduled.
`requested_at`	`string`	Có	When the deletion was requested, or null when nothing is scheduled.
`grace_days`	`integer`	Có	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>`	Có	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`	Có	⛔ 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…

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 409 · 422 · 429 · 503

DELETE /v1/sites/{siteId}