canonical: https://jentic.com/apis/cribl.io/cribl # Cribl API Jentic publishes the only available OpenAPI specification for Cribl API, keeping it validated and agent-ready. Cribl is an observability data platform that includes Stream for routing telemetry, Edge for collection at the source, and Search for federated query across stores. The API gives programmatic access to organisation-level git settings, destinations on Stream, the inventory of Worker and Edge Nodes, edge host metadata, and search jobs, with a version endpoint that surfaces the running build for change-management workflows. ## For AI agents Inspect and configure a Cribl Cloud workspace from outside the UI: list Workers and Edge Nodes, register destinations, browse search jobs, and read git and version metadata. Use it to automate observability pipeline operations. ## Scope Does not handle pipeline rule editing, packs management, or full Cribl-as-code commits - use for workspace inventory and basic destination provisioning only. ## Capabilities - Read the organisation-level git settings that govern Cribl-as-code commits - Register a new destination on Cribl Stream by posting to the system outputs endpoint - List every Worker and Edge Node attached to the workspace's Master node - Pull host metadata for a specific edge node to confirm its environment - List recent search jobs across the workspace for audit and operational triage - Read the running Cribl version and commit history to confirm what is deployed ## Use cases ### Pipeline destination provisioning Add a new destination to Cribl Stream without clicking through the UI by posting the destination configuration to `/system/outputs.` Useful when a platform team is provisioning a fresh downstream sink such as Splunk, S3, or Elasticsearch as part of an infrastructure change ticket. Example prompt: Call POST `/system/outputs` with the destination type, id, and target configuration to register a new Cribl Stream output. ### Worker and Edge fleet audit Audit which Worker and Edge Nodes are reporting in by listing them with GET `/master/workers`, then enriching individual edge entries with GET `/edge/metadata` for host detail. This supports change-management checks before pushing a new commit to the Cribl-as-code repository. Example prompt: Call GET `/master/workers`, then for each suspect node call GET `/edge/metadata` and flag any whose host or environment fields disagree with the deployment manifest. ### Search-job operations dashboard Build a lightweight operations dashboard that lists recent Cribl Search jobs through GET `/search/jobs` alongside the deployed version from GET /version. The dashboard helps the on-call engineer spot stuck jobs and confirm the current build before opening a runbook ticket. Example prompt: Call GET `/search/jobs` and GET /version, then render a table of recent jobs with their state alongside the running version and last commit. ### Agent-driven Cribl operations through Jentic Let an SRE agent answer 'is the new prod-2 worker registered?' by calling GET `/master/workers` via Jentic, without the SRE pasting tokens into the chat. Jentic searches for the worker-list operation, loads its schema, and executes it with the bearer key from the vault. Example prompt: Through Jentic, run search('list cribl worker nodes'), load GET `/master/workers`, and execute it to return the list of attached Worker and Edge Nodes. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/master/workers` | List all Worker and Edge Nodes | | POST | `/system/outputs` | Create a destination on Cribl Stream | | GET | `/system/settings/git-settings` | Retrieve organisation git settings | | GET | `/edge/metadata` | Get host metadata for an edge node | | GET | `/search/jobs` | List search jobs | | GET | `/version` | Get running version and commit history | ## Key resources - **System** — Organisation-level configuration including git settings (`/system/settings/git-settings`) and destination outputs (`/system/outputs`). - **Master** — Worker and Edge Node inventory exposed at `/master/workers.` - **Edge** — Per-edge host metadata at `/edge/metadata.` - **Search** — Search jobs listed at `/search/jobs.` - **Version** — Running version and commit history at /version. ## Why Jentic - **Setup:** Wiring Cribl by hand means resolving your workspace and organization into the cribl.cloud host, managing its bearer token, and mapping worker and output calls yourself. Through Jentic you install once, import Cribl from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** Cribl reads workers and settings and creates outputs through fixed paths and the request body rather than URL resource ids, so scope the agent to the operations it needs, such as listing workers or reading settings. Creating a destination stays out unless you include that operation. - **Credential handling:** Your Cribl Cloud bearer token is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list Cribl workers' or 'create a Cribl destination', and Jentic returns the matching Cribl operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Splunk** — Common destination for Cribl Stream output, often paired for ingest cost control. - **New Relic** — Full-stack observability platform that overlaps with Cribl Search for telemetry queries. - **Elastic Kibana** — Common destination and search front end paired with Cribl-routed log data. ## FAQ ### Why is there no official OpenAPI spec for Cribl API? Cribl documents its API in the cribl-as-code section of its docs but does not distribute a maintained OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cribl API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Cribl API use? The API uses HTTP bearer authentication. Generate a Cribl Cloud token from your workspace and pass it as 'Bearer ' in the Authorization header. Through Jentic, the token is stored encrypted in the vault and applied at execution so it never enters the agent's prompt. ### Can I create a Cribl Stream destination through the API? Yes. POST `/system/outputs` creates a destination in Cribl Stream. Provide the output type and its connection details in the request body and the response includes the registered output's identifier. ### How do I list Worker and Edge Nodes in my Cribl workspace? Call GET `/master/workers` from your workspace's base URL. The response includes every Worker and Edge Node connected to the Master, which is the right entry point for fleet inventory or change-management checks. ### What are the rate limits for the Cribl API? The published OpenAPI spec does not declare numeric rate limits. Cribl Cloud applies workspace-level fair-use limits, so check the response headers and your plan in Cribl Cloud. Build retries with backoff around HTTP 429 responses, particularly on POST `/system/outputs.` ### How do I check my Cribl deployed version through Jentic? Install Jentic with pip install jentic, then async-search for 'get cribl version'. Jentic returns GET /version; load and execute it, and Jentic injects the bearer token from the vault. The response contains the running version and recent commit history. ### Can I limit what my agent is allowed to do with the Cribl API? Yes. Because you run Jentic One yourself, your own rules decide which Cribl operations and credentials the agent can use. Cribl selects operations by fixed paths and request body rather than resource ids, so you can grant read-only calls such as GET `/master/workers` or GET `/system/settings/git-settings` while withholding write access. A destination-creating call like POST `/system/outputs` stays out of reach unless you explicitly include that operation.