hosting

POST /v1/sites/{siteId}/repo/sync/run

Sync this site with its repository now.

所有 hosting 端点

身份验证

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

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

免费试用

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

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/repo/sync/run \
  -H "Authorization: Bearer zdk_live_…"

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

详细信息

Commits whatever has changed in the site's files and pushes it to the connected branch. A 200 whose `state` is `conflict` or `adopt` is a successful call reporting a HELD sync — the repository moved since we last agreed with it, so nothing was pushed and nothing was overwritten on either side. Never force-pushes and never merges. Requires `hosting.deploy.manage`.

参数

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

响应

名称类型必填内容简介
site_idstring
enabledbooleanWhether the customer has switched two-way sync on.
availablebooleanWhether it is permitted at all — true only once the customer has connected their OWN git account. False here makes `enabled` irrelevant; the engine will not sync either way.
unavailable_reasonstringA sentence the customer reads when `available` is false. Null when it is available.
subdirstringWhich directory of the site syncs. Empty means the whole document root.
statestring<idle, synced, conflict, adopt, error>`conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side.
branchstring
repositorystring`owner/repo`, or null when no repository is connected.
conflict_commitstringThe commit in the repository that we have not seen — the one the customer needs to look at before choosing. Null unless held.
last_sync_atstring
last_sync_notestring
runsSiteRepoSyncRun[]The most recent runs, newest first. Includes the no-ops.

此端点可能返回的错误

401 · 403 · 404 · 422 · 429