hosting

POST `/v1/sites/{siteId}/rename-domain`

Change a site's primary domain (asynchronous).

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.create ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/rename-domain \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "new_domain": <Hostname> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

Starts the durable **rename-domain** saga for a site (new-side setup → flip → old-side teardown, register #91). Returns `202 Accepted` immediately — the work runs as a Temporal workflow; poll the site or subscribe to `site.*` events for completion. Requires `sites.create` (the same authority that provisions a site). Idempotent on the site: a repeat call while the saga is running is accepted and does not start a second run.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`siteId (path)`	`Uuid`	Oui	Site ID (UUIDv7).

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`new_domain`	`Hostname`	Oui	The site's new primary domain (FQDN).
`keep_old_as_alias`	`boolean`	Non	Keep serving the old domain as an alias of the site after the flip.

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`site_id`	`Uuid`	Oui	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`new_domain`	`Hostname`	Oui	A fully-qualified DNS hostname, lowercase, no trailing dot.
`workflow_id`	`string`	Oui	The Temporal workflow id running the rename saga (deterministic per site).
`status`	`string<accepted>`	Oui	The saga was accepted; poll the site / `site.*` events for completion.

Erreurs que cet point de terminaison peut renvoyer

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

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