hosting

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

Search-engine visibility and debug mode, read from the site.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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

The two on/off switches a WordPress manager offers: whether search engines are asked to index the site (blog_public) and whether WP_DEBUG is on. ⛔ Read from the site, never our record of what we last set — a customer can tick "Discourage search engines" in wp-admin and a developer can edit wp-config.php. An empty object means the platform hosting this site has no such switches (a vendor package). Requires sites.view.

Parameters

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

Response

NameTypeRequiredWhat it is
search_engines_visiblebooleanNoFalse when WordPress's "Discourage search engines" is ticked (blog_public = 0).
debug_modebooleanNoTrue when WP_DEBUG is on in wp-config.php.

Errors this endpoint can return

401 · 403 · 404 · 429 · 503