hosting
POST /v1/sites/{siteId}/repo/sync/run
Sync this site with its repository now.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění hosting.deploy.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/repo/sync/run \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
Commits whatever has changed in the site's files and pushes it to the connected branch. A 200 whose state is conflict or adopt is a successful call reporting a HELD sync — the repository moved since we last agreed with it, so nothing was pushed and nothing was overwritten on either side. Never force-pushes and never merges. Requires hosting.deploy.manage.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
site_id | string | Ano | — |
enabled | boolean | Ano | Whether the customer has switched two-way sync on. |
available | boolean | Ano | 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 | Ne | A sentence the customer reads when available is false. Null when it is available. |
subdir | string | Ne | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error, unsupported> | Ano | 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 | Ne | — |
repository | string | Ne | owner/repo, or null when no repository is connected. |
conflict_commit | string | Ne | 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 | Ne | — |
last_sync_note | string | Ne | — |
runs | SiteRepoSyncRun[] | Ano | The most recent runs, newest first. Includes the no-ops. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429