hosting
PUT /v1/sites/{siteId}/repo/sync
Turn two-way sync on or off for a site.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão hosting.deploy.manage; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/repo/sync \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "enabled": <boolean> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
Free, and refused with 422 unless the customer has connected their own GitHub account. Turning it on does not push anything by itself — the first run is either the scheduled sweep or an explicit run. Requires `hosting.deploy.manage`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
enabled | boolean | Sim | — |
subdir | string | Não | Restrict the sync to one directory of the site. Empty syncs the whole document root, which for a WordPress site is usually not what the customer wants. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
site_id | string | Sim | — |
enabled | boolean | Sim | Whether the customer has switched two-way sync on. |
available | boolean | Sim | Whether 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_reason | string | Não | A sentence the customer reads when `available` is false. Null when it is available. |
subdir | string | Não | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error> | Sim | `conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side. |
branch | string | Não | — |
repository | string | Não | `owner/repo`, or null when no repository is connected. |
conflict_commit | string | Não | The commit in the repository that we have not seen — the one the customer needs to look at before choosing. Null unless held. |
last_sync_at | string | Não | — |
last_sync_note | string | Não | — |
runs | SiteRepoSyncRun[] | Sim | The most recent runs, newest first. Includes the no-ops. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429