Skip to main content

Cancel search job

Action ID: tools.cribl.cancel_search_job Cancel the specified search job (Cribl.Cloud only). Calls POST /search/jobs/{id}/cancel. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Jobs-createSearchJobCancelById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the search job to cancel.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

Clear destination persistent queue

Action ID: tools.cribl.clear_destination_persistent_queue Clear the persistent queue (PQ) for the specified Destination. Queued events that have not been delivered are discarded. Calls DELETE /system/outputs/{id}/pq. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-deleteOutputPqById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Destination to clear the PQ for.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Create commit

Action ID: tools.cribl.create_commit Create a new commit for pending changes to the Cribl configuration. Any merge conflicts indicated in the response must be resolved using Git. Calls POST /version/commit. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Version_Control-createVersionCommit

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

object
required
GitCommitBody object. Documented fields: message (required, commit message), group (Worker Group to commit), files (file paths to include, relative to the configuration root; all pending changes if omitted), effective (apply the commit to the group’s effective configuration).
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

Create destination

Action ID: tools.cribl.create_destination Create a new Destination. Calls POST /system/outputs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-createOutput

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

object
required
Output object. Documented fields include id (required), type (required, the Destination type such as splunk, s3, or webhook), and the type-specific settings of the Output schema for that Destination type.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Create lookup

Action ID: tools.cribl.create_lookup Create a Lookup using either inline content or by referencing a Lookup file previously uploaded with PUT /system/lookups. Calls POST /system/lookups. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Lookups-createLookupFile

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

object
required
LookupFile object. Documented fields: id (required; must match the Lookup file name, including the file extension, for example ip-reputation.csv), description, tags (comma-separated), mode (memory or disk), and either content (inline file content) or fileInfo.filename (temporary file name returned by the upload operation).
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Create pipeline

Action ID: tools.cribl.create_pipeline Create a new Pipeline. Calls POST /pipelines. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Pipelines-createPipelines

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

object
required
Configuration for the Pipeline, including functions and settings. Documented fields: asyncFuncTimeout, output, description, streamtags, functions, groups.
string
required
Unique identifier for the Pipeline.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Create search job

Action ID: tools.cribl.create_search_job Create a new search job to execute a Cribl search query (Cribl.Cloud only). Calls POST /search/jobs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Jobs-createSearchJob

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

object
required
CreateSearchJobSchema object. Documented fields: query (required; begin with the cribl operator, single line), earliest, latest, sampleRate (0 to 1), timezone (IANA identifier), isPrivate, setOptions, numEventsBefore, numEventsAfter, targetEventTime.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

Create source

Action ID: tools.cribl.create_source Create a new Source. The system-managed provenance field (criblSourceProvenance) must be omitted from the request body. Calls POST /system/inputs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Sources-createInput

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

object
required
Input object. Documented fields include id (required), type (required, the Source type such as syslog, splunk_hec, or http), and the type-specific settings of the Input schema for that Source type.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Deploy commit to worker group

Action ID: tools.cribl.deploy_worker_group Deploy commits to the specified Worker Group, Outpost Group, or Edge Fleet. Calls PATCH /products/{product}/groups/{id}/deploy. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Worker_Groups_and_Outpost_Groups-updateProductsGroupsDeployByProductAndId

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the target Worker Group, Outpost Group, or Edge Fleet for commit deployment.
string
required
Name of the Cribl product. Valid values: stream, edge, outpost.
string
required
Commit hash to deploy to the Worker Group, Outpost Group, or Edge Fleet.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

Get collector

Action ID: tools.cribl.get_collector Get the specified Collector. Calls GET /lib/jobs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Collectors-getSavedJobById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Collector to get.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get destination

Action ID: tools.cribl.get_destination Get the specified Destination. Calls GET /system/outputs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-getOutputById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Destination to get.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get destination samples

Action ID: tools.cribl.get_destination_samples Get sample event data for the specified Destination to validate the configuration or test connectivity. Calls GET /system/outputs/{id}/samples. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-getOutputSamplesById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Destination to get sample event data for.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get destination status

Action ID: tools.cribl.get_destination_status Get the status and optional metrics for the specified Destination. Calls GET /system/status/outputs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-getOutputStatusById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Destination to get the status for.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
boolean | null
Set to true to include metrics for each Destination. Otherwise, false (default).Default: null.
boolean | null
Set to true to prefix the Destination id with the Destination type. Otherwise, false (default).Default: null.

