System Monitoring

The Files service exposes a standard health endpoint for liveness probes, observability scripts, and platform-level diagnostics. Use these endpoints to verify that a container’s Files service is running, inspect build and start timestamps, and capture caller metadata (IP and User-Agent) along with runtime resource usage such as open file descriptors and resident memory.

Health

`GET /api/v1/files/health`

Service health check. Returns service identity, build and start timestamps, resource usage, and caller metadata.

This endpoint takes no parameters.

curl -X GET "https://{projectId}-{containerId}-files-1.{server}.containers.hoody.com/api/v1/files/health" \
  -H "Authorization: Bearer <token>"

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-files-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

await client.files.health.check();

{
  "status": "ok",
  "service": "hoody-files",
  "built": "2026-01-12T08:30:00.000Z",
  "started": "2026-01-15T14:22:11.482Z",
  "memory": {
    "heap": null,
    "rss": 48234496
  },
  "fds": 18,
  "pid": 24853,
  "ip": "203.0.113.42",
  "userAgent": "curl/8.5.0"
}

Response Statuses

Service is healthy.

{
  "status": "ok",
  "service": "hoody-files",
  "built": "2026-01-12T08:30:00.000Z",
  "started": "2026-01-15T14:22:11.482Z",
  "memory": {
    "heap": null,
    "rss": 48234496
  },
  "fds": 18,
  "pid": 24853,
  "ip": "203.0.113.42",
  "userAgent": "curl/8.5.0"
}

Field	Type	Description
`status`	string	Service status indicator. Typical value: `ok`.
`service`	string	Service identifier. Typical value: `hoody-files`.
`built`	string \| null	Build timestamp of the service binary.
`started`	string	Timestamp at which the service process started.
`memory`	object	Current process memory usage.
`memory.heap`	null	Always `null` for native services.
`memory.rss`	integer \| null	Resident set size in bytes.
`fds`	integer \| null	Open file descriptor count.
`pid`	integer	Process identifier of the running service.
`ip`	string	Caller IP address. Empty string when the request arrives over a Unix socket.
`userAgent`	string	User-Agent header from the incoming request.