Cribl Edge Destinations API

openapi: 3.1.0
info:
  title: Cribl As Code API Credentials Edge Destinations API
  description: The Cribl As Code API enables developers to manage Cribl configurations programmatically using infrastructure-as-code principles. The management plane API provides endpoints for administrative tasks in Cribl Cloud including managing organizations, workspaces, and API credentials. Developers can use this API alongside SDKs for Python, Go, and TypeScript, or through Terraform providers, to onboard sources, build and maintain pipelines, and standardize workflows at scale. The management plane supports creating and configuring Cribl Cloud workspaces, managing API credentials, and controlling access to organizational resources.
  version: '1.0'
  contact:
    name: Cribl Support
    url: https://cribl.io/support/
  termsOfService: https://cribl.io/terms-of-service/
servers:
- url: https://gateway.cribl.cloud
  description: Cribl Cloud Management Plane
security:
- bearerAuth: []
tags:
- name: Edge Destinations
  description: Manage data output destinations for edge nodes including forwarding to Stream workers, cloud storage, and analytics platforms.
paths:
  /m/{fleetId}/system/outputs:
    get:
      operationId: listEdgeDestinations
      summary: List edge destinations in a fleet
      description: Retrieves all data output destinations configured for an edge fleet for forwarding collected and processed data.
      tags:
      - Edge Destinations
      parameters:
      - $ref: '#/components/parameters/fleetId'
      responses:
        '200':
          description: Successfully retrieved edge destinations
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EdgeDestination'
                  count:
                    type: integer
                    description: Total number of destinations
        '401':
          description: Unauthorized
        '404':
          description: Fleet not found
    post:
      operationId: createEdgeDestination
      summary: Create an edge destination in a fleet
      description: Creates a new data output destination for an edge fleet to forward processed data to centralized systems.
      tags:
      - Edge Destinations
      parameters:
      - $ref: '#/components/parameters/fleetId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EdgeDestination'
      responses:
        '200':
          description: Edge destination created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EdgeDestination'
        '400':
          description: Invalid destination configuration
        '401':
          description: Unauthorized
components:
  parameters:
    fleetId:
      name: fleetId
      in: path
      required: true
      description: The edge fleet identifier
      schema:
        type: string
  schemas:
    EdgeDestination:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the edge destination
        type:
          type: string
          description: The destination type such as cribl_http, splunk, s3, syslog, or filesystem
        disabled:
          type: boolean
          description: Whether the destination is disabled
        host:
          type: string
          description: The target host address
        port:
          type: integer
          description: The target port number
        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 from https://login.cribl.cloud/oauth/token. Tokens expire after 24 hours (86400 seconds).
    oauth2:
      type: oauth2
      description: OAuth 2.0 client credentials flow for Cribl Cloud management plane authentication.
      flows:
        clientCredentials:
          tokenUrl: https://login.cribl.cloud/oauth/token
          scopes: {}
externalDocs:
  description: Cribl As Code Documentation
  url: https://docs.cribl.io/cribl-as-code/api/