health API
Sign in with GitHub

health

Infrastructure health check endpoints for monitoring and orchestration. No authentication required (unless HEALTH_TOKEN is configured).

GET /api/health

Basic health check

Auth: None (or HEALTH_TOKEN if configured)

Responses

200 Service is healthy
status
- ok

Example

Request 
curl https://api.tripswitch.dev/api/health
Response 
{
  "status": "ok"
}
GET /api/healthz

Kubernetes liveness probe

Auth: None (or HEALTH_TOKEN if configured)

Responses

200 Service is alive
status
- ok

Example

Request 
curl https://api.tripswitch.dev/api/healthz
Response 
{
  "status": "ok"
}
HEAD /api/healthz

Kubernetes liveness probe (headers only)

Auth: None (or HEALTH_TOKEN if configured)

Responses

200 Service is alive (no body)

Example

Request 
curl -I https://api.tripswitch.dev/api/healthz
Response 
HTTP/2 200
Content-Type: application/json
GET /api/readyz

Kubernetes readiness probe

Auth: None (or HEALTH_TOKEN if configured)

Responses

200 Service is ready to accept traffic
status
- ok
503 Service is not ready

Example

Request 
curl https://api.tripswitch.dev/api/readyz
Response 
{
  "status": "ok"
}
HEAD /api/readyz

Kubernetes readiness probe (headers only)

Auth: None (or HEALTH_TOKEN if configured)

Responses

200 Service is ready (no body)
503 Service is not ready

Example

Request 
curl -I https://api.tripswitch.dev/api/readyz
Response 
HTTP/2 200
Content-Type: application/json
← All API resources