hosting
PUT /v1/sites/{siteId}/repo/sync
Turn two-way sync on or off for a site.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen hosting.deploy.manage; një çelës pa të refuzohet me 403, jo 404.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
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> }'Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
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`.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
siteId (path) | Uuid | Po | Site ID (UUIDv7). |
Trupi i kërkesës
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
enabled | boolean | Po | — |
subdir | string | Jo | 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. |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
site_id | string | Po | — |
enabled | boolean | Po | Whether the customer has switched two-way sync on. |
available | boolean | Po | 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 | Jo | A sentence the customer reads when `available` is false. Null when it is available. |
subdir | string | Jo | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error> | Po | `conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side. |
branch | string | Jo | — |
repository | string | Jo | `owner/repo`, or null when no repository is connected. |
conflict_commit | string | Jo | 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 | Jo | — |
last_sync_note | string | Jo | — |
runs | SiteRepoSyncRun[] | Po | The most recent runs, newest first. Includes the no-ops. |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 422 · 429