hosting

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

Change a site's primary domain (asynchronous).

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.create; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`siteId (path)`	`Uuid`	Sim	Site ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`new_domain`	`Hostname`	Sim	The site's new primary domain (FQDN).
`keep_old_as_alias`	`boolean`	Não	Keep serving the old domain as an alias of the site after the flip.

Resposta

Nome	Tipo	Obrigatório	O que é
`site_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`new_domain`	`Hostname`	Sim	A fully-qualified DNS hostname, lowercase, no trailing dot.
`workflow_id`	`string`	Sim	The Temporal workflow id running the rename saga (deterministic per site).
`status`	`string<accepted>`	Sim	The saga was accepted; poll the site / `site.*` events for completion.

Erros que este endpoint pode retornar

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

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