Cribl API

The Cribl API is a RESTful API that provides a centrally managed control plane for programmatically configuring and managing Cribl resources. Developers can use the API to:

• Retrieve and manage data.
• Automate repetitive manual processes.
• Integrate with third-party applications.
• Consistently replicate environments and resources for testing, development, and deployment.

The Cribl API generally follows a resource-based structure in which each endpoint corresponds with a specific Cribl resource or collection of resources. In request URLs, resource-specific paths branch off from the base URL.

Read the Authentication page to learn how to authenticate to the Cribl API.

About PATCH Requests

​

In the Cribl API for the control plane, PATCH requests require a complete representation of the resource that you want to update. Endpoints that use the PATCH method do not support partial updates. Cribl removes any omitted fields when updating the resource. If you use a GET request to retrieve an existing configuration to use in the body of a PATCH request, confirm that the configuration is correct. If the existing configuration is incorrect, the updated resource may not function as expected. The Update Configurations workflow provides an example for updating a Destination using the PATCH method.

The Cribl API for the management plane does support partial updates for endpoints that use the PATCH method.

Try It Out

​

The API Reference is also available in Cribl at Settings > Global > API Reference. We recommend using the in-product API Reference because it features a Try it out button for each endpoint that you can use to construct and execute a curl command and examine the response. The in-product API Reference aligns with your environment and provides a seamless testing experience.

At the top of the in-product API Reference, a Servers drop-down menu lists the base URLs associated with your Stream Leader and Worker Groups, Edge Fleets, and Search instance. Try it out commands use the base URL that you select from the Servers drop-down menu. The default selection in the Servers drop-down is the base URL for your Leader.

Base URLs

​

The base URL is the root address for making requests to the Cribl API. The standardized base URL format provides a consistent, predictable pattern.

Follow the format examples in this section to construct the base URL for your Cribl deployment. The correct base URL depends on whether you’re using Cribl.Cloud or a customer-managed deployment, as well as whether the target endpoint operates in the global, Group/Fleet or Host, or Cribl Search context.

To compose the complete URL for a request to a specific endpoint, append the endpoint path that is listed in the API Reference to the base URL.

Global Context

​

For API requests to endpoints that apply to the entire Workspace or Organization (on Cribl.Cloud) or instance (in customer-managed deployments), use the base URL for global requests. Examples of requests with a global scope include managing feature settings and resources outside of the context of a specific Worker Group or Fleet.

On Cribl.Cloud, the base URL format for global requests for Cribl Stream, Edge, and Lake endpoints is:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1

Customers who manage their own single-instance deployments use the following base URL format for global requests:

https://${hostname}:${port}/api/v1

For example, to send a request to the GET /system/settings/git-settings endpoint to retrieve the git settings for the Organization or instance, the complete URL is:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/system/settings/git-settings

https://${hostname}:${port}/api/v1/system/settings/git-settings

Group/Fleet or Host Context

​

Some endpoints operate in the context of a specific Worker Group or Edge Fleet or host (Worker or Edge Node). In these cases, the base URL format includes additional URL segments that identify the context and the particular Group/Fleet or Node.

Base URL for the Group or Fleet Context

​

For requests that are specific to a Worker Group or Edge Fleet, the base URL includes the /m context indicator and the name of the target Worker Group or Fleet:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/${groupName}

https://${hostname}:${port}/api/v1/m/${groupName}

If your license is limited to a single Worker Group, the groupName is always default.

For example, to send a request to the POST /system/outputs endpoint to create a Destination for the Worker Group myDevGroup, the complete URL is:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/myDevGroup/system/outputs

https://${hostname}:${port}/api/v1/m/myDevGroup/system/outputs

Base URL for the Host Context

​

For requests that are specific to a certain host (Worker or Edge Node), the base URL includes the /w context indicator and the ID of the target Worker or Edge Node:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/w/${nodeId}

https://${hostname}:${port}/api/v1/w/${nodeId}

To get the nodeId, send a request to the GET /master/workers endpoint using the global context for the base URL. The response lists detailed metadata for all Worker and Edge Nodes that the Leader manages. Use the id value for the desired Node as the nodeId in the request URL.

For example, to send a request to the GET /edge/metadata endpoint for the Edge Node abc123a9-ea69-4066-b295-456defb55784, the complete URL is:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/w/abc123a9-ea69-4066-b295-456defb55784/edge/metadata

https://${hostname}:${port}/api/v1/w/abc123a9-ea69-4066-b295-456defb55784/edge/metadata

Cribl Search Context

​

For Cribl Search endpoints, the base URL includes /m and default_search:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/default_search

For example, for a request to the GET /search/jobs endpoint, the complete URL is:

https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/default_search/search/jobs

Path Parameters

​

Many Cribl API endpoints require to you provide path parameters. Most path parameters are used to specify individual resources. For example, in the endpoint GET /pack/{id}, the {id} identifies the specific Cribl Pack to retrieve.

For some endpoints, path parameters limit the scope of the request in some way. For example, in the endpoint GET /products/{product}/groups, the {product} path parameter indicates the Cribl product whose Worker Groups or Edge Fleets should be listed in the response. In another example, GET /p/{pack}/pipelines, the {pack} path parameter limits the response to Pipelines within the specified Pack.

The API Reference identifies and describes the path parameters for each endpoint.

Query Parameters

​

Some Cribl API endpoints support optional query parameters for filtering or modifying the response. For example, endpoints that return a list of objects can have lengthy responses, so they might support limit and offset query parameters to use for paginating the response. Other endpoints might support query parameters that allow you to specify additional properties to include in the response or a JavaScript expression to apply as a filter.

The API Reference identifies and describes the supported query parameters for each endpoint.

Request Size Limit

​

The size limit for requests to the Cribl API is 5 MB.

Media Types

​

For endpoints that require a request body (typically POST, PUT, and PATCH), the server expects a valid Content-Type request header that specifies the media type of the request body. In this example request, the Content-Type value is application/json:

curl --request POST \
--url 'https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/default_search/search/jobs' \
--header 'Authorization: Bearer ${token}' \
--header 'Content-Type: application/json' \
--data '{
  "query": "cribl dataset=\"goatherd_sample_dataset\" | limit 1000",
  "earliest": "-1h",
  "latest": "now",
  "sampleRate": 1
}'

If the request omits the Content-Type header or the value does not match the supported media type for the endpoint, the server might return an error.

For most POST, PUT, and PATCH endpoints in the Cribl API, the media type for the request body is application/json. Some endpoints support other media types, such as application/x-ndjson or application/x-www-form-urlencoded. The API Reference specifies the supported media type for each endpoint in the Request body drop-down list.

The API Reference also specifies the media type for each endpoint’s responses, which is helpful for ensuring proper data processing.

HTTP Status Codes

​

The Cribl API can return the following HTTP status codes in response headers:

See the MDN Web Docs for more information about HTTP status codes.