hosting

PUT `/v1/sites/{siteId}/wordpress/update-policy`

Set the site's auto-update policy and apply it to WordPress.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/wordpress/update-policy \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "core": <string<off, minor, all>>, "plugins": <boolean>, "themes": <boolean>, "ring": <string<canary, early, general>> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Stores the policy **and writes it to the site in the same call**, then re-reads the site and returns what it found. ⛔ Storing without applying is the defect this endpoint exists to avoid: a stored row saying `core: off` over a WordPress that is still updating itself is worse than no row, because the screen then says the operator's decision took effect. The response body is a fresh read, never an echo of the request. ⛔ On a failed apply the policy row keeps `apply_error` **and** the call answers `422`. Only recording it would be a silent failure; only raising it would leave a stored policy nobody knows was never applied. `ring` is the **staged-rollout** ring this site belongs to — `canary`, `early` or `general`. It is a property of the site, not of the change, so an operator picks their canaries once and every later rollout inherits the choice. ⛔ **Fleet only** — refused where `wp_update_policy` is `false`, because it is written with `wp config set` and `wp plugin auto-updates` and this platform publishes no equivalent. Requires `sites.view` and `sites.panel_access`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`siteId (path)`	`Uuid`	نعم	Site ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`core`	`string<off, minor, all>`	نعم	`minor` is WordPress's own default (security and maintenance releases); `all` includes major upgrades unattended; `off` disables core auto-updates.
`plugins`	`boolean`	نعم	Whether every plugin should auto-update.
`themes`	`boolean`	نعم	Whether every theme should auto-update.
`ring`	`string<canary, early, general>`	نعم	The staged-rollout ring this site belongs to.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`core`	`string<off, minor, all>`	نعم	The stored policy for WordPress core updates.
`plugins`	`boolean`	نعم	The stored policy — whether every plugin should auto-update.
`themes`	`boolean`	نعم	The stored policy — whether every theme should auto-update.
`ring`	`string<canary, early, general>`	نعم	The staged-rollout ring this site belongs to.
`applied_at`	`string`	نعم	When the policy last reached the site, ISO-8601, or `""` if it never has. ⛔ A timestamp and not a flag: "when did this last reach the site" is the question an operator asks, and…
`apply_error`	`string`	نعم	Why the last apply failed, or `""`. Kept beside `applied_at` rather than replacing it, so a failed re-apply does not erase that an earlier one worked.
`observed_read`	`boolean`	نعم	Whether the site itself was read. ⛔ An empty `drift` is only meaningful while this is `true`.
`observed_core`	`string`	نعم	What `WP_AUTO_UPDATE_CORE` is set to on the site — `off`, `minor`, `all`, or `""` meaning the constant is not defined at all, so WordPress applies its own default. ⛔ `""` is…
`plugins_off`	`string[]`	نعم	The plugins on this site that are NOT auto-updating.
`themes_off`	`string[]`	نعم	The themes on this site that are NOT auto-updating.
`drift`	`string<core, plugins, themes>[]`	نعم	Which of `core`, `plugins`, `themes` the site disagrees with the policy about.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/sites/{siteId}/wordpress/update-policy