Skip to content

System Endpoints

Health Check

GET /api/health

Returns the server health status. Used by Docker health checks.

Example

bash
curl http://localhost:3000/api/health

Response

json
{
  "status": "ok"
}

Metrics

GET /api/metrics

Returns internal server metrics for monitoring.

Example

bash
curl http://localhost:3000/api/metrics

Response

json
{
  "requests": 150,
  "latency": 45,
  "errors": 2,
  "memory": 65432100
}
FieldTypeDescription
requestsnumberTotal request count since server start
latencynumberAverage response time in milliseconds
errorsnumberTotal error count since server start
memorynumberProcess memory usage in bytes

Design and Dev by David Lam