On This Page

Home / Cribl as Code/Cribl as Code Quickstart

Cribl as Code Quickstart

Preview Feature

The Cribl SDKs and Terraform provider are Preview features that are still being developed. We do not recommend using them in a production environment, because the features might not be fully tested or optimized for performance, and related documentation could be incomplete.

Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the features remain in Preview.

Cribl as Code is a developer-first experience that includes the Cribl API, SDKs in several languages, and a dedicated Terraform provider.

ComponentDescriptionCapabilities
Cribl APIThe backbone of Cribl as Code. The API documentation includes workflows that demonstrate how to use the API directly for various tasks and the API Reference. You can also access an interactive version of the API Reference by logging in to Cribl.Programmatically configure and manage your Cribl deployment and resources. Build and test new features quickly so that you can iterate more efficiently.
Cribl SDKsA suite of SDKs in Go, Python, and TypeScript. Control plane SDKs provide operational control over Cribl resources. Management plane SDKs focus on administrative tasks like configuring and managing Workspaces.Reduce developer effort, accelerate consistent integrations, and minimize repetitive tasks. Get up and running quickly with language-native clients and code examples.
Terraform providerAn integration that exposes Cribl resources as declarative infrastructure as code (IaC) for Terraform. Documentation is available in the Terraform Registry and the terraform-provider-criblio GitHub repository.Define, provision, and manage a consistent infrastructure across Cribl Organizations and Workspaces. Enable repeatable, versioned, and auditable IaC workflows.

After you authenticate, review the code examples to learn how to use the Cribl Python SDK and the Cribl API for several common use cases.

For more information about Cribl concepts, resources, and features, refer to the Cribl product documentation.