Skip to content

Health Endpoints

JSON Health — /health

Returns detailed status in JSON format:

curl http://localhost:8080/health

When credential scopes are configured, pass the same API key you use for model requests to see that key's credential view:

curl -H "Authorization: Bearer sk-your-key" http://localhost:8080/health

Response includes:

  • Status of visible credentials (RPM/TPM usage, ban status)
  • Exact chained scope rules in scope_expression. Alternatives are OR branches; every requirement group inside one alternative must have at least one matching request scope. scopes and denied_scopes remain for legacy readers. Exact chained enforcement requires scope_expression support on every router in the chain.
  • Status of visible configured models
  • Aggregated statistics from connected proxy instances

Example:

curl http://localhost:8080/health | jq '.credentials'

HTML Dashboard — /vhealth

An interactive HTML dashboard showing the same information in a visual format:

http://localhost:8080/vhealth

vhealth dashboard

Notes

  • Health endpoints do not require authentication. Missing, invalid, or temporarily unverifiable API keys use the public view, which only includes credentials without scopes
  • The /health path is hardcoded and cannot be reconfigured
  • Proxy credential statistics, model metadata, and provider scopes are synced from remote /health endpoints every 30 seconds