Skip to main content
PUT
Replace WordPress debug settings

Authorizations

Authorization
string
header
required

Personal API token, sent as Authorization: Bearer <SANDYWP_API_KEY>. Obtain one from the dashboard account menu (API keys), sandywp auth login, or POST /api/account/tokens. A missing or invalid token returns 401 auth_required. Scoped OAuth tokens are limited to the Imports family and GET /api/account/me; see the top-level conventions.

Headers

X-SandyWP-Workspace
string

Selects which of the caller's workspaces to act in, for accounts belonging to more than one (legacy alias: X-SandyWP-Organization). Defaults to the caller's own personal workspace when omitted. Every id in this API (sandboxes, Templates, repositories) is scoped to a single workspace, so this header changes which set of resources is visible.

Path Parameters

id
string
required

The sandbox id.

Body

application/json
wpDebug
boolean

Enable WP_DEBUG. Defaults to false when omitted.

wpDebugLog
boolean

Log errors to wp-content/debug.log. Defaults to false when omitted; requires wpDebug.

wpDebugDisplay
boolean

Display errors on the site itself, visible to visitors. Defaults to false when omitted; requires wpDebug.

scriptDebug
boolean

Enable SCRIPT_DEBUG (unminified core JS/CSS). Defaults to false when omitted.

queryMonitor
boolean

Install & activate the Query Monitor plugin. Defaults to false when omitted.

Response

The applied debug settings and, if a change was queued, its job id.

debugOptions
object
required

A sandbox's WordPress debug toggles.

jobId
string | null
required

The queued apply_debug_options job id, or null if the request was a no-op (settings already matched).