hosting

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

Turn search-engine visibility or debug mode on or off.

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 PUT https://api.zinndigital.com/v1/sites/{siteId}/wordpress/switches \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Send one switch or both; an absent switch is left alone. Each is written, then confirmed by re-reading the site, and audit-logged as wordpress.switch.<name>.<on|off>. The response is the site's state as re-read. ⛔ Fleet only — refused where wp_maintenance is false. Requires sites.view and sites.panel_access.

Parameters

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

Request body

NameTypeRequiredWhat it is
search_engines_visiblebooleanNoFalse ticks WordPress's "Discourage search engines" setting.
debug_modebooleanNoSets WP_DEBUG in wp-config.php.

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 · 422 · 429 · 503