Health Diagnostics

August 3, 2026 ยท View on GitHub

Use case

Returns a deeper diagnostic snapshot for operators debugging local or sandbox environments.

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>"
export TENANT_HEADER="x-tenant-id: public"
# Sandbox only:
# export BASE_URL=https://sandbox.hyperswitch.io
# export FEATURE_HEADER="x-feature: decision-engine"

Request

  • Method and path: GET /health/diagnostics
  • Parameters: none.
  • Body: No parameters or request body.

Example

Diagnostics

curl "$BASE_URL/health/diagnostics" \
  --header "$TENANT_HEADER"

Response

{
  "key_custodian_locked": false,
  "database": {
    "database_connection": "Working",
    "database_read": "Working",
    "database_write": "Working",
    "database_delete": "Working"
  }
}

Notes

  • Diagnostics may expose operational details, so production gateways can restrict access at the edge.
  • Use it during setup before testing routing APIs.