The System Monitoring endpoints expose health and runtime information for the Files service. Use these endpoints to verify that the service is running, to inspect resource usage such as memory and file descriptor counts, and to retrieve build and start metadata. The health endpoint is also useful for liveness probes and uptime monitoring.

Health

GET /api/v1/files/health

Standard service health endpoint. Returns service identity, build and start timestamps, resource usage, and caller metadata.

This endpoint takes no parameters.

cURL

curl -X GET "https://proj-alpha-cnt-7f3a-files-1.eu-west-1.containers.hoody.icu/api/v1/files/health"

JavaScript SDK

await client.files.health.check();

Response

{
  "status": "ok",
  "service": "hoody-files",
  "built": "2024-11-12T08:42:17.000Z",
  "started": "2024-12-01T14:23:09.512Z",
  "memory": {
    "heap": null,
    "rss": 73400320
  },
  "fds": 18,
  "pid": 2741,
  "ip": "203.0.113.42",
  "userAgent": "curl/8.5.0"
}

Response fields

Field	Type	Required	Description
status	string	Yes	Service health status. "ok" when the service is healthy.
service	string	Yes	Service identifier.
built	string | null	Yes	Build timestamp of the service binary in ISO 8601 format.
started	string	Yes	Process start timestamp in ISO 8601 format.
memory	object	Yes	Current memory usage of the service process.
memory.heap	null	Yes	Always null for native services.
memory.rss	integer | null	Yes	Resident set size in bytes.
fds	integer | null	Yes	Number of open file descriptors held by the process.
pid	integer	Yes	Operating system process ID of the service.
ip	string	Yes	Caller IP address. Empty string when the request arrives over a Unix socket.
userAgent	string	Yes	User-Agent header of the inbound request.