Skip to content

Health Check API

Health routes provide service liveness information.

API call order

GET /health can be called any time (no auth/token prerequisite).

Shared request setup is documented once in API index.

Health check

GET /health

Liveness probe endpoint.

"status" keeps its exact value and shape: the ALB target group health check and the post-deploy verification both read it. The build identity is additive, and every value falls back to "unknown" rather than raising when the variable is not set. "agents_ref" is the eve-esa-agents git ref baked into the image.

Returns:

Name Type Description
dict

Service health plus the identity of the running build.

Usage

resp = requests.get(
    f"{BASE_URL}/health",
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Explanation

Returns a status payload for liveness checks, plus the identity of the running build:

{
  "status": "healthy",
  "version": "v0.1.0",
  "commit": "1a2b3c4",
  "environment": "prod",
  "agents_ref": "v0.5.4"
}

Notes

  • Commonly used by load balancers and uptime monitors.
  • Does not require authentication.
  • status is the only field the ALB health check and the deploy verification read, and its value never changes.
  • commit is baked into the image at build time, version is injected at deploy time. Either reads unknown when the corresponding variable is not set, for example in local development.
  • agents_ref is the eve-esa-agents git ref baked into the image at build time. Dev reports a commit SHA of agents main. Staging and prod report the tag from agents.ref.

Full API reference

For exhaustive schema details, use Swagger API.