Skip to content

Toggle printing, file transfer, video, and notification features for the HTML5 Display client by passing query parameters to the client access endpoint. These flags let you customize the client experience for kiosks, dashboards, locked-down workstations, or shared environments without changing server configuration.

GET /api/v1/display/

Serves the HTML5 Display client web interface with optional URL-based configuration. This is the standardized API version of the root endpoint /.

Use this endpoint for:

  • RESTful API compliance
  • Versioned client access
  • API gateway integrations

Accepts the same 50+ URL parameters as the root endpoint for full client customization. This page documents the feature toggle parameters; other parameters are covered separately.

Example:

Terminal window
https://domain.com/api/v1/display/?displayId=10&readonly=true&decorations=false
NameInTypeRequiredDescription
printingquerybooleanNoEnable printing support. Default: true
file_transferquerybooleanNoEnable file transfer support. Default: true
videoquerybooleanNoEnable video encoding support. Default: true
mediasource_videoquerybooleanNoEnable MediaSource API for video. Default: true
notification_server_urlquerystringNoExternal notification server URL for real-time notification integration. If not provided, the client attempts to auto-detect from the current hostname pattern.
web_notificationsquerybooleanNoEnable browser web notifications (native OS notifications). Default: true
display_notificationsquerybooleanNoShow notifications within display UI. Default: true
notification_connection_typequerystringNoNotification server connection type. Default: "websocket". Allowed values: "websocket", "polling"

The notification_server_url parameter expects a URL in the following format:

https://{project}-{container}-n-{display}.{node}.containers.hoody.com/notification-client.js

Examples:

  • Manual: ?notification_server_url=https://my-project-container-n-6.node.containers.hoody.com/notification-client.js
  • Auto-detected from: https://my-project-container-display-6.node.containers.hoody.com

The notification server (port 3999) provides historical notification retrieval, real-time WebSocket notification updates, notification icons serving, and desktop notification triggering. See the external notification server OpenAPI spec for complete API documentation.

This endpoint takes no request body.

The HTML5 Display client interface is returned as text/html.

<!DOCTYPE html>
<html>
<head><title>Hoody Display Client</title></head>
<body>
<!-- Display HTML5 client interface -->
</body>
</html>
Terminal window
curl -X GET "https://domain.com/api/v1/display/?printing=true&file_transfer=true&video=true&mediasource_video=true&notification_server_url=https://my-project-container-n-6.node.containers.hoody.com/notification-client.js&web_notifications=true&display_notifications=true&notification_connection_type=websocket"