Sign in

v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011189403.1 MB
health

Get the health status of the server

Get the current health status of the server (Leader or Worker Node). In Distributed deployments, requests routed to a Worker or Edge node using the host context require a Bearer token for authentication.

get/health

Response

Healthy status

isCaptainboolean

Whether this node is currently the captain (job scheduling coordinator) in a Collectors HA deployment.

role'primary' | 'standby'

Leader Node role: <code>primary</code> or <code>standby</code>.

startTimeinteger required

Timestamp (in Unix time) when the Cribl process started.

status'healthy' | 'shutting down' | 'standby' required

Health state: <code>healthy</code>, <code>standby</code>, or <code>shutting down</code>.

Example response

{
  "overlay": {
    "state": "active"
  }
}