hosting
GET /v1/sites/{siteId}/repo/sync
Two-way sync settings, state and recent runs for a site.
تصدیقهویت
یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د sites.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/repo/sync \
-H "Authorization: Bearer zdk_live_…"ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ
تفصیلات
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.
پارامترونه
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
siteId (path) | Uuid | هو | Site ID (UUIDv7). |
ځواب
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
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. |
تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي
401 · 403 · 404 · 429