Cribl Python API Docs | dltHub

Cribl Stream's REST API Collectors allow data collection from REST endpoints, with options to manage state and generate tasks based on JSON arrays. Key functionalities include managing user access and permissions, and handling log file collections. For detailed API documentation, refer to the official Cribl Stream API reference. The REST API base URL is Cribl Cloud / hybrid (control plane global): https://${workspaceName}-${organizationId}.cribl.cloud/api/v1 On-prem (global): https://${hostname}:${port}/api/v1 Host (worker/edge) context: https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/w/${nodeId} or https://${hostname}:${port}/api/v1/w/${nodeId} Cribl Search (search context): https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/default_search Management plane (Cribl.Cloud): https://gateway.cribl.cloud and all requests (except /auth/login and /health) require a Bearer token (JWT) in Authorization header.

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Cribl data in under 10 minutes.

---

What data can I load from Cribl?

Here are some of the endpoints you can load from Cribl:

---

How do I authenticate with the Cribl API?

Cribl uses Bearer (JWT) tokens. On Cribl.Cloud/hybrid create an API Credential to get client_id and client_secret and exchange them at https://login.cribl.cloud/oauth/token to receive access_token; include as Authorization: Bearer . On on-prem deployments POST /api/v1/auth/login with username/password returns a JSON containing token to use in Authorization header.

1. Get your credentials

Cribl.Cloud / hybrid:

1. In Cribl UI go to Products > Cribl > Organization > API Credentials.
2. Add Credential to get Client ID and Client Secret.
3. POST to https://login.cribl.cloud/oauth/token with grant_type=client_credentials, client_id, client_secret and audience="https://api.cribl.cloud" to receive access_token (24h TTL). On-prem:
4. Use admin username/password.
5. POST to https://{hostname}:{port}/api/v1/auth/login with JSON {"username":"...","password":"..."}; response contains token field.

2. Add them to .dlt/secrets.toml

Copy
[sources.cribl_source]
token = "your_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Cribl API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python cribl_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline cribl_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset cribl_data
The duckdb destination used duckdb:/cribl.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline cribl_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads system/inputs and system/users from the Cribl API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def cribl_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "Cribl Cloud / hybrid (control plane global): https://${workspaceName}-${organizationId}.cribl.cloud/api/v1
On-prem (global): https://${hostname}:${port}/api/v1
Host (worker/edge) context: https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/w/${nodeId} or https://${hostname}:${port}/api/v1/w/${nodeId}
Cribl Search (search context): https://${workspaceName}-${organizationId}.cribl.cloud/api/v1/m/default_search
Management plane (Cribl.Cloud): https://gateway.cribl.cloud",
            "auth": {
                "type": "bearer",
                "token": token,
            },
        },
        "resources": [
            {"name": "system_inputs", "endpoint": {"path": "system/inputs"}},
            {"name": "system_users", "endpoint": {"path": "system/users"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="cribl_pipeline",
        destination="duckdb",
        dataset_name="cribl_data",
    )
    load_info = pipeline.run(cribl_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("cribl_pipeline").dataset()
sessions_df = data.system_inputs.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM cribl_data.system_inputs LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("cribl_pipeline").dataset()
data.system_inputs.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Cribl data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack