Displays: Health & Info

The Display service health endpoint provides a lightweight, unauthenticated way to verify that the service is running and reachable. Use it for liveness probes, monitoring, and quick diagnostics. The response is a standardized payload with runtime metadata such as process ID, IP address, start time, and memory usage.

Service Health Check

Returns the standardized health response. Unauthenticated. Always returns HTTP 200 with application/json when the service is up.

GET /api/v1/display/health

This endpoint takes no parameters.

cURL

curl -X GET "https://67e89abc123def456789abcd-890abcdef12345678901cdef-display-1.node-us.containers.hoody.com/api/v1/display/health"

TypeScript SDK

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://67e89abc123def456789abcd-890abcdef12345678901cdef-display-1.node-us.containers.hoody.com', token: process.env.HOODY_TOKEN });

await client.display.health.check();

Response

200

{
  "status": "ok",
  "service": "display",
  "built": "2024-01-15T10:30:00.000Z",
  "started": "2024-01-20T08:00:00.000Z",
  "memory": {
    "rss": 52428800,
    "heap": 16777216
  },
  "fds": 128,
  "pid": 12345,
  "ip": "10.0.0.5",
  "userAgent": "Hoody-Display/1.0"
}