hosting

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

Change a site's primary domain (asynchronous).

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.create 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 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.

此端点可能返回的错误

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

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