hosting
GET /v1/sites/{siteId}/repo/sync
Two-way sync settings, state and recent runs for a site.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/repo/sync \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
site_id | string | Ja | — |
enabled | boolean | Ja | Whether the customer has switched two-way sync on. |
available | boolean | Ja | 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 | Nein | A sentence the customer reads when `available` is false. Null when it is available. |
subdir | string | Nein | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error> | Ja | `conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side. |
branch | string | Nein | — |
repository | string | Nein | `owner/repo`, or null when no repository is connected. |
conflict_commit | string | Nein | 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 | Nein | — |
last_sync_note | string | Nein | — |
runs | SiteRepoSyncRun[] | Ja | The most recent runs, newest first. Includes the no-ops. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 429