Cribl Search API code examples demonstrate how to use the Cribl API directly to complete a task in Cribl Search. Each example describes the steps required to complete a specific task, identifies the endpoints to use, and provides example requests and responses.

The API code examples complement our API Reference and explain common usage scenarios for the Cribl API. If you want to automate an action in Cribl for which you can’t find documentation, ask in the Cribl Community #docs channel.

About Code Examples ​

Code examples use Bearer token authentication. Read the API authentication documentation to learn how to configure authentication. The API Credential that you use to obtain the Bearer token must have the necessary Permissions for the operations in code examples.

Replace the variables in code examples with the corresponding information for your Cribl deployment.

Cribl Search is available only on Cribl.Cloud, so these code examples do not include on-prem deployments.

Code examples do not include all available body parameters. For a complete list of body parameters for specific endpoints, refer to the documentation in the API Reference.

The following Cribl Search API code examples are available:

• Search and Retrieve Results
• Get Alerts for Search Results