Health Check API

Readiness Check

Check if the application is ready to serve requests.

Endpoint: GET /api/ready

Response: 200 OK

{
  "status": "ready",
  "timestamp": "2024-10-24T12:00:00.000Z",
  "checks": [
    {
      "name": "database",
      "status": "healthy",
      "responseTime": 5
    },
    {
      "name": "geonet_api",
      "status": "healthy",
      "message": "Circuit breaker is CLOSED"
    },
    {
      "name": "memory",
      "status": "healthy",
      "message": "Heap: 120MB / 512MB (23%)"
    }
  ],
  "responseTime": "12ms"
}

Error Response: 503 Service Unavailable

{
  "status": "not_ready",
  "timestamp": "2024-10-24T12:00:00.000Z",
  "checks": [
    {
      "name": "database",
      "status": "unhealthy",
      "message": "Database connection failed"
    }
  ],
  "responseTime": "5ms"
}