hosting
PUT /v1/sites/{siteId}/repo/sync
Turn two-way sync on or off for a site.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429