# Displays: Health & Info

**Page:** api/displays/health

[Download Raw Markdown](./api/displays/health.md)

---

{/* AUTO-GENERATED — Do not edit manually. Regenerate with: npm run docs:api:generate */}



## Health check

Use these endpoints to verify the Display service is reachable and to inspect its runtime state. The health endpoint is unauthenticated and always returns HTTP 200 with `application/json` when the service is up.

### `GET /api/v1/display/health`

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.



```bash
curl https://api.hoody.com/api/v1/display/health
```


```ts
const result = await client.display.health.check();
```


Service is healthy.

```json
{
  "status": "ok",
  "service": "display",
  "built": "2024-01-15T08:00:00.000Z",
  "started": "2024-01-20T12:34:56.789Z",
  "memory": {
    "rss": 52428800,
    "heap": 16777216
  },
  "fds": 42,
  "pid": 12345,
  "ip": "192.168.1.100",
  "userAgent": "Hoody-SDK/1.0"
}
```

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `status` | string | Yes | Service status. Always `"ok"`. |
| `service` | string | Yes | Service identifier. |
| `built` | string | No | Build timestamp (ISO 8601). |
| `started` | string | Yes | Service start timestamp (ISO 8601). |
| `memory` | object | No | Process memory usage (see below). |
| `fds` | integer | No | Open file descriptor count. |
| `pid` | integer | Yes | Process ID. |
| `ip` | string | Yes | Server IP address. |
| `userAgent` | string | No | Request user agent. |


The `memory` object has the following properties:
- `rss` (integer, required) — Resident set size in bytes
- `heap` (integer) — V8 heap used in bytes