Cribl

Cribl Worker Groups API

Manage Stream worker groups that organize worker nodes and deploy shared pipeline configurations across clusters.

Documentation GitHub OpenAPI

Operations 3

GET /master/groups List all Stream worker groups #

POST /master/groups Create a worker group #

POST /master/groups/{id}/deploy Deploy configuration to 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-worker-groups-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 Stream Worker Groups API
  description: The Cribl Stream API provides programmatic access to Cribl Stream, an observability pipeline platform that processes and routes telemetry data in real time.
  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: Worker Groups
  description: Manage Stream worker groups that organize worker nodes and deploy shared pipeline configurations across clusters.
paths:
  /master/groups:
    get:
      operationId: listWorkerGroups
      summary: List all Stream worker groups
      description: Retrieves all worker groups configured for Stream deployments including their node counts and configuration versions.
      tags:
      - Worker Groups
      responses:
        '200':
          description: Successfully retrieved worker groups
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkerGroup'
                  count:
                    type: integer
                    description: Total number of worker groups
        '401':
          description: Unauthorized
    post:
      operationId: createWorkerGroup
      summary: Create a worker group
      description: Creates a new Stream worker group for organizing and deploying configurations to a set of worker nodes.
      tags:
      - Worker Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkerGroup'
      responses:
        '200':
          description: Worker group created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerGroup'
        '400':
          description: Invalid group configuration
        '401':
          description: Unauthorized
  /master/groups/{id}/deploy:
    post:
      operationId: deployWorkerGroup
      summary: Deploy configuration to a worker group
      description: Deploys the current configuration to all worker nodes in the specified group, making configuration changes effective.
      tags:
      - Worker Groups
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Deployment initiated successfully
        '401':
          description: Unauthorized
        '404':
          description: Worker group not found
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
  schemas:
    WorkerGroup:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the worker group
        name:
          type: string
          description: Display name for the worker group
        description:
          type: string
          description: A human-readable description
        workerCount:
          type: integer
          description: Number of connected worker nodes
        configVersion:
          type: string
          description: The current deployed configuration version
        tags:
          type: object
          description: Key-value tags for organizing groups
  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 Stream Documentation
  url: https://docs.cribl.io/stream/