Strait Docs
API Reference

Health check and metrics endpoints

Liveness check

GET
/health

Response Body

application/json

curl -X GET "http://localhost:8080/health"
{
  "status": "ok"
}

Readiness check

GET
/health/ready

Response Body

application/json

application/json

curl -X GET "http://localhost:8080/health/ready"
{
  "status": "up",
  "components": [
    {
      "name": "string",
      "status": "up",
      "latency_ms": 0,
      "error": "string"
    }
  ]
}
{
  "status": "down",
  "components": [
    {
      "name": "string",
      "status": "up",
      "latency_ms": 0,
      "error": "string"
    }
  ]
}

Prometheus metrics

GET
/metrics

Response Body

text/plain

curl -X GET "http://localhost:8080/metrics"
"string"
Was this page helpful?