hosting

DELETE /v1/sites/{siteId}/rename-domain

Cancel a domain change that is still waiting.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the sites.create permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/rename-domain \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Cancels the site's rename saga while it is still WAITING — for the new name to be pointed at the site (waiting_for) or for its certificate (waiting_for_certificate). The saga undoes the zones it prepared for the new name and ends; the site stays on its current address, which never stopped working. Returns 202 Accepted with status: cancelling — the undo runs in the saga, so read getSiteRenameStatus until nothing is waiting. 409 with refusal.rename.nothingToCancel when no change is waiting (none running, or one already past its wait and finishing — it cannot be stopped half-way). Writes the site.domain.rename_cancelled audit row. Requires sites.create (the same authority that starts a change).

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
site_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
domainHostnameYesA fully-qualified DNS hostname, lowercase, no trailing dot.
statusstring<cancelling>Yescancelling — the waiting change is undoing the new name's zones and will end; the site stays on its current address.

Errors this endpoint can return

401 · 403 · 404 · 409 · 429 · 503