hosting
PUT /v1/sites/{siteId}/repo/sync
Turn two-way sync on or off for a site.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie hosting.deploy.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
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> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
enabled | boolean | Ja | — |
subdir | string | Nee | 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. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
site_id | string | Ja | — |
enabled | boolean | Ja | Whether the customer has switched two-way sync on. |
available | boolean | Ja | 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 | Nee | A sentence the customer reads when `available` is false. Null when it is available. |
subdir | string | Nee | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error> | Ja | `conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side. |
branch | string | Nee | — |
repository | string | Nee | `owner/repo`, or null when no repository is connected. |
conflict_commit | string | Nee | 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 | Nee | — |
last_sync_note | string | Nee | — |
runs | SiteRepoSyncRun[] | Ja | The most recent runs, newest first. Includes the no-ops. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429