Cribl System API

openapi: 3.2.0
info:
  title: Cribl Cloud System API
  description: The Cribl Cloud API is a RESTful API that provides a centrally managed control plane for programmatically configuring and managing Cribl resources across Stream, Edge, Search, and Lake deployments. It allows developers to retrieve and manage data, automate repetitive manual processes, and integrate with third-party applications. The API uses OAuth 2.0 authentication via client credentials and follows a resource-based structure where each endpoint corresponds to a specific Cribl resource or collection of resources. The size limit for requests is 5 MB.
  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: System
  description: Access system-level settings including Git configuration, licensing, and global preferences.
paths:
  /system/settings/git-settings:
    get:
      operationId: getGitSettings
      summary: Get Git settings
      description: Retrieves the current Git integration settings including repository URL, branch, and sync configuration.
      tags:
      - System
      responses:
        '200':
          description: Successfully retrieved Git settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitSettings'
        '401':
          description: Unauthorized
    patch:
      operationId: updateGitSettings
      summary: Update Git settings
      description: Updates the Git integration settings for version-controlled configuration management.
      tags:
      - System
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GitSettings'
      responses:
        '200':
          description: Git settings updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitSettings'
        '400':
          description: Invalid Git settings
        '401':
          description: Unauthorized
components:
  schemas:
    GitSettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Git integration is enabled
        repoUrl:
          type: string
          description: The Git repository URL
        branch:
          type: string
          description: The Git branch to use
        authType:
          type: string
          description: The authentication method for Git
          enum:
          - none
          - token
          - ssh
        autoSync:
          type: boolean
          description: Whether to automatically sync with Git
  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: {}
externalDocs:
  description: Cribl API Reference
  url: https://docs.cribl.io/api-reference/