CRcriblio
health

Get the health status of the server

Changed on

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

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    • none
    • or HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token

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"
  }
}

Changes

  • e9bef570d106Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

  • 04dbafa36994Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status