hosting
POST /v1/sites/{siteId}/repo/sync/resolve
Clear a held sync by choosing which side wins.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation hosting.deploy.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/repo/sync/resolve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "keep": <string<site, repository>> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
keep: site commits this site's files on top of the repository's current tip, so the other commits stay in the history rather than being erased. keep: repository applies the repository to the site, discarding the unsynced changes on our side — which is destructive, and is the only path that may overwrite them. There is deliberately no merge option: a platform neither party asked to arbitrate should not produce a file that neither of them wrote. Requires hosting.deploy.manage.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
keep | string<site, repository> | Oui | site keeps this site's files and commits them on top of the repository's current tip. repository discards the unsynced changes on our side and takes the repository's version —… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
site_id | string | Oui | — |
enabled | boolean | Oui | Whether the customer has switched two-way sync on. |
available | boolean | Oui | 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 | Non | A sentence the customer reads when available is false. Null when it is available. |
subdir | string | Non | Which directory of the site syncs. Empty means the whole document root. |
state | string<idle, synced, conflict, adopt, error, unsupported> | Oui | 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 | Non | — |
repository | string | Non | owner/repo, or null when no repository is connected. |
conflict_commit | string | Non | 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 | Non | — |
last_sync_note | string | Non | — |
runs | SiteRepoSyncRun[] | Oui | The most recent runs, newest first. Includes the no-ops. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429