hosting

GET /v1/sites/{siteId}/repo/sync

Two-way sync settings, state and recent runs for a site.

Svi hosting krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu sites.view; ključ bez nje se odbija s kodom 403, a ne 404.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/repo/sync \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

Whether this site's own files are committed back to its repository, where the sync currently stands, and the last runs. available is false when the customer has not connected their own account — two-way sync is free but only ever writes to a repository on an account the customer owns, so a pooled account of ours is never enough. state of conflict or adopt means the sync is HELD, waiting for the customer to choose; it is not an error and it will not clear itself. Requires sites.view.

Parametri

NazivVrstaObaveznoŠto je to
siteId (path)UuidDaSite ID (UUIDv7).

Odgovor

NazivVrstaObaveznoŠto je to
site_idstringDa
enabledbooleanDaWhether the customer has switched two-way sync on.
availablebooleanDaWhether 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_reasonstringNeA sentence the customer reads when available is false. Null when it is available.
subdirstringNeWhich directory of the site syncs. Empty means the whole document root.
statestring<idle, synced, conflict, adopt, error, unsupported>Daunsupported 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…
branchstringNe
repositorystringNeowner/repo, or null when no repository is connected.
conflict_commitstringNeThe commit in the repository that we have not seen — the one the customer needs to look at before choosing. Null unless held.
last_sync_atstringNe
last_sync_notestringNe
runsSiteRepoSyncRun[]DaThe most recent runs, newest first. Includes the no-ops.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 429