hosting

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

Change a site's primary domain (asynchronous).

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.create; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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.

Параметри

Име	Тип	Задължително	Какво представлява
`siteId (path)`	`Uuid`	Да	Site ID (UUIDv7).

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`new_domain`	`Hostname`	Да	The site's new primary domain (FQDN).
`keep_old_as_alias`	`boolean`	Не	Keep serving the old domain as an alias of the site after the flip.

Отговор

Име	Тип	Задължително	Какво представлява
`site_id`	`Uuid`	Да	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`new_domain`	`Hostname`	Да	A fully-qualified DNS hostname, lowercase, no trailing dot.
`workflow_id`	`string`	Да	The Temporal workflow id running the rename saga (deterministic per site).
`status`	`string<accepted>`	Да	The saga was accepted; poll the site / `site.*` events for completion.

Грешки, които този крайpoint може да върне

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

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