Toast
API Reference

Health

Liveness and readiness probes for orchestrator health checks.

Liveness check

GET
/healthz

Basic liveness endpoint to verify the service is running.

Response Body

Service is running

application/json
  1. response
status*string
Value in"ok""error"
Example Request
curl -X GET 'https://example.com/healthz'
Example Response200
{  "status": "ok"}

Readiness check

GET
/healthz/ready

Checks database connectivity to determine if service is ready to handle requests.

Response Body

Service is ready

application/json
  1. response
status*"ok"
Value in"ok"
database*"connected"
Value in"connected"
Example Request
curl -X GET 'https://example.com/healthz/ready'
Example Response
{  "status": "ok",  "database": "connected"}