hosting
PUT /v1/sites/{siteId}/repo/sync
Turn two-way sync on or off for a site.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл hosting.deploy.manage; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
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> }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
siteId (path) | Uuid | Так | Site ID (UUIDv7). |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
enabled | boolean | Так | — |
subdir | string | Ні | 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. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
site_id | string | Так | — |
enabled | boolean | Так | Whether the customer has switched two-way sync on. |
available | boolean | Так | 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 | Ні | A sentence the customer reads when available is false. Null when it is available. |
subdir | string | Ні | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error, unsupported> | Так | unsupported is TERMINAL and is not a failure either: the site is served from its repository, so there are no separate files on our side to push back. It leaves the sweep's… |
branch | string | Ні | — |
repository | string | Ні | owner/repo, or null when no repository is connected. |
conflict_commit | string | Ні | 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 | Ні | — |
last_sync_note | string | Ні | — |
runs | SiteRepoSyncRun[] | Так | The most recent runs, newest first. Includes the no-ops. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429