These docs are for Cribl Api 4.8 and are no longer actively maintained.

See the latest version (4.13).

Query the Health Endpoint

Each Cribl Stream and Cribl Edge instance exposes a /health endpoint that provides information about the status of the server. This endpoint is commonly used with a load balancer to support operational decision-making.

You do not need to authenticate to the API to send a request to the /health endpoint.

About the Example Request

​

Replace the variables in the example request with the corresponding information for your Cribl deployment.

For customer-managed deployments, to use https in the URL for your request as shown in this example, you must configure Transport Layer Security (TLS).

Retrieve Server Status Information

​

The following example demonstrates a request to the /health endpoint for a Leader Node on Cribl.Cloud and a customer-managed deployment. See Base URLs to learn how to construct the request URL for your Cribl deployment. Replace the variables in the URL with the correct values for your deployment.

curl --request GET \
--url 'https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/health' \
--header 'accept: application/json'

curl --request GET \
--url 'https://${hostname}:${port}/api/v1/health' \
--header 'accept: application/json'

The response is a JSON object similar to the following example:

{"status": "healthy","startTime": 1741961168122}

Interpret HTTP Status Codes

​

In the response header, the /health endpoint returns one of the following HTTP status codes:

The HTTP status code 200 OK is a healthy response but indicates only that the server is running. It does not mean that all of the instance’s configured Sources are functioning correctly.

Several HTTP-based Sources allow you to enable a Source-level health check endpoint in their Advanced Settings. See the documentation for each Source for more information.