Get health

Action ID: tools.cribl.get_health Get the current health status of the server (Leader or Worker Node). Calls GET /health. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-core/#operations-Health-getHealth

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

Get job

Action ID: tools.cribl.get_job Get the specified job. Calls GET /jobs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Jobs-getJobsById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the job to retrieve.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get lookup

Action ID: tools.cribl.get_lookup Get the specified Lookup. Calls GET /system/lookups/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Lookups-getLookupFileById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Lookup to get.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get lookup content

Action ID: tools.cribl.get_lookup_content Get rows from the specified Lookup file as JSON. Calls GET /system/lookups/{id}/content. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Lookups-getLookupFileContentById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Lookup whose file content to get.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of Lookup rows to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.
string | null
Case-insensitive wildcard filter applied to each Lookup row. Matching uses the stringified row values.Default: null.

Get pipeline

Action ID: tools.cribl.get_pipeline Get the specified Pipeline. Calls GET /pipelines/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Pipelines-getPipelinesById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Pipeline to get.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get routing table

Action ID: tools.cribl.get_route Get the specified Routing table. Calls GET /routes/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Routes-getRoutesById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Routing table to get. The supported value is default.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get search job status

Action ID: tools.cribl.get_search_job_status Get execution status details for the specified search job (Cribl.Cloud only). Calls GET /search/jobs/{id}/status. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Jobs-getSearchJobStatusById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the search job to get status for.
boolean | null
If true, include stage-level details, ingestion metrics, and object filter statistics in the response.Default: null.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

Get source

Action ID: tools.cribl.get_source Get the specified Source. Calls GET /system/inputs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Sources-getInputById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Source to get.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Get source status

Action ID: tools.cribl.get_source_status Get the status and optional metrics for the specified Source. Calls GET /system/status/inputs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Sources-getInputStatusById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Source to get the status for.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
boolean | null
Set to true to include metrics for each Source. Otherwise, false (default).Default: null.
boolean | null
Set to true to prefix the Source id with the Source type. Otherwise, false (default).Default: null.

Get version control status

Action ID: tools.cribl.get_version_status Get the status of the current working tree of the Git repository used for Cribl configuration, including modified, staged, untracked, and conflicted files. Calls GET /version/status. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Version_Control-getVersionStatus

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

List branches

Action ID: tools.cribl.list_branches Get a list of all branches in the Git repository used for Cribl configuration. Calls GET /version/branch. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Version_Control-getVersionBranch

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.

List collectors

Action ID: tools.cribl.list_collectors Get a list of all Collectors. Calls GET /lib/jobs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Collectors-getSavedJob

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string | null
Filter by collector type.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of items to return.Default: null.
integer | null
Pagination offset.Default: null.

List datasets

Action ID: tools.cribl.list_datasets Get a list of all Datasets (Cribl.Cloud only). Calls GET /search/datasets. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Datasets-getDataset

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
integer | null
Maximum number of Datasets to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.

List destination statuses

Action ID: tools.cribl.list_destination_statuses List status information and optional metrics for all configured Destinations in the Worker Group or Edge Fleet. Calls GET /system/status/outputs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-getOutputStatus

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of items to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
boolean | null
Set to true to include metrics for each Destination. Otherwise, false (default).Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.
boolean | null
Set to true to prefix the Destination id with the Destination type. Otherwise, false (default).Default: null.

List destinations

Action ID: tools.cribl.list_destinations Get a list of all Destinations. Calls GET /system/outputs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-getOutput

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of items to return.Default: null.
integer | null
Pagination offset.Default: null.
string | null
Type of Destination to include in the results. Each request can include only one type parameter; multiple parameters per request are not supported.Default: null.

List jobs

Action ID: tools.cribl.list_jobs Get a list of all jobs. Calls GET /jobs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Jobs-getJobs

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string | null
The id of the Collector to limit the response to.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
array[string] | null
The id of the job to limit the response to. Repeat for multiple values.Default: null.
integer | null
Maximum number of items to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.
string | null
The job run type to limit the response to.Default: null.
string | null
The current job state to limit the response to.Default: null.

List lookups

