hosting
GET /v1/sites/{siteId}/wordpress/update-policy
What this site is set to update by itself, and where it has drifted.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/wordpress/update-policy \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Returns three things that must never be collapsed into one: the policy an operator stored, what the site is actually configured to do, and the drift between them. ⛔ A screen showing only the stored policy cannot tell a customer that the policy was never applied — which is the whole point. A decision is applied when a row changes, and the row that decides whether a WordPress updates itself lives on that WordPress, not in this platform's database. A customer can change any of it from wp-admin, a plugin can change it on activation, and a restored backup carries the old settings back. ⛔ observed_core is "" when WP_AUTO_UPDATE_CORE is not defined at all, which is NOT the same as off — an undefined constant means WordPress applies its own default, which is minor. Rendering the first as the second would tell an operator their sites are not taking security releases when in fact they are. ⛔ observed_read is false when the site could not be read (a managed hosting package, or a box that did not answer). An empty drift is only meaningful while it is true; otherwise an unreachable site renders as compliant, which is the worst default for a security setting. Ungated read — requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
core | string<off, minor, all> | Yes | The stored policy for WordPress core updates. |
plugins | boolean | Yes | The stored policy — whether every plugin should auto-update. |
themes | boolean | Yes | The stored policy — whether every theme should auto-update. |
ring | string<canary, early, general> | Yes | The staged-rollout ring this site belongs to. |
applied_at | string | Yes | 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 | Yes | 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 | Yes | Whether the site itself was read. ⛔ An empty drift is only meaningful while this is true. |
observed_core | string | Yes | 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[] | Yes | The plugins on this site that are NOT auto-updating. |
themes_off | string[] | Yes | The themes on this site that are NOT auto-updating. |
drift | string<core, plugins, themes>[] | Yes | Which of core, plugins, themes the site disagrees with the policy about. |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503