hosting

PUT `/v1/sites/{siteId}/repo/sync`

Turn two-way sync on or off for a site.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea hosting.deploy.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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> }'

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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`.

Parametri

Nume	Tip	Obligatoriu	Ce este
`siteId (path)`	`Uuid`	Da	Site ID (UUIDv7).

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`enabled`	`boolean`	Da	—
`subdir`	`string`	Nu	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.

Răspuns

Nume	Tip	Obligatoriu	Ce este
`site_id`	`string`	Da	—
`enabled`	`boolean`	Da	Whether the customer has switched two-way sync on.
`available`	`boolean`	Da	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`	Nu	A sentence the customer reads when `available` is false. Null when it is available.
`subdir`	`string`	Nu	Which directory of the site syncs. Empty means the whole document root.
`state`	`string<idle, synced, conflict, adopt, error>`	Da	`conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side.
`branch`	`string`	Nu	—
`repository`	`string`	Nu	`owner/repo`, or null when no repository is connected.
`conflict_commit`	`string`	Nu	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`	Nu	—
`last_sync_note`	`string`	Nu	—
`runs`	`SiteRepoSyncRun[]`	Da	The most recent runs, newest first. Includes the no-ops.

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422 · 429

PUT /v1/sites/{siteId}/repo/sync