GET /health - RAG Support System

Learn more about Mintlify

Enter your email to receive updates about new features and product releases.

The /health endpoint provides a simple health check to verify that the API is running and responsive.

Endpoint

GET /api/v1/health

No request body or parameters required.

status

string

required

Health status of the API. Returns “ok” when the service is healthy.

curl -X GET "http://localhost:8000/api/v1/health"

{
  "status": "ok"
}

The health endpoint is useful for:

Monitoring - Integrate with uptime monitoring tools (Pingdom, UptimeRobot, etc.)
Load balancers - Configure health checks for load balancer routing
Orchestration - Kubernetes liveness and readiness probes
CI/CD - Verify deployment success in automated pipelines
Development - Quick check that the server is running during development

The health endpoint is used in the Docker configuration for container health monitoring:

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:8000/api/v1/health"]
  interval: 30s
  timeout: 10s
  retries: 3

For production deployments, consider implementing more detailed health checks that verify database connectivity and external service availability.

⌘I