Enable or Disable Debug Logging
Enables or disables debug logging on the device. When enabled, the device
will emit unsolicited DEBUG_LOG frames (frame type 21) over the WebSocket
connection. Each frame contains a DebugLogMessage protobuf message with a
message string field.
Important: This setting is not persisted on the device. After a reconnect the device reverts to its firmware default (logging off).
The server stores incoming DEBUG_LOG frames per device (up to 1000 entries).
Stored logs are accessible via the CMS API:
GET /api/cms/devices/{id}/debug-logs— paginated log retrievalDELETE /api/cms/devices/{id}/debug-logs— clear all logs
Returns 404 if the device is not currently connected.
Authorizations
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
Device Key (4 BIP39 words) identifying the target device.
Obtain it from POST /device/otp/confirm/v2.
^[a-z]+-[a-z]+-[a-z]+-[a-z]+$"alpha-bravo-charlie-delta"
Body
Set to true to enable debug logging on the device, false to disable.
true
Response
OK — debug logging state applied on device.
The debug information of the device.
The free heap size of the device in bytes.
100000
The external flash size of the device in bytes.
100000
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.
false