Displays: Health & Info

Health & Info

The Display service exposes a lightweight health endpoint that reports runtime metadata for monitoring, load balancers, and uptime checks. The endpoint is unauthenticated and always returns HTTP 200 with an application/json body when the service is reachable, making it safe to wire into health probes without rotating credentials.

`GET /api/v1/display/health`

Returns the standardized 9-field health response for the Display service. Use this endpoint for liveness/readiness probes and to verify the service is running before issuing operational requests.

This endpoint takes no parameters.

curl -X GET "https://proj_a1b2c3d4-ctnr_8x7y6z5w-display-1.us-east-1.containers.hoody.icu/api/v1/display/health"

import { HoodyClient } from "hoody-sdk";

const client = new HoodyClient({ token: process.env.HOODY_TOKEN });

// No parameters — call directly.
const health = await client.display.health.check();

console.log(health.status, health.pid, health.ip);

{
  "status": "ok",
  "service": "display",
  "built": "2026-01-15T10:30:00.000Z",
  "started": "2026-01-20T14:22:51.117Z",
  "memory": {
    "rss": 48732160,
    "heap": 12648320
  },
  "fds": 24,
  "pid": 12847,
  "ip": "10.0.4.18",
  "userAgent": "hoody-sdk/3.4.2 (node/20.11.0; linux-x64)"
}

Response fields

Field	Type	Required	Description
`status`	string	Yes	Service health indicator. Always `ok` when the endpoint responds.
`service`	string	Yes	Logical service name reporting the health payload.
`built`	string	No	Build timestamp (ISO 8601). `null` if the service was not built with a recorded commit.
`started`	string	Yes	Process start timestamp (ISO 8601).
`memory`	object	No	Process memory snapshot. `null` if memory accounting is unavailable. See fields below.
`memory.rss`	integer	Yes (when `memory` present)	Resident set size in bytes.
`memory.heap`	integer	No	V8 heap used in bytes. `null` on non-V8 runtimes.
`fds`	integer	No	Number of open file descriptors. `null` on platforms that do not expose this.
`pid`	integer	Yes	Process ID of the Display service.
`ip`	string	Yes	IP address the service is bound to.
`userAgent`	string	No	User-Agent of the inbound request. `null` if not forwarded by the proxy.