Cribl Edge Nodes API

openapi: 3.2.0
info:
  title: Cribl Edge Edge Nodes 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 Nodes
  description: Monitor and manage individual edge nodes deployed on endpoints including their status, version, and resource utilization.
paths:
  /master/workers:
    get:
      operationId: listEdgeNodes
      summary: List all edge nodes
      description: Retrieves all connected edge nodes across all fleets including their status, OS, version, and resource utilization metrics.
      tags:
      - Edge Nodes
      responses:
        '200':
          description: Successfully retrieved edge nodes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EdgeNode'
                  count:
                    type: integer
                    description: Total number of edge nodes
        '401':
          description: Unauthorized
  /master/workers/{id}:
    get:
      operationId: getEdgeNode
      summary: Get an edge node by ID
      description: Retrieves the status and details of a specific edge node including its OS, version, fleet membership, and resource utilization.
      tags:
      - Edge Nodes
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Successfully retrieved edge node
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EdgeNode'
        '401':
          description: Unauthorized
        '404':
          description: Edge node not found
  /master/workers/{id}/restart:
    post:
      operationId: restartEdgeNode
      summary: Restart an edge node
      description: Initiates a restart of a specific edge node agent on the endpoint system.
      tags:
      - Edge Nodes
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Restart initiated successfully
        '401':
          description: Unauthorized
        '404':
          description: Edge node not found
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
  schemas:
    EdgeNode:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the edge node
        hostname:
          type: string
          description: The endpoint hostname
        group:
          type: string
          description: The fleet the node belongs to
        version:
          type: string
          description: The Cribl Edge agent version
        status:
          type: string
          description: The current node status
          enum:
          - online
          - offline
          - degraded
        os:
          type: string
          description: The operating system of the endpoint
        cpuUsage:
          type: number
          description: Current CPU utilization percentage
          format: float
        memUsage:
          type: number
          description: Current memory utilization percentage
          format: float
        ip:
          type: string
          description: The IP address of the endpoint
  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/