hosting

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

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

Wszystkie punkty końcowe hosting

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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>> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).

Treść żądania

NazwaTypWymaganeCo to jest
corestring<off, minor, all>Takminor is WordPress's own default (security and maintenance releases); all includes major upgrades unattended; off disables core auto-updates.
pluginsbooleanTakWhether every plugin should auto-update.
themesbooleanTakWhether every theme should auto-update.
ringstring<canary, early, general>TakThe staged-rollout ring this site belongs to.

Odpowiedź

NazwaTypWymaganeCo to jest
corestring<off, minor, all>TakThe stored policy for WordPress core updates.
pluginsbooleanTakThe stored policy — whether every plugin should auto-update.
themesbooleanTakThe stored policy — whether every theme should auto-update.
ringstring<canary, early, general>TakThe staged-rollout ring this site belongs to.
applied_atstringTakWhen 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 a…
apply_errorstringTakWhy 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_readbooleanTakWhether the site itself was read. ⛔ An empty drift is only meaningful while this is true.
observed_corestringTakWhat 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_offstring[]TakThe plugins on this site that are NOT auto-updating.
themes_offstring[]TakThe themes on this site that are NOT auto-updating.
driftstring<core, plugins, themes>[]TakWhich of core, plugins, themes the site disagrees with the policy about.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429 · 503