System Monitoring

Health check endpoints for the Files service. Use these endpoints to verify service availability, inspect build metadata, and monitor runtime resource usage such as file descriptors and resident memory.

Check service health

Returns the service identity, build and start timestamps, current resource usage, and caller metadata. Use this endpoint for liveness probes and operational dashboards.

GET /api/v1/files/health

This endpoint takes no parameters.

Response

Service is healthy.

{
  "status": "ok",
  "service": "hoody-files",
  "built": "2025-01-15T08:30:00.000Z",
  "started": "2025-01-20T14:22:10.000Z",
  "memory": {
    "heap": null,
    "rss": 67108864
  },
  "fds": 42,
  "pid": 12891,
  "ip": "203.0.113.42",
  "userAgent": "curl/8.4.0"
}

Field	Type	Description
`status`	string	Health status. Always `"ok"` when the service responds successfully.
`service`	string	Service identifier (e.g., `hoody-files`).
`built`	string \| null	Build timestamp (ISO 8601). `null` if the binary was built without a recorded timestamp.
`started`	string	Service start timestamp (ISO 8601).
`memory`	object	Container for memory usage metrics.
`memory.heap`	null	Always `null` for native (non-JS) services.
`memory.rss`	integer \| null	Resident set size in bytes.
`fds`	integer \| null	Open file descriptor count.
`pid`	integer	Process ID of the running service.
`ip`	string	Caller IP address. Empty string when the request arrives over a Unix socket.
`userAgent`	string	`User-Agent` header of the incoming request.

const health = await client.files.health.check();

console.log(health.status);   // "ok"
console.log(health.service);  // "hoody-files"
console.log(health.memory.rss);

curl https://api.hoody.com/api/v1/files/health