Action ID: tools.cribl.list_lookups Get a list of all Lookups. Calls GET /system/lookups. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Lookups-getLookupFile

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string | null
Limit the response to Lookups whose underlying Lookup files have the specified file extension.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of items to return.Default: null.
integer | null
Pagination offset.Default: null.

List notebooks

Action ID: tools.cribl.list_notebooks Get a list of all Notebooks. Calls GET /search/notebooks. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Notebooks-getNotebook

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
array[string] | null
List of id values for Datasets (maximum of 10). Limits the response to only Notebooks that reference the specified Datasets.Default: null.
integer | null
Maximum number of items to return.Default: null.
integer | null
Pagination offset.Default: null.
string | null
Pass short to receive a compact response containing only id, summary info fields, and sectionCount.Default: null.

List pipelines

Action ID: tools.cribl.list_pipelines Get a list of all Pipelines. Calls GET /pipelines. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Pipelines-getPipelines

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of Pipelines to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.

List routes

Action ID: tools.cribl.list_routes Get a list of all Routes. Calls GET /routes. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Routes-getRoutes

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of items to return.Default: null.
integer | null
Pagination offset.Default: null.

List saved searches

Action ID: tools.cribl.list_saved_searches Get a list of all Saved Searches (Cribl.Cloud only). Calls GET /search/saved. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Saved_Searches-getSavedQuery

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
array[string] | null
Return only Saved Searches associated with any of the listed Dataset IDs (maximum 10).Default: null.
integer | null
Maximum number of Saved Searches to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.
string | null
Pass short to receive a compact response containing only list-view fields.Default: null.

List search job results

Action ID: tools.cribl.list_search_job_results List search results, when lower/upper bound is provided, offset is relative to the time range (Cribl.Cloud only). Calls GET /search/jobs/{id}/results. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Jobs-getSearchJobsResultsById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the search job to get results for.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
integer | null
Maximum number of events returned.Default: null.
number | null
Lower bound of the time range, inclusive.Default: null.
integer | null
Starting offset of the events.Default: null.
number | null
Upper bound of the time range, exclusive.Default: null.

List search jobs

Action ID: tools.cribl.list_search_jobs Get a list of all search jobs (Cribl.Cloud only). Supports filtering, sorting, and pagination. Calls GET /search/jobs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Jobs-getSearchJob

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string | null
Filter jobs by earliest time.Default: null.
array[string] | null
Filter by job IDs. Can specify multiple IDs.Default: null.
string | null
Filter jobs by latest time.Default: null.
integer | null
Maximum number of jobs to return. Use with offset to paginate results.Default: null.
integer | null
Starting point from which to retrieve results. Use with limit to paginate results.Default: null.
string | null
Output format. Use short to return abbreviated job information.Default: null.
string | null
Sort direction. Use asc or desc. Defaults to asc.Default: null.
string | null
Sorting expression to evaluate against jobs to specify the sort order.Default: null.
string | null
Filter by job type.Default: null.

List source statuses

Action ID: tools.cribl.list_source_statuses List status information and optional metrics for all configured Sources in the Worker Group or Edge Fleet. Calls GET /system/status/inputs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Sources-getInputStatus

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of items to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
boolean | null
Set to true to include metrics for each Source. Otherwise, false (default).Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.
boolean | null
Set to true to prefix the Source id with the Source type. Otherwise, false (default).Default: null.

List sources

Action ID: tools.cribl.list_sources Get a list of all Sources. Calls GET /system/inputs. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Sources-getInput

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".
integer | null
Maximum number of items to return.Default: null.
integer | null
Pagination offset.Default: null.
string | null
Type of Source to include in the results. Each request can include only one type parameter; multiple parameters per request are not supported.Default: null.

List system messages

Action ID: tools.cribl.list_system_messages Get a list of all Messages. Calls GET /system/messages. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-core/#operations-System_Messages-getBulletinMessage

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
integer | null
Maximum number of Messages to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.

List worker groups

Action ID: tools.cribl.list_worker_groups Get a list of all Worker Groups, Outpost Groups, or Edge Fleets for the specified Cribl product. Calls GET /products/{product}/groups. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Worker_Groups_and_Outpost_Groups-getProductsGroupsByProduct

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
Name of the Cribl product. Valid values: stream, edge, outpost.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string | null
Comma-separated list of additional properties to include in the response. Available values are git.commit, git.localChanges, and git.log.Default: null.
integer | null
Maximum number of Worker Groups, Outpost Groups, or Edge Fleets to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.

