hosting

PUT `/v1/sites/{siteId}/repo/sync`

Turn two-way sync on or off for a site.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה hosting.deploy.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/repo/sync \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": <boolean> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

Free, and refused with 422 unless the customer has connected their own GitHub account. Turning it on does not push anything by itself — the first run is either the scheduled sweep or an explicit run. Requires `hosting.deploy.manage`.

פרמטרים

שם	סוג	נדרש	מה זה
`siteId (path)`	`Uuid`	כן	Site ID (UUIDv7).

גוף הבקשה

שם	סוג	נדרש	מה זה
`enabled`	`boolean`	כן	—
`subdir`	`string`	לא	Restrict the sync to one directory of the site. Empty syncs the whole document root, which for a WordPress site is usually not what the customer wants.

תשובה

שם	סוג	נדרש	מה זה
`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>`	כן	`conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side.
`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

PUT /v1/sites/{siteId}/repo/sync