Health

Health check endpoints for monitoring and orchestration. These endpoints do not require authentication.

GET /health

Liveness probe. Returns 200 OK if the API server is running.

Example

curl https://api.pii-redactor.dev/api/v1/health

{
  "status": "ok"
}

Use this endpoint for basic uptime monitoring and load balancer health checks.

GET /health/ready

Readiness probe. Returns 200 OK if the API server is running and all dependencies (database, cache, etc.) are reachable.

Example

curl https://api.pii-redactor.dev/api/v1/health/ready

Healthy response (200):

{
  "status": "ok",
  "checks": {
    "database": "ok",
    "cache": "ok"
  }
}

Unhealthy response (503):

{
  "status": "degraded",
  "checks": {
    "database": "ok",
    "cache": "unreachable"
  }
}

Use this endpoint for Kubernetes readiness probes to prevent routing traffic to instances that cannot serve requests.

Kubernetes Configuration

readinessProbe:
  httpGet:
    path: /api/v1/health/ready
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 10
 
livenessProbe:
  httpGet:
    path: /api/v1/health
    port: 8000
  initialDelaySeconds: 3
  periodSeconds: 15