Cribl Edge Pipelines API

openapi: 3.2.0
info:
  title: Cribl Edge Edge Pipelines API
  description: The Cribl Edge API provides programmatic access to Cribl Edge, which extends Stream capabilities to the network edge by deploying lightweight agents on endpoints. The API allows developers to manage edge fleets, configure data collection from endpoints, and control data processing closer to the source. This reduces bandwidth consumption and latency by filtering and transforming data at the point of origin before forwarding it to centralized destinations. Edge API endpoints are accessed through the Cribl Cloud control plane using fleet context paths.
  version: '1.0'
  contact:
    name: Cribl Support
    url: https://cribl.io/support/
  termsOfService: https://cribl.io/terms-of-service/
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: Edge Pipelines
  description: Manage processing pipelines running on edge nodes for local data transformation and filtering before forwarding.
paths:
  /m/{fleetId}/pipelines:
    get:
      operationId: listEdgePipelines
      summary: List edge pipelines in a fleet
      description: Retrieves all processing pipelines configured for an edge fleet for local data transformation on endpoints.
      tags:
      - Edge Pipelines
      parameters:
      - $ref: '#/components/parameters/fleetId'
      responses:
        '200':
          description: Successfully retrieved edge pipelines
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EdgePipeline'
                  count:
                    type: integer
                    description: Total number of pipelines
        '401':
          description: Unauthorized
        '404':
          description: Fleet not found
    post:
      operationId: createEdgePipeline
      summary: Create an edge pipeline in a fleet
      description: Creates a new processing pipeline for an edge fleet to transform data locally on endpoints before forwarding.
      tags:
      - Edge Pipelines
      parameters:
      - $ref: '#/components/parameters/fleetId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EdgePipeline'
      responses:
        '200':
          description: Edge pipeline created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EdgePipeline'
        '400':
          description: Invalid pipeline configuration
        '401':
          description: Unauthorized
components:
  schemas:
    EdgePipeline:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the edge pipeline
        conf:
          type: object
          description: Pipeline configuration object
          properties:
            functions:
              type: array
              description: Ordered list of processing functions
              items:
                type: object
                properties:
                  id:
                    type: string
                    description: The function type identifier
                  filter:
                    type: string
                    description: JavaScript expression to filter events
                  disabled:
                    type: boolean
                    description: Whether this function is disabled
                  conf:
                    type: object
                    description: Function-specific configuration
            description:
              type: string
              description: A human-readable description
  parameters:
    fleetId:
      name: fleetId
      in: path
      required: true
      description: The edge fleet identifier
      schema:
        type: string
  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).
externalDocs:
  description: Cribl Edge Documentation
  url: https://docs.cribl.io/edge/