hosting
PUT /v1/sites/{siteId}/wordpress/update-policy
Set the site's auto-update policy and apply it to WordPress.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
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>> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
core | string<off, minor, all> | Oui | minor is WordPress's own default (security and maintenance releases); all includes major upgrades unattended; off disables core auto-updates. |
plugins | boolean | Oui | Whether every plugin should auto-update. |
themes | boolean | Oui | Whether every theme should auto-update. |
ring | string<canary, early, general> | Oui | The staged-rollout ring this site belongs to. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
core | string<off, minor, all> | Oui | The stored policy for WordPress core updates. |
plugins | boolean | Oui | The stored policy — whether every plugin should auto-update. |
themes | boolean | Oui | The stored policy — whether every theme should auto-update. |
ring | string<canary, early, general> | Oui | The staged-rollout ring this site belongs to. |
applied_at | string | Oui | 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 a… |
apply_error | string | Oui | 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 | Oui | Whether the site itself was read. ⛔ An empty drift is only meaningful while this is true. |
observed_core | string | Oui | 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[] | Oui | The plugins on this site that are NOT auto-updating. |
themes_off | string[] | Oui | The themes on this site that are NOT auto-updating. |
drift | string<core, plugins, themes>[] | Oui | Which of core, plugins, themes the site disagrees with the policy about. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429 · 503