Cribl

Cribl Routes API

Manage routes that filter and direct incoming data across pipelines and destinations using filter expressions.

Documentation GitHub OpenAPI

Operations 7

GET /routes List all routes #

POST /routes Create a new route #

GET /routes/{id} Get a route by ID #

PATCH /routes/{id} Update a route #

DELETE /routes/{id} Delete a route #

GET /m/{groupId}/routes List Stream routes in a worker group #

POST /m/{groupId}/routes Create a Stream route in a worker group #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cribl-routes-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Cribl Routes API
  version: '1.0'
  contact:
    name: Cribl Support
    url: https://cribl.io/support/
  termsOfService: https://cribl.io/terms-of-service/
  description: 'Operations tagged Routes across 2 of this provider''s published API definitions: cribl-cloud-api-openapi.yml, cribl-stream-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{workspaceName}-{organizationId}.cribl.cloud/api/v1
  description: Cribl Cloud
  variables:
    workspaceName:
      default: default
      description: The name of the Cribl Cloud workspace
    organizationId:
      default: org-id
      description: The Cribl Cloud organization identifier
- url: https://{hostname}:{port}/api/v1
  description: On-Premises Deployment
  variables:
    hostname:
      default: localhost
      description: The hostname of the Cribl instance
    port:
      default: '9000'
      description: The port of the Cribl instance
security:
- bearerAuth: []
tags:
- name: Routes
  description: Manage routes that filter and direct incoming data across pipelines and destinations using filter expressions.
paths:
  /routes:
    get:
      operationId: listRoutes
      summary: List all routes
      description: Retrieves a list of all configured routes that filter and direct incoming data to the appropriate pipelines and destinations.
      tags:
      - Routes
      responses:
        '200':
          description: Successfully retrieved routes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Route'
                  count:
                    type: integer
                    description: Total number of routes
        '401':
          description: Unauthorized
    post:
      operationId: createRoute
      summary: Create a new route
      description: Creates a new route with filter expressions to direct matching events to specified pipelines and destinations.
      tags:
      - Routes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route'
      responses:
        '200':
          description: Route created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
        '400':
          description: Invalid route configuration
        '401':
          description: Unauthorized
    servers:
    - url: https://{workspaceName}-{organizationId}.cribl.cloud/api/v1
      description: Cribl Cloud
      variables:
        workspaceName:
          default: default
          description: The name of the Cribl Cloud workspace
        organizationId:
          default: org-id
          description: The Cribl Cloud organization identifier
    - url: https://{hostname}:{port}/api/v1
      description: On-Premises Deployment
      variables:
        hostname:
          default: localhost
          description: The hostname of the Cribl instance
        port:
          default: '9000'
          description: The port of the Cribl instance
  /routes/{id}:
    get:
      operationId: getRoute
      summary: Get a route by ID
      description: Retrieves the configuration of a specific route including its filter expression, pipeline, and destination assignments.
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Successfully retrieved route
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
        '401':
          description: Unauthorized
        '404':
          description: Route not found
    patch:
      operationId: updateRoute
      summary: Update a route
      description: Updates the configuration of an existing route including its filter expression and pipeline assignments.
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route'
      responses:
        '200':
          description: Route updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
        '400':
          description: Invalid route configuration
        '401':
          description: Unauthorized
        '404':
          description: Route not found
    delete:
      operationId: deleteRoute
      summary: Delete a route
      description: Deletes a route by its unique ID.
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Route deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Route not found
    servers:
    - url: https://{workspaceName}-{organizationId}.cribl.cloud/api/v1
      description: Cribl Cloud
      variables:
        workspaceName:
          default: default
          description: The name of the Cribl Cloud workspace
        organizationId:
          default: org-id
          description: The Cribl Cloud organization identifier
    - url: https://{hostname}:{port}/api/v1
      description: On-Premises Deployment
      variables:
        hostname:
          default: localhost
          description: The hostname of the Cribl instance
        port:
          default: '9000'
          description: The port of the Cribl instance
  /m/{groupId}/routes:
    get:
      operationId: listStreamRoutes
      summary: List Stream routes in a worker group
      description: Retrieves all routes configured within a worker group context that filter and direct incoming data to pipelines and destinations.
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/groupId'
      responses:
        '200':
          description: Successfully retrieved routes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Route_2'
                  count:
                    type: integer
                    description: Total number of routes
        '401':
          description: Unauthorized
        '404':
          description: Worker group not found
    post:
      operationId: createStreamRoute
      summary: Create a Stream route in a worker group
      description: Creates a new route within a worker group to filter and direct incoming events to specified pipelines and destinations.
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/groupId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route_2'
      responses:
        '200':
          description: Route created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route_2'
        '400':
          description: Invalid route configuration
        '401':
          description: Unauthorized
    servers:
    - url: https://{workspaceName}-{organizationId}.cribl.cloud/api/v1
      description: Cribl Cloud
      variables:
        workspaceName:
          default: default
          description: The name of the Cribl Cloud workspace
        organizationId:
          default: org-id
          description: The Cribl Cloud organization identifier
    - url: https://{hostname}:{port}/api/v1
      description: On-Premises Deployment
      variables:
        hostname:
          default: localhost
          description: The hostname of the Cribl instance
        port:
          default: '9000'
          description: The port of the Cribl instance
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
    groupId:
      name: groupId
      in: path
      required: true
      description: The worker group or fleet identifier
      schema:
        type: string
  schemas:
    Route:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the route
        name:
          type: string
          description: Display name for the route
        filter:
          type: string
          description: JavaScript filter expression that determines which events match this route
        pipeline:
          type: string
          description: The pipeline ID to process matching events
        output:
          type: string
          description: The destination ID for processed events
        final:
          type: boolean
          description: Whether matching events stop being evaluated by subsequent routes
        disabled:
          type: boolean
          description: Whether this route is disabled
        description:
          type: string
          description: A human-readable description of the route
        groups:
          type: object
          description: Group-specific route configuration
    Route_2:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the route
        name:
          type: string
          description: Display name for the route
        filter:
          type: string
          description: JavaScript filter expression for matching events
        pipeline:
          type: string
          description: The pipeline ID for processing matched events
        output:
          type: string
          description: The destination ID for processed events
        final:
          type: boolean
          description: Whether matched events stop further evaluation
        disabled:
          type: boolean
          description: Whether this route is disabled
        description:
          type: string
          description: A human-readable description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained via OAuth 2.0 client credentials grant (Cribl Cloud) or the /auth/login endpoint (on-premises).
    oauth2:
      type: oauth2
      description: OAuth 2.0 client credentials flow for Cribl Cloud authentication. Tokens expire after 24 hours.
      flows:
        clientCredentials:
          tokenUrl: https://login.cribl.cloud/oauth/token
          scopes: {}
x-refined-from:
- cribl-cloud-api-openapi.yml
- cribl-stream-api-openapi.yml