hosting

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

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

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये hosting.deploy.manage परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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, 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

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