Query system metrics

Action ID: tools.cribl.query_system_metrics Query raw system metrics. Calls GET /system/metrics. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-core/#operations-Diagnostics_and_Monitoring-getSystemMetrics

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string | integer | null
Start of the query time range. Accepts a relative time string or a timestamp in Unix time (milliseconds).Default: null.
string | null
Filter expression applied to returned metrics. Supports filtering by dimension values.Default: null.
string | integer | null
End of the query time range. Accepts a relative time string or a timestamp in Unix time (milliseconds).Default: null.
string | array[string] | null
Metric names to filter by. Accepts a regular expression or an array of metric names.Default: null.
string | null
Metrics store namespace. If omitted, uses the default metrics store.Default: null.
integer | null
Number of time buckets to include in the query results.Default: null.
integer | null
Worker Process index to query. Supported only on Worker Nodes.Default: null.

Run search query

Action ID: tools.cribl.run_search_query Run a Search Query and stream the matching events as newline-delimited JSON (NDJSON) (Cribl.Cloud only). Provide exactly one of queryId, jobId, or query together with earliest and latest. Calls GET /search/query. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-search/#operations-Queries-getSearchQuery

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string | number | null
Beginning of the query time range, inclusive, as a relative time string or Unix time in seconds.Default: null.
string | null
The id of an existing Search Job whose results to stream. Provide this instead of query or queryId.Default: null.
string | number | null
End of the query time range, exclusive, as a relative time string or Unix time in seconds.Default: null.
integer | null
Maximum number of events to return in the response for this request. Use with offset to paginate the response into manageable batches.Default: null.
integer | null
Starting point from which to retrieve results for this request. Use with limit to paginate the response into manageable batches.Default: null.
string | null
The Search Query string to run. Requires earliest and latest.Default: null.
string | null
The id of a Saved Query to run. Provide this instead of query or jobId.Default: null.
number | null
Sampling probability between 0 and 1 applied to events during the search.Default: null.
string | null
IANA timezone used to interpret relative time bounds and timestamps.Default: null.
string | integer | null
Time, in milliseconds, to wait after creating a new Search Job before streaming results back to the client.Default: null.

Update destination

Action ID: tools.cribl.update_destination Update the specified Destination. Provide a complete representation of the Destination that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Destination. Calls PATCH /system/outputs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Destinations-updateOutputById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Destination to update.
object
required
Complete Output object. Documented fields include id (required), type (required, the Destination type such as splunk, s3, or webhook), and the type-specific settings of the Output schema for that Destination type.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Update lookup content

Action ID: tools.cribl.update_lookup_content Apply row-level patch operations to the specified Lookup file content. Use this endpoint to add, replace, or remove rows in CSV Lookup files. Database Lookup files cannot be modified through this endpoint. Calls PATCH /system/lookups/{id}/content. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Lookups-updateLookupFileContentById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Lookup whose file content to update.
array[object]
required
LookupFilePatchList: patch operations to apply. Each item has op (add, replace, or remove), value (list of row column values), and rowId (row index).
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Update pipeline

Action ID: tools.cribl.update_pipeline Update the specified Pipeline. Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Calls PATCH /pipelines/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Pipelines-updatePipelinesById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

object
required
Configuration for the Pipeline, including functions and settings. Documented fields: asyncFuncTimeout, output, description, streamtags, functions, groups.
string
required
The id of the Pipeline to update.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".

Update source

Action ID: tools.cribl.update_source Update the specified Source. Provide a complete representation of the Source that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Source. Calls PATCH /system/inputs/{id}. Reference: https://docs.cribl.io/cribl-as-code/api-reference/control-plane/cribl-stream/#operations-Sources-updateInputById

Secrets

Required secrets:
  • cribl_oauth: OAuth token CRIBL_SERVICE_TOKEN.

Input fields

string
required
The id of the Source to update.
object
required
Complete Input object. Documented fields include id (required), type (required, the Source type such as syslog, splunk_hec, or http), and the type-specific settings of the Input schema for that Source type.
string | null
Cribl deployment URL, without /api/v1. For example, https://<workspace>-<organization>.cribl.cloud, or the cribl-gov.cloud equivalent for Cribl.Cloud Government.Default: null.
string
The id of the Worker Group or Edge Fleet whose configuration to use.Default: "default".