hosting
PUT /v1/sites/{siteId}/repo/sync
Turn two-way sync on or off for a site.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar hosting.deploy.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
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> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
siteId (path) | Uuid | Evet | Site ID (UUIDv7). |
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
enabled | boolean | Evet | — |
subdir | string | Hayır | 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. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
site_id | string | Evet | — |
enabled | boolean | Evet | Whether the customer has switched two-way sync on. |
available | boolean | Evet | 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 | Hayır | A sentence the customer reads when `available` is false. Null when it is available. |
subdir | string | Hayır | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error> | Evet | `conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side. |
branch | string | Hayır | — |
repository | string | Hayır | `owner/repo`, or null when no repository is connected. |
conflict_commit | string | Hayır | 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 | Hayır | — |
last_sync_note | string | Hayır | — |
runs | SiteRepoSyncRun[] | Evet | The most recent runs, newest first. Includes the no-ops. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 422 · 429