hosting

GET /v1/sites/{siteId}/deploy

Get a site's deploy target and status.

所有 hosting 端点

身份验证

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

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

免费试用

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

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deploy \
  -H "Authorization: Bearer zdk_live_…"

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

详细信息

A site that has never been deployed reports status `idle` with null details — null means "nothing to show", never zero or an epoch. This is polled while a deploy is in flight, so it is a cheap database read and never calls a build provider. Requires `sites.view`.

参数

名称类型必填内容简介
siteId (path)UuidSite ID (UUIDv7).

响应

名称类型必填内容简介
site_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTarget | nullNull when no target can be derived yet.
statusDeployStatus`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_atobjectWhen the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date.
live_urlobjectThe served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned.
repoobjectSource repository for the Pages targets, else null.
commitobjectThe deployed commit ref, else null.
messageobjectWhy the last deploy failed, else null. Rendered to the customer verbatim.
can_deploybooleanFalse while a deploy is in flight or the site cannot be deployed.

此端点可能返回的错误

401 · 403 · 404 · 429