Cribl

Cribl Collectors API

Manage scheduled and on-demand data collection jobs from REST APIs, databases, scripts, and other sources.

Documentation GitHub OpenAPI

Operations 5

GET /system/collectors List all collectors #

POST /system/collectors Create a new collector #

GET /system/collectors/{id} Get a collector by ID #

PATCH /system/collectors/{id} Update a collector #

DELETE /system/collectors/{id} Delete a collector #

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-collectors-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 Collectors API
  version: '1.0'
  contact:
    name: Cribl Support
    url: https://cribl.io/support/
  termsOfService: https://cribl.io/terms-of-service/
  description: 'Operations tagged Collectors 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: Collectors
  description: Manage scheduled and on-demand data collection jobs from REST APIs, databases, scripts, and other sources.
paths:
  /system/collectors:
    get:
      operationId: listCollectors
      summary: List all collectors
      description: Retrieves a list of all configured data collectors including REST API collectors, database collectors, and script collectors.
      tags:
      - Collectors
      responses:
        '200':
          description: Successfully retrieved collectors
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Collector'
                  count:
                    type: integer
                    description: Total number of collectors
        '401':
          description: Unauthorized
    post:
      operationId: createCollector
      summary: Create a new collector
      description: Creates a new data collector with the specified type, schedule, and configuration for automated data collection.
      tags:
      - Collectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Collector'
      responses:
        '200':
          description: Collector created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collector'
        '400':
          description: Invalid collector 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
  /system/collectors/{id}:
    get:
      operationId: getCollector
      summary: Get a collector by ID
      description: Retrieves the configuration and status of a specific data collector identified by its unique ID.
      tags:
      - Collectors
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Successfully retrieved collector
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collector'
        '401':
          description: Unauthorized
        '404':
          description: Collector not found
    patch:
      operationId: updateCollector
      summary: Update a collector
      description: Updates the configuration of an existing data collector.
      tags:
      - Collectors
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Collector'
      responses:
        '200':
          description: Collector updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collector'
        '400':
          description: Invalid collector configuration
        '401':
          description: Unauthorized
        '404':
          description: Collector not found
    delete:
      operationId: deleteCollector
      summary: Delete a collector
      description: Deletes a data collector by its unique ID.
      tags:
      - Collectors
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Collector deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Collector 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
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
  schemas:
    Collector:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the collector
        type:
          type: string
          description: The collector type such as rest, script, database, or s3
        schedule:
          type: object
          description: The collection schedule configuration
          properties:
            cronSchedule:
              type: string
              description: Cron expression for scheduled collection
            enabled:
              type: boolean
              description: Whether the schedule is enabled
        conf:
          type: object
          description: Collector-specific configuration
        description:
          type: string
          description: A human-readable description of the collector
    Collector_2:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the collector
        type:
          type: string
          description: The collector type such as rest, script, or database
        schedule:
          type: object
          description: The collection schedule configuration
          properties:
            cronSchedule:
              type: string
              description: Cron expression for scheduled collection
            enabled:
              type: boolean
              description: Whether the schedule is enabled
        conf:
          type: object
          description: Collector-specific configuration
        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