hosting
PUT /v1/sites/{siteId}/repo/sync
Turn two-way sync on or off for a site.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте hosting.deploy.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
siteId (path) | Uuid | Иә | Site ID (UUIDv7). |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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> | Иә | `conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side. |
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