hosting

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

What a site's running domain change is waiting for.

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.view 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 GET 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

Reads the site's rename saga. waiting_for is the new domain the saga is waiting to see pointed at the site (null when no change is waiting — none running, or one past its DNS wait), and dns_record is the record to add at the customer's DNS provider (null when nothing is waiting). The saga switches on its own as soon as the name reaches the site; nothing needs pressing again. waiting_for_certificate is the new domain while the saga secures its certificate: the site goes on serving its current address, with its current certificate, until the box presents one covering the new name, and only then switches. Requires sites.view.

Parameters

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

Response

NameTypeRequiredWhat it is
site_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
waiting_forHostname | nullYesThe domain the change is waiting for, or null.
waiting_for_certificateHostname | nullYesThe domain whose certificate the change is securing before it switches, or null. The site still answers on its current domain while this is set. Only ever set when the domain…
domain_stateDomainAttachState | nullNoThe live state of the domain the change is attaching (waiting_for or waiting_for_certificate), read from public DNS (cached 60 s); null when no change is in progress.…
dns_recordRenameDnsRecord | nullYes—
pointed_by_usbooleanNoTrue when the platform writes dns_record itself once the domain's delegation is live: the domain is registered with us, we hold its DNS zone, its DNS is not managed externally,…
failedSiteRenameFailure | nullYesSet when the site's latest domain change ended without moving the site (its primary domain is still the current one; the saga's undo is best effort); null otherwise. reason is a…

Errors this endpoint can return

401 · 403 · 404 · 429 · 503