hosting

POST `/v1/sites/{siteId}/previews`

Build a branch as a preview, without touching the live site.

身份验证

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

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

免费试用

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

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

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

详细信息

A preview NEVER binds the site's hostname: it is reachable at the provider's own per-deployment URL and nowhere else, which is the whole promise of a preview. Previewing the branch the site already serves is refused rather than quietly promoted to a production deploy. Requires `hosting.deploy.manage`.

参数

名称	类型	必填	内容简介
`siteId (path)`	`Uuid`	是	Site ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`branch`	`string`	是	The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy.

响应

名称	类型	必填	内容简介
`id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`site_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`target`	`DeployTarget`	是	Where the site is published from. `fleet` is our own managed fleet; the rest are managed edge hosts, deployed to from a pooled account of ours or the customer's own connected on…
`status`	`DeployStatus`	是	`idle` means the site has never been deployed. It is reported, never stored — a stored idle would be a second way to say "no deployments" that could contradict the first.
`trigger`	`DeployTrigger`	是	What caused the deploy. Stored because `requested_by` cannot answer it for a push — the actor there is a webhook delivery, not a person.
`repo`	`object`	是	—
`branch`	`object`	是	—
`commit`	`object`	是	—
`commit_message`	`object`	是	—
`live_url`	`object`	是	—
`message`	`object`	是	Why it failed, else null. Rendered to the customer verbatim.
`requested_by`	`string`	是	—
`created_at`	`string`	是	—
`started_at`	`object`	是	—
`finished_at`	`object`	是	—
`log`	`string`	是	The build log, one timestamped line per step. Truncated from the FRONT when long — the end of a build log is where the failure is.

此端点可能返回的错误

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

POST /v1/sites/{siteId}/previews