Cribl Database Connections API

openapi: 3.2.0
info:
  title: Cribl Cloud Database Connections 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: Database Connections
  description: Configure and manage database connections used by collectors and lookup functions.
paths:
  /system/database-connections:
    get:
      operationId: listDatabaseConnections
      summary: List all database connections
      description: Retrieves a list of all configured database connections used by collectors and lookup functions.
      tags:
      - Database Connections
      responses:
        '200':
          description: Successfully retrieved database connections
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatabaseConnection'
                  count:
                    type: integer
                    description: Total number of database connections
        '401':
          description: Unauthorized
    post:
      operationId: createDatabaseConnection
      summary: Create a database connection
      description: Creates a new database connection with the specified driver, connection string, and credentials.
      tags:
      - Database Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseConnection'
      responses:
        '200':
          description: Database connection created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseConnection'
        '400':
          description: Invalid connection configuration
        '401':
          description: Unauthorized
  /system/database-connections/{id}:
    get:
      operationId: getDatabaseConnection
      summary: Get a database connection by ID
      description: Retrieves the configuration of a specific database connection.
      tags:
      - Database Connections
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Successfully retrieved database connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseConnection'
        '401':
          description: Unauthorized
        '404':
          description: Database connection not found
    patch:
      operationId: updateDatabaseConnection
      summary: Update a database connection
      description: Updates the configuration of an existing database connection.
      tags:
      - Database Connections
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseConnection'
      responses:
        '200':
          description: Database connection updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseConnection'
        '400':
          description: Invalid connection configuration
        '401':
          description: Unauthorized
        '404':
          description: Database connection not found
    delete:
      operationId: deleteDatabaseConnection
      summary: Delete a database connection
      description: Deletes a database connection by its unique ID.
      tags:
      - Database Connections
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Database connection deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Database connection not found
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
  schemas:
    DatabaseConnection:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the database connection
        connectionString:
          type: string
          description: The database connection string
        driver:
          type: string
          description: The database driver type
        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: {}
externalDocs:
  description: Cribl API Reference
  url: https://docs.cribl.io/api-reference/