FugokuFugoku Docs
Mask

Health

Health check, readiness, and process metrics

Health

Health endpoints monitor the API server status and dependencies.

Health Check

GET /health

Returns basic health status.

Response:

{
  "status": "ok",
  "service": "fugoku-cloud-api",
  "uptime": 3600,
  "timestamp": "2026-07-31T12:00:00Z"
}

Readiness Check

GET /v1/health/ready

Checks database and Redis connectivity.

Response:

{
  "ready": true,
  "checks": {
    "database": "ok",
    "redis": "ok",
    "queue": "ok"
  },
  "timestamp": "2026-07-31T12:00:00Z"
}

Metrics

GET /v1/health/metrics

Returns process memory and uptime metrics.

Response:

{
  "uptime": 3600,
  "memory": {
    "rss": 134217728,
    "heapTotal": 67108864,
    "heapUsed": 33554432,
    "external": 0
  },
  "timestamp": "2026-07-31T12:00:00Z"
}

On this page