hosting

POST /v1/sites/{siteId}/repo/sync/run

Sync this site with its repository now.

כל נקודות הקצה מסוג hosting

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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_idstringכן
enabledbooleanכןWhether the customer has switched two-way sync on.
availablebooleanכן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_reasonstringלאA sentence the customer reads when `available` is false. Null when it is available.
subdirstringלאWhich directory of the site syncs. Empty means the whole document root.
statestring<idle, synced, conflict, adopt, error>כן`conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side.
branchstringלא
repositorystringלא`owner/repo`, or null when no repository is connected.
conflict_commitstringלא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_atstringלא
last_sync_notestringלא
runsSiteRepoSyncRun[]כןThe most recent runs, newest first. Includes the no-ops.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429