hosting

GET /v1/sites/{siteId}/wordpress/maintenance

Is the site showing WordPress's maintenance page?

All hosting endpoints

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/maintenance \
  -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

⛔ Asks **the site**, not our record of what we last set. The flag is a `.maintenance` file in the document root and WordPress writes it itself during a core update — so a site can be in maintenance mode without us ever having asked for it, and a screen reading our own memory would show "live" over a page serving *"Briefly unavailable for scheduled maintenance"*. Ungated, like every read on this surface. Requires `sites.view`.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
enabledbooleanYesTrue when visitors are seeing the maintenance page.

Errors this endpoint can return

401 · 403 · 404 · 429 · 503