Displays: Debugging

Use these debug URL parameters to enable granular logging from the Hoody Display client directly in the browser console. Each flag isolates a different subsystem (keyboard, mouse, network, file transfer, etc.) so you can capture exactly the signals you need when troubleshooting a session. All flags default to false; pass true to enable.

Enable debug logging

`GET /api/v1/display/`

Serves the HTML5 Display client web interface and accepts URL-based configuration flags, including the debug logging parameters documented below.

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`.

Example

Enable network and keyboard logging while leaving every other subsystem at its default:

curl -G "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/" \
  --data-urlencode "debug_network=true" \
  --data-urlencode "debug_keyboard=true"

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

await client.display.accessClient({ debug_network: true, debug_keyboard: true });

https://67e89abc123def456789abcd-890abcdef12345678901cdef-display-1.node-us.containers.hoody.com/api/v1/display/?debug_network=true&debug_keyboard=true

Response

{
  "description": "HTML5 Display client interface loaded successfully",
  "content": {
    "text/html": {
      "schema": {
        "type": "string"
      },
      "example": "<!DOCTYPE html>\n<html>\n<head><title>Hoody Display Client</title></head>\n<body>\n  <!-- Display HTML5 client interface -->\n</body>\n</html>\n"
    }
  }
}