Cribl Functions API

openapi: 3.2.0
info:
  title: Cribl Functions API
  version: '1.0'
  contact:
    name: Cribl Support
    url: https://cribl.io/support/
  termsOfService: https://cribl.io/terms-of-service/
  description: 'Operations tagged Functions 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: Functions
  description: Retrieve available processing functions that can be used within pipelines for data transformation.
paths:
  /system/functions:
    get:
      operationId: listFunctions
      summary: List available functions
      description: Retrieves a list of all available processing functions that can be used within pipelines for data transformation, filtering, enrichment, and routing.
      tags:
      - Functions
      responses:
        '200':
          description: Successfully retrieved functions
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Function'
                  count:
                    type: integer
                    description: Total number of functions
        '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/functions/{id}:
    get:
      operationId: getFunction
      summary: Get a function by ID
      description: Retrieves the details of a specific processing function including its configuration schema and description.
      tags:
      - Functions
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Successfully retrieved function
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Function'
        '401':
          description: Unauthorized
        '404':
          description: Function 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:
  schemas:
    Function:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the function type
        category:
          type: string
          description: The function category
        description:
          type: string
          description: A human-readable description of the function
        conf:
          type: object
          description: The configuration schema for the function
    Function_2:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the function type
        category:
          type: string
          description: The function category
        description:
          type: string
          description: A human-readable description
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
  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