Health Checks

The Intelligence Hub exposes HTTP endpoints that can be used by load balancers, orchestration platforms, or monitoring tools to check the health and availability of the hub.

Liveness

The /v2/livez endpoint returns an HTTP 200 response when the hub application is live. Use this endpoint to determine whether the hub process is running and responsive.

Readiness

The /v2/readyz endpoint returns an HTTP 200 response when the hub is ready to receive network traffic. Use this endpoint to determine when the hub is fully initialized and available to handle requests.

Endpoint Behavior by Deployment Mode

The response from each endpoint depends on how the hub is deployed.

In High Availability mode, the readyz endpoint returns 503 on secondary nodes to indicate they are live but not ready to receive traffic. This allows load balancers to route requests only to the primary node.

Response Body

Both endpoints return a JSON response body containing a deployment object that describes the current node’s deployment context.

Standalone example:

{
  "deployment": {
    "mode": "standalone"
  }
}

High Availability example:

{
  "deployment": {
    "mode": "ha",
    "role": "primary",
    "nodeId": "node-1",
    "primaryNodeId": "node-1"
  }
}