Displays: Debugging

Use these debug query parameters to enable verbose logging for specific Display client subsystems. When a flag is set to true, the corresponding subsystem writes detailed diagnostic output to the browser’s developer console, making it easier to troubleshoot rendering, input, networking, and file transfer issues.

This page documents the nine debug_* query parameters accepted by the /api/v1/display/ endpoint. The endpoint accepts additional parameters for client customization; those are covered on other pages.

`GET /api/v1/display/`

Access the HTML5 Display client interface with optional debug logging enabled via URL parameters. The same parameters are available on the root endpoint / — this version is the standardized, versioned API path used for RESTful integrations and API gateways.

Parameters

Name	In	Type	Required	Description
`debug_main`	query	boolean	No	Enable main debug logging. Default: `false`
`debug_network`	query	boolean	No	Enable network debug logging. Default: `false`
`debug_keyboard`	query	boolean	No	Enable keyboard debug logging. Default: `false`
`debug_mouse`	query	boolean	No	Enable mouse debug logging. Default: `false`
`debug_geometry`	query	boolean	No	Enable geometry debug logging. Default: `false`
`debug_draw`	query	boolean	No	Enable draw debug logging. Default: `false`
`debug_clipboard`	query	boolean	No	Enable clipboard debug logging. Default: `false`
`debug_audio`	query	boolean	No	Enable audio debug logging. Default: `false`
`debug_file`	query	boolean	No	Enable file transfer debug logging. Default: `false`

cURL
SDK

curl -G "https://domain.com/api/v1/display/" \
  --data-urlencode "debug_main=true" \
  --data-urlencode "debug_network=true" \
  --data-urlencode "debug_keyboard=true" \
  --data-urlencode "debug_mouse=true" \
  --data-urlencode "debug_geometry=true" \
  --data-urlencode "debug_draw=true" \
  --data-urlencode "debug_clipboard=true" \
  --data-urlencode "debug_audio=true" \
  --data-urlencode "debug_file=true"

await client.display.accessClient({
  debug_main: true,
  debug_network: true,
  debug_keyboard: true,
  debug_mouse: true,
  debug_geometry: true,
  debug_draw: true,
  debug_clipboard: true,
  debug_audio: true,
  debug_file: true
});

Response

<!DOCTYPE html>
<html>
<head><title>Hoody Display Client</title></head>
<body>
  <!-- Display HTML5 client interface -->
</body>
</html>