Health & Status¶

Operational endpoints for monitoring service health. These endpoints do not require authentication.

Health Check¶

GET /health

Returns the basic service status.

Response:

{
  "status": "ok",
  "service": "invoicepdfs-api",
  "version": "0.1.0"
}

Try it

Readiness Check¶

GET /ready

Checks that all dependencies (database, storage, renderer) are operational. Use this endpoint for load balancer health checks.

Response (all healthy):

{
  "status": "ready",
  "dependencies": {
    "database": "ok",
    "storage": "ok",
    "renderer": "ok"
  }
}

Response (degraded):

{
  "status": "not_ready",
  "dependencies": {
    "database": "ok",
    "storage": "error",
    "renderer": "ok"
  }
}

Try it

Version¶

GET /version

Returns the current API version.

Response:

{
  "version": "0.1.0"
}

Try it

Usage Notes¶

Endpoint	Auth Required	Use Case
`GET /health`	No	Quick liveness probe (Kubernetes, Docker)
`GET /ready`	No	Readiness probe — checks all dependencies
`GET /version`	No	Version detection for client libraries

Monitoring

Point your uptime monitor at /ready rather than /health. The readiness endpoint verifies that the database and storage layer are reachable, catching issues that a simple liveness check would miss.