Skip to main content
POST
Enable or Disable Debug Logging

Authorizations

Authorization
string
header
required

Short-lived session token obtained from POST /api/sessions/v2. Send it as Authorization: Bearer <session_token> together with the X-Device-Key: <device-key> header identifying the target device.

Headers

X-Device-Key
string
required

Device Key (4 BIP39 words) identifying the target device. Obtain it from POST /device/otp/confirm/v2.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$
Example:

"alpha-bravo-charlie-delta"

Body

application/json
enabled
boolean
required

Set to true to enable debug logging on the device, false to disable.

Example:

true

Response

OK — debug logging state applied on device.

The debug information of the device.

free_heap_size
number

The free heap size of the device in bytes.

Example:

100000

external_flash_size
number

The external flash size of the device in bytes.

Example:

100000

debug_logging_enabled
boolean

Whether debug logging is currently enabled on the device. When true, the device emits DEBUG_LOG frames (frame type 21) over the WebSocket containing a DebugLogMessage { message: string } protobuf payload.

Example:

false