Health Ready
August 3, 2026 ยท View on GitHub
Use case
Checks whether the service is ready to receive traffic, including critical dependency checks.
Authentication
Public. No JWT or API key is required. Sandbox traffic may still include x-feature: decision-engine when routed through Hyperswitch.
For local development, start with:
export BASE_URL=http://localhost:8080
export AUTH_HEADER="Authorization: Bearer <jwt_token>"
# Sandbox only:
# export BASE_URL=https://sandbox.hyperswitch.io
# export FEATURE_HEADER="x-feature: decision-engine"
Request
- Method and path:
GET /health/ready - Parameters: none.
- Body: No parameters or request body.
Example
Readiness check
curl "$BASE_URL/health/ready"
Response
{
"message": "Up"
}
Notes
- Use this for container readiness probes.
- A dependency failure should mark readiness unhealthy without changing the basic
/healthresponse.