Overview
Section titled “Overview”The Display service exposes a lightweight, unauthenticated health check endpoint used to verify that the service is running and reachable. It returns a standardized 9-field health payload including process metadata, memory usage, and the client IP that issued the request. Use this endpoint for liveness probes, uptime monitoring, and operational diagnostics.
Check service health
Section titled “Check service health”GET /api/v1/display/health
Section titled “GET /api/v1/display/health”Returns the standardized health response for the Display service. This endpoint is unauthenticated and always responds with HTTP 200 and an application/json body whenever the service process is up.
This endpoint takes no parameters.
curl -X GET "https://api.hoody.com/api/v1/display/health" \ -H "Accept: application/json"const result = await client.display.health.check();{ "status": "ok", "service": "display", "built": "2026-01-12T08:30:00.000Z", "started": "2026-01-15T14:22:10.412Z", "memory": { "rss": 87359488, "heap": 14221312 }, "fds": 24, "pid": 4821, "ip": "203.0.113.42", "userAgent": "curl/8.5.0"}| Field | Type | Description |
|---|---|---|
status | string | Health status indicator. Always "ok" when the service is up. |
service | string | Logical name of the service reporting health. |
built | string | Build timestamp of the running service (nullable). |
started | string | ISO-8601 timestamp at which the process started. |
memory | object | Memory usage snapshot. Contains rss (resident set size in bytes) and heap (V8 heap used in bytes). Nullable. |
fds | integer | Number of open file descriptors held by the process (nullable). |
pid | integer | Operating system process ID. |
ip | string | IP address of the caller that triggered the health check. |
userAgent | string | User-Agent header from the incoming request (nullable). |