hosting

POST `/v1/sites/{siteId}/site-blueprint-deploy`

Replace a site's content with a blueprint's.

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

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

免费试用

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

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/site-blueprint-deploy \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "blueprint_id": <Uuid> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

⛔ **Destructive.** This overwrites the site's live database and files with the contents of the named blueprint, then rewrites the restored content's stored web addresses to this site's domain (a WordPress database names its own URLs, so without that step the new site would redirect its visitors to the old one). Its own path on the **site**, beside `backups/restore`, rather than a verb on the blueprint — the destruction happens here, so it is gated on `hosting.backup.manage` and cannot be reached by varying the body of anything gentler. ⛔ A blueprint captured from a different **stack** is refused with a `422` (`stack_mismatch`) — WordPress can only be deployed onto WordPress. So is one from a different **hosting platform** (`platform_mismatch`), whose archive our adapter cannot restore here. A blueprint belonging to a **different account** is refused with `org_mismatch`, even when your token can reach both: hierarchical tenancy means a reseller's key spans every client organisation, and a blueprint is that site's whole database — it never crosses between accounts. A blueprint that is still being captured is `blueprint_not_ready`. A deploy already in flight on this site is a `409`. The refusal is a **machine code**, carried in `error.details[0].code`, so a client can render it in the customer's own language; `error.message` is the English equivalent for a caller with no catalogue. ⛔ Read the code from `details`, not from `error.code` — that is the generic `UNPROCESSABLE_ENTITY` for every 422 this API produces.

参数

名称	类型	必填	内容简介
`siteId (path)`	`Uuid`	是	Site ID (UUIDv7).
`Idempotency-Key (header)`	`string`	否	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

请求正文

名称	类型	必填	内容简介
`blueprint_id`	`Uuid`	是	The SITE blueprint to deploy. ⛔ Always named explicitly — never "the latest". This overwrites a live site.

响应

名称	类型	必填	内容简介
`id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`blueprint_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`site_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`SiteBlueprintDeployStatus`	是	⭐ `waiting` is a real state and not a synonym for `pending`. A deploy started from the create form cannot restore anything until the new site has finished provisioning, which ta…
`message`	`string`	否	Why it failed, or — after a successful restore whose URL rewrite did not take — what still needs attention. Rendered to the customer verbatim.
`started_at`	`object`	否	—
`finished_at`	`object`	否	—
`created_at`	`string`	是	—

此端点可能返回的错误

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

POST /v1/sites/{siteId}/site-blueprint-deploy