Cribl API ReferenceOAS3
This API Reference lists the available endpoints in the Cribl API. Select a category (or tag) to see the endpoints it contains. Select an endpoint to see details like required and optional parameters and request and response examples.
Try It Out
This API Reference is also available in Cribl at Settings > Global > API Reference. We recommend using the in-product API Reference because it 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. Each endpoint features a Try it out button that you can use to construct and execute a curl command and examine the response. 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. Follow the format examples in this section to construct the base URL for your Cribl deployment.
To compose the complete URL for a request to a specific endpoint, append the endpoint path that is listed in this API Reference to your base URL (for example, https://myapp.goatfarm.com:3000/api/v1/m/devgroup/routes).
Base URLs on Cribl.Cloud
On Cribl.Cloud, the base URL format for Cribl Stream, Edge, and Lake endpoints is:
https://${workspaceName}-${organizationId}.cribl.cloud/api/v1For requests that are specific to a certain Worker Group or Fleet, the base URL includes /m and the name of the Worker Group or Fleet:
https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/${groupName}For Cribl Search endpoints, the base URL includes /m and default_search:
https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/default_searchBase URLs in Customer-Managed Deployments
Customers who manage their own single-instance deployments use the following base URL format:
https://${hostname}:${port}/api/v1In Distributed deployments that are customer-managed, the base URL includes /m and the name of the Worker Group (Stream) or Fleet (Edge):
https://${hostname}:${port}/api/v1/m/${groupName}