hosting

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

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

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास hosting.deploy.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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