Cribl

Cribl Edge Fleets API

Manage edge fleets that organize groups of edge nodes deployed on endpoints for local data collection and processing.

Documentation GitHub OpenAPI

Operations 6

GET /master/groups List all edge fleets #

POST /master/groups Create a new edge fleet #

GET /master/groups/{id} Get an edge fleet by ID #

PATCH /master/groups/{id} Update an edge fleet #

DELETE /master/groups/{id} Delete an edge fleet #

POST /master/groups/{id}/deploy Deploy configuration to an edge fleet #

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-edge-fleets-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 Edge Edge Fleets 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.
  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 Fleets
  description: Manage edge fleets that organize groups of edge nodes deployed on endpoints for local data collection and processing.
paths:
  /master/groups:
    get:
      operationId: listEdgeFleets
      summary: List all edge fleets
      description: Retrieves all edge fleets configured in the deployment. Edge fleets organize edge nodes and allow deploying shared configurations to groups of endpoint agents.
      tags:
      - Edge Fleets
      parameters:
      - name: product
        in: query
        description: Filter by product type to show only edge fleets
        schema:
          type: string
          enum:
          - edge
      responses:
        '200':
          description: Successfully retrieved edge fleets
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EdgeFleet'
                  count:
                    type: integer
                    description: Total number of edge fleets
        '401':
          description: Unauthorized
    post:
      operationId: createEdgeFleet
      summary: Create a new edge fleet
      description: Creates a new edge fleet for organizing and managing a group of edge nodes deployed on endpoint systems.
      tags:
      - Edge Fleets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EdgeFleet'
      responses:
        '200':
          description: Edge fleet created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EdgeFleet'
        '400':
          description: Invalid fleet configuration
        '401':
          description: Unauthorized
  /master/groups/{id}:
    get:
      operationId: getEdgeFleet
      summary: Get an edge fleet by ID
      description: Retrieves the configuration and status of a specific edge fleet including its node count and deployment state.
      tags:
      - Edge Fleets
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Successfully retrieved edge fleet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EdgeFleet'
        '401':
          description: Unauthorized
        '404':
          description: Edge fleet not found
    patch:
      operationId: updateEdgeFleet
      summary: Update an edge fleet
      description: Updates the configuration of an existing edge fleet including its name, description, and deployment settings.
      tags:
      - Edge Fleets
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EdgeFleet'
      responses:
        '200':
          description: Edge fleet updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EdgeFleet'
        '400':
          description: Invalid fleet configuration
        '401':
          description: Unauthorized
        '404':
          description: Edge fleet not found
    delete:
      operationId: deleteEdgeFleet
      summary: Delete an edge fleet
      description: Deletes an edge fleet by its unique ID. Connected edge nodes will be disconnected.
      tags:
      - Edge Fleets
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Edge fleet deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Edge fleet not found
  /master/groups/{id}/deploy:
    post:
      operationId: deployEdgeFleet
      summary: Deploy configuration to an edge fleet
      description: Deploys the current configuration to all edge nodes in the specified fleet, pushing updated sources, pipelines, and routes to endpoints.
      tags:
      - Edge Fleets
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Deployment initiated successfully
        '401':
          description: Unauthorized
        '404':
          description: Edge fleet not found
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
  schemas:
    EdgeFleet:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the edge fleet
        name:
          type: string
          description: Display name for the edge fleet
        description:
          type: string
          description: A human-readable description
        isFleet:
          type: boolean
          description: Indicates this is an edge fleet
        workerCount:
          type: integer
          description: Number of connected edge nodes
        configVersion:
          type: string
          description: The current deployed configuration version
        tags:
          type: object
          description: Key-value tags for organizing fleets
  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/