Displays: Health & Info
Section titled “Displays: Health & Info”The Display service exposes a health endpoint for liveness checks and operational monitoring. Use these endpoints from uptime probes, load balancers, or container orchestration tooling to confirm that a Display instance is running and reachable. The health check is unauthenticated and always returns HTTP 200 with an application/json body when the service is up.
Health
Section titled “Health”GET /api/v1/display/health
Section titled “GET /api/v1/display/health”Service health check. Returns the standardized 9-field health response. Unauthenticated. Always returns HTTP 200 with application/json when the service is up.
This endpoint takes no parameters.
curl -X GET 'https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/health'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.kit.getHealth();Service is healthy.
{ "status": "ok", "service": "display", "built": "2024-01-15T10:30:00Z", "started": "2024-01-20T14:22:31Z", "memory": { "rss": 52428800, "heap": 16777216 }, "fds": 12, "pid": 1, "ip": "10.0.0.5", "userAgent": "hoody-display/1.0"}