hosting
POST /v1/sites/{siteId}/repo/sync/run
Sync this site with its repository now.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز hosting.deploy.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/repo/sync/run \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
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.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 · 422 · 429