身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 hosting.deploy.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/deploy \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Starts a durable deploy workflow and returns immediately with the new in-flight state. The target is derived from the site's stack and its connected accounts; there is no target to choose. A site with a deploy already running returns `DEPLOY_IN_PROGRESS`, and one with no usable target returns `DEPLOY_TARGET_UNAVAILABLE`. Requires `hosting.deploy.manage`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
site_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | null | 是 | Null when no target can be derived yet. |
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. |
last_deployed_at | object | 是 | When the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date. |
live_url | object | 是 | The served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned. |
repo | object | 是 | Source repository for the Pages targets, else null. |
commit | object | 是 | The deployed commit ref, else null. |
message | object | 是 | Why the last deploy failed, else null. Rendered to the customer verbatim. |
can_deploy | boolean | 是 | False while a deploy is in flight or the site cannot be deployed. |
此端点可能返回的错误
401 · 403 · 404 · 409 · 422 · 429 · 503