Skip to content
Hoody Documentation
Hoody.com

Hoody Displays

Section titled “Hoody Displays”

The Display service provides a browser-based HTML5 viewer for remote desktops and applications running inside a Hoody container. It handles everything between the running workload and the user’s browser tab: rendering, encoding, input, screenshots, and session control. Every endpoint documented under this section is scoped to a single container and is reachable over HTTPS at the container’s display subdomain.

This section is organized around the responsibilities of the display server. Configuration endpoints live alongside the runtime endpoints they affect, so most workflows only need two or three pages.

Sub-pages

Section titled “Sub-pages”

Web Client Interface

Configure the HTML5 display client, including the WebSocket transport, scaling, and client-side rendering options.

/api/displays/web-client/

Input and Clipboard

Configure keyboard layouts, clipboard sharing, and scroll behavior between the local browser and the remote session.

/api/displays/input-clipboard/

Input Actions

Send low-level mouse, keyboard, and window-management events to automate or script the remote display.

/api/displays/input-actions/

Screenshots

Capture still images and thumbnails of the current display frame buffer and manage stored captures.

/api/displays/screenshots/

Session and Sharing

Configure session sharing, read-only mode, and guest access policies for the active display session.

/api/displays/session-sharing/

Health and Info

Read service health, version information, and the live API documentation exposed by the display server.

/api/displays/health/

Performance and Encoding

Tune codec selection, frame rate, bandwidth ceilings, and rendering quality for the display stream.

/api/displays/performance/

UI and Theming

Configure window decorations, the in-browser toolbar, and dark mode appearance for the viewer.

/api/displays/ui-theming/

Feature Flags

Enable or disable individual features such as printing, file transfer, audio, and video playback.

/api/displays/feature-flags/

Debugging

Enable diagnostic flags and verbose logging when troubleshooting display or streaming issues.

/api/displays/debugging/

Common URL template

Section titled “Common URL template”

All endpoints in this section are served by a per-container display server. Substitute {projectId}, {containerId} and {server} with the project, container and server of the target workload; the -display-N segment selects the display:

https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com

A request to the root path returns the HTML5 client. API endpoints are mounted under /api/... paths on the same host and accept a bearer token in the Authorization header.