Displays: Web Client Interface

The HTML5 Display client is the browser-based interface users load to interact with a remote desktop session running inside a Hoody container. This page documents the connection and general access parameters used to configure that client when accessed through the versioned REST endpoint. Use these parameters to pin a display by ID, target a specific node, project, or container, switch transport layers (SSL, WebTransport), enable audio, or turn on auto-reconnect.

Access the HTML5 Display client interface

GET /api/v1/display/

Serves the HTML5 Display client web interface with optional URL-based configuration. Use this endpoint for RESTful API compliance, versioned client access, or API gateway integrations. It accepts the same connection and access parameters as the root client endpoint.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1-999999
`node`	query	string	No	Hoody node identifier (e.g., `example-1`, `example-2`)
`project_id`	query	string	No	Hoody project ID
`container_id`	query	string	No	Hoody container ID
`url_display_id`	query	string	No	Display ID for URL construction
`ssl`	query	boolean	No	Use SSL/TLS for WebSocket connection. Default: `true`
`webtransport`	query	boolean	No	Use WebTransport (HTTP3) instead of WebSocket. Default: `false`
`sound`	query	boolean	No	Enable audio forwarding. Default: `true`
`audio_codec`	query	string	No	Preferred audio codec
`reconnect`	query	boolean	No	Auto-reconnect on connection loss. Default: `true`

Request body

This endpoint takes no request body.

curl "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.icu/api/v1/display/?displayId=10&node=example-1&project_id=my-project&container_id=my-container&url_display_id=10&ssl=true&webtransport=false&sound=true&audio_codec=opus&reconnect=true"

await client.display.accessClient({
  displayId: 10,
  node: 'example-1',
  project_id: 'my-project',
  container_id: 'my-container',
  url_display_id: '10',
  ssl: true,
  webtransport: false,
  sound: true,
  audio_codec: 'opus',
  reconnect: true
});

Response

200 OK

HTML5 Display client interface loaded successfully. The response body is the HTML markup of the client, returned as text/html.

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