API documentation

DisplayHub API

Local API documentation without external CDN dependencies. Use these endpoints to inspect service health, manage screens, upload media, and publish playback configuration.

Open OpenAPI JSON Back to site

Core endpoints

GET/healthz
GET/openapi.json
POST/auth/login-password
POST/auth/request-code
GET/auth/me
GET/device/{device_id}/config
POST/device/{device_id}/config
POST/device/{device_id}/heartbeat
GET/admin/devices
POST/admin/devices
GET/admin/devices/{device_id}/token
POST/admin/devices/{device_id}/token
POST/admin/devices/{device_id}/token/reset
GET/admin/media?workspace_code={code}
POST/admin/media
DELETE/admin/media/{asset_id}
WS/ws/device/{device_id}