openapi: 3.0.2
servers:
  - url: /
info:
  title: Cribl API Reference
  description: This API Reference lists available REST endpoints, along with their
    supported operations for accessing, creating, updating, or deleting
    resources. See our complementary product documentation at
    [docs.cribl.io](http://docs.cribl.io).
  version: 4.15.1-1b453caa
  contact:
    name: Support
    url: https://portal.support.cribl.io
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message
    BannerMessage:
      type: object
      additionalProperties: false
      required:
        - type
        - message
        - theme
        - enabled
      properties:
        id:
          type: string
          title: Banner ID
        enabled:
          type: boolean
          title: Enable banner
          description: Show a banner on top of all pages
        type:
          enum:
            - custom
            - system
          type: string
          title: Banner type
          x-speakeasy-unknown-values: allow
        created:
          type: number
          title: Time
          description: Time created
        theme:
          type: string
          title: Background color
          pattern: ^((#?[0-9a-fA-F]{6})|(orange)|(yellow)|(green)|(blue)|(purple)|(magenta)|(red)){1}$
        invertFontColor:
          type: boolean
          title: Invert font color
        message:
          type: string
          title: Banner message
          maxLength: 100
          description: Enter a message to display to all your Organization's users, across
            all Cribl products. Limited to one line and 100 characters; will be
            truncated as needed.
        link:
          type: string
          title: Link URL
          description: Optionally, provide a URL to append to the message
          pattern: ^https?://
        linkDisplay:
          type: string
          title: Link display
          maxLength: 100
          description: Optionally, display your link with a short text label instead of
            the raw URL (100-character limit)
        customThemes:
          type: array
          items:
            type: string
    Certificate:
      type: object
      required:
        - id
        - cert
        - privKey
      properties:
        id:
          type: string
          title: Name
          pattern: ^[a-zA-Z0-9_-]+$
        description:
          type: string
          title: Description
        cert:
          type: string
          title: Certificate
          description: Drag/drop or upload host certificate in PEM/Base64 format, or paste
            its contents here
        privKey:
          type: string
          title: Private key
        passphrase:
          type: string
          title: Passphrase
        ca:
          type: string
          title: CA certificate
          description: Optionally, drag/drop or upload all CA certificates in PEM/Base64
            format. Or, paste certificate contents here. Certificates can be
            used for client and/or server authentication.
        inUse:
          type: array
          title: Referenced
          description: List of configurations that reference this certificate
          items:
            type: string
    FeaturesEntry:
      type: object
      properties:
        disabled:
          type: boolean
        id:
          type: string
      required:
        - disabled
        - id
    CloudProvider:
      type: string
      nullable: true
      enum:
        - aws
        - azure
      x-speakeasy-unknown-values: allow
    ConfigGroupCloud:
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/CloudProvider"
        region:
          type: string
      required:
        - provider
        - region
    Commit:
      type: object
      properties:
        author_email:
          type: string
        author_name:
          type: string
        date:
          type: string
        hash:
          type: string
        message:
          type: string
        short:
          type: string
      required:
        - date
        - hash
        - message
        - short
    ConfigGroupLookups:
      type: object
      properties:
        context:
          type: string
        lookups:
          type: array
          items:
            type: object
            properties:
              deployedVersion:
                type: string
              file:
                type: string
              version:
                type: string
            required:
              - file
      required:
        - context
        - lookups
    ConfigGroup:
      type: object
      properties:
        cloud:
          $ref: "#/components/schemas/ConfigGroupCloud"
        configVersion:
          type: string
        deployingWorkerCount:
          type: number
        description:
          type: string
        estimatedIngestRate:
          type: integer
          description: Maximum expected volume of data ingested by the @{group}. (This
            setting is available only on @{group}s consisting of Cribl-managed
            Cribl.Cloud @{node}s.)
          enum:
            - 1024
            - 2048
            - 3072
            - 4096
            - 5120
            - 7168
            - 10240
            - 13312
            - 15360
          x-speakeasy-enum-descriptions:
            - 12 MB/sec
            - 24 MB/sec
            - 36 MB/sec
            - 48 MB/sec
            - 60 MB/sec
            - 84 MB/sec
            - 120 MB/sec
            - 156 MB/sec
            - 180 MB/sec
          x-speakeasy-enums:
            - Rate12MBPerSec
            - Rate24MBPerSec
            - Rate36MBPerSec
            - Rate48MBPerSec
            - Rate60MBPerSec
            - Rate84MBPerSec
            - Rate120MBPerSec
            - Rate156MBPerSec
            - Rate180MBPerSec
          x-speakeasy-unknown-values: allow
        git:
          type: object
          properties:
            commit:
              type: string
            localChanges:
              type: number
            log:
              type: array
              items:
                $ref: "#/components/schemas/Commit"
        id:
          type: string
        incompatibleWorkerCount:
          type: number
        inherits:
          type: string
        isFleet:
          type: boolean
        isSearch:
          type: boolean
        lookupDeployments:
          type: array
          items:
            $ref: "#/components/schemas/ConfigGroupLookups"
        maxWorkerAge:
          type: string
        name:
          type: string
        onPrem:
          type: boolean
        provisioned:
          type: boolean
        streamtags:
          type: array
          items:
            type: string
        tags:
          type: string
        type:
          type: string
          enum:
            - lake_access
          x-speakeasy-unknown-values: allow
        upgradeVersion:
          type: string
        workerCount:
          type: number
        workerRemoteAccess:
          type: boolean
      required:
        - id
    RbacResource:
      type: string
      enum:
        - groups
        - datasets
        - dataset-providers
        - projects
        - dashboards
        - macros
        - notebooks
      x-speakeasy-unknown-values: allow
    ResourcePolicy:
      type: object
      properties:
        gid:
          type: string
        id:
          type: string
        policy:
          type: string
        type:
          $ref: "#/components/schemas/RbacResource"
      required:
        - gid
        - policy
        - type
    UserAccessControlList:
      type: object
      properties:
        perms:
          type: array
          items:
            $ref: "#/components/schemas/ResourcePolicy"
        user:
          type: string
      required:
        - perms
        - user
    AccessControl:
      type: object
    AccessControlSchema:
      type: object
      properties:
        add:
          $ref: "#/components/schemas/AccessControl"
        rm:
          $ref: "#/components/schemas/AccessControl"
    GroupCreateRequest:
      type: object
      properties:
        cloud:
          $ref: "#/components/schemas/ConfigGroupCloud"
        deployingWorkerCount:
          type: number
        description:
          type: string
        estimatedIngestRate:
          type: integer
          description: Maximum expected volume of data ingested by the @{group}. (This
            setting is available only on @{group}s consisting of Cribl-managed
            Cribl.Cloud @{node}s.)
          enum:
            - 1024
            - 2048
            - 3072
            - 4096
            - 5120
            - 7168
            - 10240
            - 13312
            - 15360
          x-speakeasy-enum-descriptions:
            - 12 MB/sec
            - 24 MB/sec
            - 36 MB/sec
            - 48 MB/sec
            - 60 MB/sec
            - 84 MB/sec
            - 120 MB/sec
            - 156 MB/sec
            - 180 MB/sec
          x-speakeasy-enums:
            - Rate12MBPerSec
            - Rate24MBPerSec
            - Rate36MBPerSec
            - Rate48MBPerSec
            - Rate60MBPerSec
            - Rate84MBPerSec
            - Rate120MBPerSec
            - Rate156MBPerSec
            - Rate180MBPerSec
          x-speakeasy-unknown-values: allow
        git:
          type: object
          properties:
            commit:
              type: string
            localChanges:
              type: number
            log:
              type: array
              items:
                $ref: "#/components/schemas/Commit"
        id:
          type: string
        incompatibleWorkerCount:
          type: number
        inherits:
          type: string
        isFleet:
          type: boolean
        isSearch:
          type: boolean
        lookupDeployments:
          type: array
          items:
            $ref: "#/components/schemas/ConfigGroupLookups"
        maxWorkerAge:
          type: string
        name:
          type: string
        onPrem:
          type: boolean
        provisioned:
          type: boolean
        sourceGroupId:
          type: string
        streamtags:
          type: array
          items:
            type: string
        tags:
          type: string
        type:
          type: string
          enum:
            - lake_access
          x-speakeasy-unknown-values: allow
        upgradeVersion:
          type: string
        workerCount:
          type: number
        workerRemoteAccess:
          type: boolean
      required:
        - id
    DeployRequestLookups:
      type: object
      properties:
        context:
          type: string
        lookups:
          type: array
          items:
            type: object
            properties:
              file:
                type: string
              version:
                type: string
            required:
              - file
              - version
      required:
        - context
        - lookups
    DeployRequest:
      type: object
      properties:
        lookups:
          type: array
          items:
            $ref: "#/components/schemas/DeployRequestLookups"
        version:
          type: string
      required:
        - version
    ProductsCore:
      type: string
      enum:
        - stream
        - edge
      x-speakeasy-unknown-values: allow
    KeyMetadataEntity:
      type: object
      required:
        - keyId
        - algorithm
        - kms
        - keyclass
      properties:
        keyId:
          type: string
          title: Key ID
        description:
          type: string
          title: Description
        algorithm:
          type: string
          title: Encryption algorithm
          default: aes-256-cbc
          enum:
            - aes-256-cbc
            - aes-256-gcm
          x-speakeasy-unknown-values: allow
        kms:
          type: string
          title: KMS for this key
          default: local
          enum:
            - local
          x-speakeasy-unknown-values: allow
        keyclass:
          type: number
          title: Key class
          default: 0
          minimum: 0
        created:
          type: number
          title: Creation time
        expires:
          type: number
          title: Expiration time
        plainKey:
          type: string
          title: Plain text key
        cipherKey:
          type: string
          title: Encrypted key
        useIV:
          type: boolean
          title: Use initialization vector
          description: Seed encryption with a
            [nonce](https://en.wikipedia.org/wiki/Cryptographic_nonce) to make
            the key more random and unique. Must be enabled with the aes-256-gcm
            algorithm.
          default: false
        ivSize:
          type: integer
          title: Initialization vector size
          enum:
            - 12
            - 13
            - 14
            - 15
            - 16
          default: 12
          description: Length of the initialization vector, in bytes
          x-speakeasy-unknown-values: allow
        group:
          type: string
          title: Group/Fleet
          description: Name of the Worker Group/Fleet that created this key
    BulletinMessage:
      type: object
      additionalProperties: false
      required:
        - id
        - text
      properties:
        id:
          type: string
          title: Message ID
        severity:
          type: string
          title: Severity
          enum:
            - info
            - warn
            - error
            - fatal
          x-speakeasy-unknown-values: allow
        title:
          type: string
          title: Title
        text:
          type: string
          title: Text
        time:
          type: number
          title: Occurrence Time
        group:
          type: string
          title: Group
        metadata:
          type: array
          items:
            type: object
    NotificationTarget:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
      required:
        - id
        - type
    Notification:
      type: object
      required:
        - id
        - condition
      properties:
        id:
          type: string
          title: ID
          pattern: ^[a-zA-Z0-9_-]+$
        disabled:
          type: boolean
          title: Disabled
          default: false
        condition:
          type: string
          title: Condition
        targets:
          type: array
          title: Notification targets
          description: Targets to send any Notifications to
          items:
            type: string
          default: []
        targetConfigs:
          type: array
          title: Target configuration
          items:
            type: object
            required:
              - id
            properties:
              id:
                type: string
                title: Notification target ID
                pattern: ^[a-zA-Z0-9_-]+$
            anyOf:
              - properties:
                  conf:
                    type: object
                    title: Notification config for SMTP target
                    properties:
                      subject:
                        type: string
                        title: Subject
                        description: Email subject
                      body:
                        type: string
                        title: Message
                        description: Email body
                      emailRecipient:
                        type: object
                        required:
                          - to
                        properties:
                          to:
                            type: string
                            title: To
                            description: Recipients' email addresses
                          cc:
                            type: string
                            title: Cc
                            description: "Cc: Recipients' email addresses"
                          bcc:
                            type: string
                            title: Bcc
                            description: "Bcc: Recipients' email addresses"
        conf:
          type: object
          title: Condition-specific configs
          properties: {}
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
    PolicyRule:
      type: object
      properties:
        args:
          type: array
          items:
            type: string
        description:
          type: string
        id:
          type: string
        template:
          type: array
          items:
            type: string
        title:
          type: string
      required:
        - id
        - template
    Role:
      type: object
      properties:
        description:
          type: string
        id:
          type: string
        policy:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        title:
          type: string
      required:
        - id
        - policy
    ScriptLibEntry:
      type: object
      additionalProperties: true
      required:
        - id
        - command
      properties:
        id:
          type: string
          pattern: ^[^/]+$
          title: ID
        command:
          type: string
          title: Command
          description: Command to execute for this script
        description:
          type: string
          title: Description
        args:
          type: array
          items:
            type: string
          title: Arguments
          description: Arguments to pass when executing this script
        env:
          type: object
          title: Env variables
          properties: {}
          additionalProperties:
            type: string
          description: Extra environment variables to set when executing script
    TcpOutCompression:
      type: string
      nullable: true
      enum:
        - gzip
        - none
      x-speakeasy-unknown-values: allow
    ConfigBundles:
      type: object
      properties:
        remoteUrl:
          type: string
      required:
        - remoteUrl
    FailoverConfigs:
      type: object
      properties:
        missedHBLimit:
          type: number
        period:
          type: string
        volume:
          type: string
      required:
        - volume
    SocksProxyOpts:
      type: object
      properties:
        disabled:
          type: boolean
        host:
          type: string
        password:
          type: string
        port:
          type: number
        type:
          type: number
        userId:
          type: string
      required:
        - host
        - port
    ResiliencyType:
      type: string
      enum:
        - none
        - failover
      x-speakeasy-unknown-values: allow
    SecureVersion:
      type: string
      enum:
        - TLSv1.3
        - TLSv1.2
        - TLSv1.1
        - TLSv1
      x-speakeasy-unknown-values: allow
    CloudWorkspaceSchema:
      type: object
      properties:
        authToken:
          type: string
        compression:
          $ref: "#/components/schemas/TcpOutCompression"
        configBundles:
          $ref: "#/components/schemas/ConfigBundles"
        configHelperSocketDir:
          type: string
        connectionTimeout:
          type: number
        disableSNIRouting:
          type: boolean
        disabled:
          type: boolean
        failover:
          $ref: "#/components/schemas/FailoverConfigs"
        forwardToLeaderApi:
          type: boolean
        host:
          type: string
        ipWhitelistRegex:
          type: string
        maxActiveCxn:
          type: number
        maxBufferBytes:
          type: number
        port:
          type: number
        protocol:
          type: string
        proxy:
          $ref: "#/components/schemas/SocksProxyOpts"
        resiliency:
          $ref: "#/components/schemas/ResiliencyType"
        subscriptionAgreement:
          type: boolean
        tls:
          type: object
          properties:
            caPath:
              type: string
            certPath:
              type: string
            certificateName:
              type: string
            checkServerIdentity:
              type: object
            commonNameRegex:
              type: object
              additionalProperties: true
            disabled:
              type: boolean
            maxVersion:
              $ref: "#/components/schemas/SecureVersion"
            minVersion:
              $ref: "#/components/schemas/SecureVersion"
            passphrase:
              type: string
            privKeyPath:
              type: string
            rejectUnauthorized:
              type: boolean
            requestCert:
              type: boolean
            servername:
              type: string
          required:
            - disabled
        writeTimeout:
          type: number
      required:
        - disabled
        - host
        - port
        - subscriptionAgreement
    MasterSchema:
      type: object
      properties:
        authToken:
          type: string
        compression:
          $ref: "#/components/schemas/TcpOutCompression"
        configBundles:
          $ref: "#/components/schemas/ConfigBundles"
        configHelperSocketDir:
          type: string
        connectionTimeout:
          type: number
        disableSNIRouting:
          type: boolean
        failover:
          $ref: "#/components/schemas/FailoverConfigs"
        forwardToLeaderApi:
          type: boolean
        host:
          type: string
        ipWhitelistRegex:
          type: string
        maxActiveCxn:
          type: number
        maxBufferBytes:
          type: number
        port:
          type: number
        protocol:
          type: string
        proxy:
          $ref: "#/components/schemas/SocksProxyOpts"
        resiliency:
          $ref: "#/components/schemas/ResiliencyType"
        tls:
          type: object
          properties:
            caPath:
              type: string
            certPath:
              type: string
            certificateName:
              type: string
            checkServerIdentity:
              type: object
            commonNameRegex:
              type: object
              additionalProperties: true
            disabled:
              type: boolean
            maxVersion:
              $ref: "#/components/schemas/SecureVersion"
            minVersion:
              $ref: "#/components/schemas/SecureVersion"
            passphrase:
              type: string
            privKeyPath:
              type: string
            rejectUnauthorized:
              type: boolean
            requestCert:
              type: boolean
            servername:
              type: string
          required:
            - disabled
        writeTimeout:
          type: number
      required:
        - host
        - port
    InstanceSettingsSchema:
      oneOf:
        - type: object
          properties:
            cloudWorkspace:
              $ref: "#/components/schemas/CloudWorkspaceSchema"
            envRegex:
              type: string
            group:
              type: string
            id:
              type: string
            master:
              $ref: "#/components/schemas/MasterSchema"
            mode:
              type: string
              enum:
                - edge
                - worker
                - single
                - master
                - managed-edge
                - outpost
                - search-supervisor
              x-speakeasy-unknown-values: allow
            reportedDeploymentId:
              type: string
            tags:
              type: array
              items:
                type: string
          required:
            - id
            - mode
        - type: object
          properties:
            bootstrapHost:
              type: string
            id:
              type: string
    Team:
      type: object
      properties:
        description:
          type: string
        id:
          type: string
        name:
          type: string
        roles:
          type: array
          items:
            type: string
        ssoGroupIds:
          type: array
          items:
            type: string
      required:
        - description
        - id
        - name
        - roles
    ProductsExtended:
      type: string
      enum:
        - stream
        - edge
        - search
      x-speakeasy-unknown-values: allow
    MembershipSchema:
      type: object
      properties:
        add:
          type: array
          items:
            type: string
        rm:
          type: array
          items:
            type: string
    User:
      type: object
      properties:
        currentPassword:
          type: string
        disabled:
          type: boolean
        email:
          type: string
        first:
          type: string
        id:
          type: string
        last:
          type: string
        password:
          type: string
        roles:
          type: array
          items:
            type: string
        teams:
          type: array
          items:
            type: string
        username:
          type: string
      required:
        - disabled
        - email
        - first
        - id
        - last
        - username
    UserProfile:
      type: object
      properties:
        disabled:
          type: boolean
        email:
          type: string
        first:
          type: string
        id:
          type: string
        last:
          type: string
        password:
          type: string
        roles:
          type: array
          items:
            type: string
        username:
          type: string
      required:
        - disabled
        - email
        - first
        - id
        - last
        - username
    UserInfo:
      type: object
      properties:
        currentPassword:
          type: string
        disabled:
          type: boolean
        email:
          type: string
        first:
          type: string
        id:
          type: string
        last:
          type: string
        password:
          type: string
        roles:
          type: array
          items:
            type: string
        username:
          type: string
      required:
        - disabled
        - email
        - first
        - id
        - last
        - username
    CacheConnectionBackfillStatus:
      type: string
      enum:
        - scheduled
        - pending
        - started
        - finished
        - incomplete
      x-speakeasy-unknown-values: allow
    LakehouseConnectionType:
      type: string
      enum:
        - cache
        - zeroPoint
      x-speakeasy-unknown-values: allow
    CacheConnection:
      type: object
      properties:
        acceleratedFields:
          type: array
          items:
            type: string
        backfillStatus:
          $ref: "#/components/schemas/CacheConnectionBackfillStatus"
        cacheRef:
          type: string
        createdAt:
          type: number
        lakehouseConnectionType:
          $ref: "#/components/schemas/LakehouseConnectionType"
        migrationQueryId:
          type: string
        retentionInDays:
          type: number
      required:
        - cacheRef
        - createdAt
        - retentionInDays
    LakeDatasetMetrics:
      type: object
      properties:
        currentSizeBytes:
          type: number
        metricsDate:
          type: string
      required:
        - currentSizeBytes
        - metricsDate
    DatasetMetadataRunInfo:
      type: object
      properties:
        earliestScannedTime:
          type: number
        finishedAt:
          type: number
        latestScannedTime:
          type: number
        objectCount:
          type: number
    DatasetMetadata:
      type: object
      properties:
        earliest:
          type: string
        enableAcceleration:
          type: boolean
        fieldList:
          type: array
          items:
            type: string
        latestRunInfo:
          $ref: "#/components/schemas/DatasetMetadataRunInfo"
        scanMode:
          type: string
          enum:
            - detailed
            - quick
          x-speakeasy-unknown-values: allow
      required:
        - earliest
        - enableAcceleration
        - fieldList
        - scanMode
    LakeDatasetSearchConfig:
      type: object
      properties:
        datatypes:
          type: array
          items:
            type: string
        metadata:
          $ref: "#/components/schemas/DatasetMetadata"
    CriblLakeDataset:
      type: object
      properties:
        acceleratedFields:
          type: array
          items:
            type: string
        bucketName:
          type: string
        cacheConnection:
          $ref: "#/components/schemas/CacheConnection"
        deletionStartedAt:
          type: number
        description:
          type: string
        format:
          type: string
          enum:
            - json
            - ddss
            - parquet
          x-speakeasy-unknown-values: allow
        httpDAUsed:
          type: boolean
        id:
          type: string
        metrics:
          $ref: "#/components/schemas/LakeDatasetMetrics"
        retentionPeriodInDays:
          type: number
        searchConfig:
          $ref: "#/components/schemas/LakeDatasetSearchConfig"
        storageLocationId:
          type: string
        viewName:
          type: string
      required:
        - id
    CriblLakeDatasetUpdate:
      type: object
      properties:
        acceleratedFields:
          type: array
          items:
            type: string
        bucketName:
          type: string
        cacheConnection:
          $ref: "#/components/schemas/CacheConnection"
        deletionStartedAt:
          type: number
        description:
          type: string
        format:
          type: string
          enum:
            - json
            - ddss
            - parquet
          x-speakeasy-unknown-values: allow
        httpDAUsed:
          type: boolean
        id:
          type: string
        metrics:
          $ref: "#/components/schemas/LakeDatasetMetrics"
        retentionPeriodInDays:
          type: number
        searchConfig:
          $ref: "#/components/schemas/LakeDatasetSearchConfig"
        storageLocationId:
          type: string
        viewName:
          type: string
    StorageLocationConfigPrefix:
      type: string
      enum:
        - Lake
        - DDSS
      x-speakeasy-unknown-values: allow
    CriblLakeStorageLocationInventoryConfig:
      type: object
      properties:
        configPrefix:
          $ref: "#/components/schemas/StorageLocationConfigPrefix"
        destinationBucketName:
          type: string
        destinationPrefix:
          type: string
        region:
          type: string
        type:
          type: string
          enum:
            - s3-inventory
          x-speakeasy-unknown-values: allow
      required:
        - destinationBucketName
        - destinationPrefix
        - region
        - type
    CriblLakeStorageLocationConfig:
      type: object
      properties:
        bucketName:
          type: string
        encryption:
          type: string
          enum:
            - SSE-S3
            - SSE-KMS
          x-speakeasy-unknown-values: allow
        inventoryConfig:
          $ref: "#/components/schemas/CriblLakeStorageLocationInventoryConfig"
        region:
          type: string
      required:
        - bucketName
        - region
    Credentials:
      type: object
      properties:
        apiKey:
          type: string
        method:
          type: string
          enum:
            - manual
            - auto
            - auto_rpc
          x-speakeasy-unknown-values: allow
        roleToAssume:
          type: string
        roleToAssumeExternalId:
          type: string
        roleToAssumeHybrid:
          type: string
        secretKey:
          type: string
      required:
        - method
    CriblLakeLifecycleItemStatus:
      type: string
      enum:
        - provisioning
        - ready
        - failed
        - terminated
        - delayed
        - blocked
      x-speakeasy-unknown-values: allow
    CriblLakeStorageLocation:
      type: object
      properties:
        config:
          $ref: "#/components/schemas/CriblLakeStorageLocationConfig"
        credentials:
          $ref: "#/components/schemas/Credentials"
        description:
          type: string
        id:
          type: string
        lastProvisionedMs:
          type: number
        metricsLastGenerated:
          type: number
        provider:
          type: string
          enum:
            - cribl_lake
            - aws-s3
          x-speakeasy-unknown-values: allow
        status:
          $ref: "#/components/schemas/CriblLakeLifecycleItemStatus"
      required:
        - config
        - credentials
        - id
        - provider
    DashboardCategory:
      type: object
      properties:
        description:
          type: string
        id:
          type: string
        isPack:
          type: boolean
        name:
          type: string
      required:
        - id
        - name
    FieldMappingType:
      type: object
      properties:
        fieldName:
          type: string
        source:
          type: string
      required:
        - fieldName
        - source
    EventBreakerType:
      type: string
      enum:
        - parquet
        - ndjson
        - csv
      x-speakeasy-unknown-values: allow
    ExtractionType:
      type: string
      enum:
        - csv
        - regexp
      x-speakeasy-unknown-values: allow
    DataTypeExtraction:
      allOf:
        - type: object
          properties:
            name:
              type: string
            sourceField:
              type: string
            type:
              $ref: "#/components/schemas/ExtractionType"
          required:
            - name
            - sourceField
            - type
        - oneOf:
            - type: object
              properties:
                delimiter:
                  type: string
                escape:
                  type: string
                fieldList:
                  type: array
                  items:
                    type: string
                nullValue:
                  type: string
                quote:
                  type: string
                type:
                  type: string
                  enum:
                    - csv
                  x-speakeasy-unknown-values: allow
              required:
                - delimiter
                - escape
                - nullValue
                - quote
                - type
            - type: object
              properties:
                regexpList:
                  type: array
                  items:
                    type: object
                    properties:
                      overwrite:
                        type: boolean
                      regexp:
                        type: string
                    required:
                      - regexp
                type:
                  type: string
                  enum:
                    - regexp
                  x-speakeasy-unknown-values: allow
              required:
                - regexpList
                - type
    CriblLib:
      type: string
      enum:
        - cribl
        - cribl-custom
        - custom
      x-speakeasy-unknown-values: allow
    TimestampExtractionType:
      type: string
      enum:
        - auto
        - manual
      x-speakeasy-unknown-values: allow
    TimestampExtraction:
      allOf:
        - type: object
          properties:
            anchorRegex:
              type: string
            earliest:
              type: string
            latest:
              type: string
            sourceField:
              type: string
            timezone:
              type: string
            type:
              $ref: "#/components/schemas/TimestampExtractionType"
          required:
            - type
        - oneOf:
            - type: object
              properties:
                scanDepth:
                  type: number
                type:
                  type: string
                  enum:
                    - auto
                  x-speakeasy-unknown-values: allow
              required:
                - scanDepth
                - type
            - type: object
              properties:
                format:
                  type: string
                type:
                  type: string
                  enum:
                    - manual
                  x-speakeasy-unknown-values: allow
              required:
                - format
                - type
    DataTypeDescriptor:
      type: object
      properties:
        addFields:
          type: array
          items:
            $ref: "#/components/schemas/FieldMappingType"
        breakerType:
          $ref: "#/components/schemas/EventBreakerType"
        description:
          type: string
        extractions:
          type: array
          items:
            $ref: "#/components/schemas/DataTypeExtraction"
        id:
          type: string
        lib:
          $ref: "#/components/schemas/CriblLib"
        schemaMap:
          type: array
          items:
            $ref: "#/components/schemas/FieldMappingType"
        tags:
          type: string
        timestampExtraction:
          $ref: "#/components/schemas/TimestampExtraction"
      required:
        - breakerType
        - id
        - lib
        - timestampExtraction
    NotebookActivityResult:
      type: object
      properties:
        endOfResults:
          type: boolean
        events:
          type: array
          items:
            type: object
            additionalProperties: true
        offset:
          type: string
      required:
        - endOfResults
        - events
        - offset
    NumberOrPercent:
      oneOf:
        - type: number
        - type: string
          pattern: ^[0-9]+%$
    SchedulingLimitRule:
      type: object
      properties:
        description:
          type: string
        limit:
          $ref: "#/components/schemas/NumberOrPercent"
        metric:
          type: string
        type:
          type: string
          enum:
            - maxConcurrentAdhocSearchesPerUser
            - maxConcurrentScheduledSearchesPerUser
            - maxConcurrentSearches
          x-speakeasy-unknown-values: allow
      required:
        - limit
        - type
    LimitRule:
      type: object
      properties:
        description:
          type: string
        limit:
          type: number
        metric:
          type: string
        type:
          type: string
          enum:
            - maxRelativeEarliestTimerange
            - maxTimerangeWidth
            - maxBytesReadPerSearch
            - maxRunningTimePerSearch
            - maxResultsPerSearch
            - maxExecutorsPerSearch
            - coordinatorHeapMemoryLimit
          x-speakeasy-unknown-values: allow
      required:
        - limit
        - type
    LimitRuleDefinitions:
      type: object
      properties:
        coordinatorHeapMemoryLimit:
          $ref: "#/components/schemas/LimitRule"
        maxBytesReadPerSearch:
          $ref: "#/components/schemas/LimitRule"
        maxConcurrentAdhocSearchesPerUser:
          $ref: "#/components/schemas/SchedulingLimitRule"
        maxConcurrentScheduledSearchesPerUser:
          $ref: "#/components/schemas/SchedulingLimitRule"
        maxConcurrentSearches:
          $ref: "#/components/schemas/SchedulingLimitRule"
        maxExecutorsPerSearch:
          $ref: "#/components/schemas/LimitRule"
        maxRelativeEarliestTimerange:
          $ref: "#/components/schemas/LimitRule"
        maxResultsPerSearch:
          $ref: "#/components/schemas/LimitRule"
        maxRunningTimePerSearch:
          $ref: "#/components/schemas/LimitRule"
        maxTimerangeWidth:
          $ref: "#/components/schemas/LimitRule"
      required:
        - coordinatorHeapMemoryLimit
        - maxBytesReadPerSearch
        - maxConcurrentAdhocSearchesPerUser
        - maxConcurrentScheduledSearchesPerUser
        - maxConcurrentSearches
        - maxExecutorsPerSearch
        - maxRelativeEarliestTimerange
        - maxResultsPerSearch
        - maxRunningTimePerSearch
        - maxTimerangeWidth
    UsageGroup:
      type: object
      properties:
        coordinatorHeapMemoryLimit:
          type: number
        description:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        rules:
          $ref: "#/components/schemas/LimitRuleDefinitions"
        users:
          type: object
          additionalProperties:
            type: object
            properties:
              email:
                type: string
              id:
                type: string
            required:
              - email
              - id
        usersCount:
          type: number
      required:
        - id
        - rules
    DatasetProviderCapability:
      type: string
      enum:
        - read
        - list
      x-speakeasy-unknown-values: allow
    DatasetOrigin:
      type: string
      enum:
        - leader_local
        - remote
        - worker_local
      x-speakeasy-unknown-values: allow
    OriginConfig:
      type: object
      properties:
        filterExpression:
          type: string
        origin:
          $ref: "#/components/schemas/DatasetOrigin"
      required:
        - origin
    DatasetProviderType:
      type: object
      properties:
        capabilities:
          type: array
          items:
            $ref: "#/components/schemas/DatasetProviderCapability"
        description:
          type: string
        id:
          type: string
          enum:
            - prometheus
            - s3
            - cribl_lake
            - gcs
            - azure_blob
            - cribl_leader
            - cribl_edge
            - amazon_security_lake
            - api_http
            - api_aws
            - api_azure
            - api_gcp
            - api_google_workspace
            - api_msgraph
            - api_okta
            - api_tailscale
            - api_zoom
            - api_opensearch
            - api_elasticsearch
            - api_azure_data_explorer
            - snowflake
            - clickhouse
            - cribl_meta
            - cribl_local
          x-speakeasy-unknown-values: allow
        locality:
          $ref: "#/components/schemas/OriginConfig"
      required:
        - capabilities
        - id
    UnionOfValues:
      type: object
      additionalProperties: true
    DatasetProvider:
      $ref: "#/components/schemas/UnionOfValues"
    Dataset:
      $ref: "#/components/schemas/UnionOfValues"
    AppscopeTransport:
      type: object
      properties:
        buffer:
          type: string
          enum:
            - line
            - full
          x-speakeasy-unknown-values: allow
        host:
          type: string
        path:
          type: string
        port:
          type: number
        tls:
          type: object
          properties:
            cacertpath:
              type: string
            enable:
              type: boolean
            validateserver:
              type: boolean
        type:
          type: string
    AppscopeConfig:
      type: object
      properties:
        cribl:
          type: object
          properties:
            authtoken:
              type: string
            enable:
              type: boolean
            transport:
              $ref: "#/components/schemas/AppscopeTransport"
            useScopeSourceTransport:
              type: boolean
        event:
          type: object
          properties:
            enable:
              type: boolean
            format:
              type: object
              properties:
                enhancefs:
                  type: boolean
                maxeventpersec:
                  type: number
              required:
                - enhancefs
                - maxeventpersec
            transport:
              $ref: "#/components/schemas/AppscopeTransport"
            type:
              type: string
              enum:
                - ndjson
              x-speakeasy-unknown-values: allow
            watch:
              type: array
              items:
                type: object
                properties:
                  allowbinary:
                    type: boolean
                  enabled:
                    type: boolean
                  field:
                    type: string
                  headers:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                  value:
                    type: string
                required:
                  - type
          required:
            - enable
            - format
            - transport
            - type
            - watch
        libscope:
          type: object
          properties:
            commanddir:
              type: string
            configevent:
              type: boolean
            log:
              type: object
              properties:
                level:
                  type: string
                  enum:
                    - error
                    - debug
                    - info
                    - warning
                    - none
                  x-speakeasy-unknown-values: allow
                transport:
                  $ref: "#/components/schemas/AppscopeTransport"
            summaryperiod:
              type: number
        metric:
          type: object
          properties:
            enable:
              type: boolean
            format:
              type: object
              properties:
                statsdmaxlen:
                  type: number
                statsdprefix:
                  type: string
                type:
                  type: string
                verbosity:
                  type: number
            transport:
              $ref: "#/components/schemas/AppscopeTransport"
            watch:
              type: array
              items:
                type: string
          required:
            - enable
            - format
            - transport
            - watch
        payload:
          type: object
          properties:
            dir:
              type: string
            enable:
              type: boolean
          required:
            - dir
            - enable
        protocol:
          type: array
          items:
            type: object
            properties:
              binary:
                type: boolean
              detect:
                type: boolean
              len:
                type: number
              name:
                type: string
              payload:
                type: boolean
              regex:
                type: string
            required:
              - binary
              - detect
              - len
              - name
              - payload
              - regex
        tags:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
            required:
              - key
              - value
    AppscopeCustom:
      type: object
      properties:
        ancestor:
          type: string
        arg:
          type: string
        config:
          $ref: "#/components/schemas/AppscopeConfig"
        env:
          type: string
        hostname:
          type: string
        procname:
          type: string
        username:
          type: string
      required:
        - config
    AppscopeConfigWithCustom:
      type: object
      properties:
        cribl:
          type: object
          properties:
            authtoken:
              type: string
            enable:
              type: boolean
            transport:
              $ref: "#/components/schemas/AppscopeTransport"
            useScopeSourceTransport:
              type: boolean
        custom:
          type: array
          items:
            $ref: "#/components/schemas/AppscopeCustom"
        event:
          type: object
          properties:
            enable:
              type: boolean
            format:
              type: object
              properties:
                enhancefs:
                  type: boolean
                maxeventpersec:
                  type: number
              required:
                - enhancefs
                - maxeventpersec
            transport:
              $ref: "#/components/schemas/AppscopeTransport"
            type:
              type: string
              enum:
                - ndjson
              x-speakeasy-unknown-values: allow
            watch:
              type: array
              items:
                type: object
                properties:
                  allowbinary:
                    type: boolean
                  enabled:
                    type: boolean
                  field:
                    type: string
                  headers:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                  value:
                    type: string
                required:
                  - type
          required:
            - enable
            - format
            - transport
            - type
            - watch
        libscope:
          type: object
          properties:
            commanddir:
              type: string
            configevent:
              type: boolean
            log:
              type: object
              properties:
                level:
                  type: string
                  enum:
                    - error
                    - debug
                    - info
                    - warning
                    - none
                  x-speakeasy-unknown-values: allow
                transport:
                  $ref: "#/components/schemas/AppscopeTransport"
            summaryperiod:
              type: number
        metric:
          type: object
          properties:
            enable:
              type: boolean
            format:
              type: object
              properties:
                statsdmaxlen:
                  type: number
                statsdprefix:
                  type: string
                type:
                  type: string
                verbosity:
                  type: number
            transport:
              $ref: "#/components/schemas/AppscopeTransport"
            watch:
              type: array
              items:
                type: string
          required:
            - enable
            - format
            - transport
            - watch
        payload:
          type: object
          properties:
            dir:
              type: string
            enable:
              type: boolean
          required:
            - dir
            - enable
        protocol:
          type: array
          items:
            type: object
            properties:
              binary:
                type: boolean
              detect:
                type: boolean
              len:
                type: number
              name:
                type: string
              payload:
                type: boolean
              regex:
                type: string
            required:
              - binary
              - detect
              - len
              - name
              - payload
              - regex
        tags:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
            required:
              - key
              - value
    AppscopeLibEntry:
      type: object
      properties:
        config:
          $ref: "#/components/schemas/AppscopeConfigWithCustom"
        description:
          type: string
        id:
          type: string
        lib:
          $ref: "#/components/schemas/CriblLib"
        tags:
          type: string
      required:
        - config
        - description
        - id
        - lib
    GrokFile:
      type: object
      properties:
        content:
          type: string
        id:
          type: string
        size:
          type: number
        tags:
          type: string
      required:
        - content
        - id
        - size
    SavedJobCollection:
      required:
        - collector
        - type
      properties:
        id:
          type: string
          title: Job ID
          pattern: ^[a-zA-Z0-9_-]+$
          description: Unique ID for this Job
        description:
          type: string
          title: Description
        type:
          type: string
          title: Job type
          enum:
            - collection
            - executor
            - scheduledSearch
          x-speakeasy-unknown-values: allow
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        removeFields:
          type: array
          title: Remove Discover fields
          description: List of fields to remove from Discover results. Wildcards (for
            example, aws*) are allowed. This is useful when discovery returns
            sensitive fields that should not be exposed in the Jobs user
            interface.
          minItems: 0
          default: []
          items:
            type: string
            title: Items
            description: List of fields to remove from Discover results
        resumeOnBoot:
          type: boolean
          title: Resume job on boot
          description: Resume the ad hoc job if a failure condition causes Stream to
            restart during job execution
          default: false
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        schedule:
          type: object
          title: Schedule
          description: Configuration for a scheduled job
          properties:
            enabled:
              type: boolean
              title: Enabled
              description: Enable to configure scheduling for this Collector
            skippable:
              type: boolean
              title: Skippable
              description: Skippable jobs can be delayed, up to their next run time, if the
                system is hitting concurrency limits
              default: true
            resumeMissed:
              type: boolean
              title: Resume missed runs
              description: If Stream Leader (or single instance) restarts, run all missed jobs
                according to their original schedules
              default: false
            cronSchedule:
              type: string
              title: Cron schedule
              description: A cron schedule on which to run this job
              default: "*/5 * * * *"
            maxConcurrentRuns:
              type: number
              title: Concurrent run limit
              description: The maximum number of instances of this scheduled job that may be
                running at any time
              default: 1
              minimum: 1
            run:
              type: object
              title: Run settings
              if:
                properties:
                  type:
                    enum:
                      - collection
                    x-speakeasy-unknown-values: allow
              then:
                type: object
                required:
                  - mode
                properties:
                  rescheduleDroppedTasks:
                    type: boolean
                    title: Reschedule tasks
                    description: Reschedule tasks that failed with non-fatal errors
                    default: true
                  maxTaskReschedule:
                    type: number
                    title: Task reschedule limit
                    description: Maximum number of times a task can be rescheduled
                    default: 1
                    minimum: 1
                  logLevel:
                    type: string
                    title: Log level
                    description: Level at which to set task logging
                    enum:
                      - error
                      - warn
                      - info
                      - debug
                      - silly
                    default: info
                    x-speakeasy-unknown-values: allow
                  jobTimeout:
                    title: Job timeout
                    type: string
                    description: "Maximum time the job is allowed to run. Time unit defaults to
                      seconds if not specified (examples: 30, 45s, 15m). Enter 0
                      for unlimited time."
                    pattern: \d+[sm]?$
                    default: "0"
                  mode:
                    type: string
                    title: Mode
                    description: Job run mode. Preview will either return up to N matching results,
                      or will run until capture time T is reached. Discovery
                      will gather the list of files to turn into streaming
                      tasks, without running the data collection job. Full Run
                      will run the collection job.
                    default: list
                  timeRangeType:
                    type: string
                    title: Time range
                    default: relative
                  earliest:
                    type: number
                    title: Earliest
                    description: Earliest time to collect data for the selected timezone
                  latest:
                    type: number
                    title: Latest
                    description: Latest time to collect data for the selected timezone
                  timestampTimezone: {}
                  timeWarning:
                    type: object
                    properties: {}
                  expression:
                    type: string
                    title: Filter
                    description: A filter for tokens in the provided collect path and/or the events
                      being collected
                    default: "true"
                  minTaskSize:
                    type: string
                    title: Lower task bundle size
                    description: >-
                      Limits the bundle size for small tasks. For example,
                              if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
                    default: 1MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
                  maxTaskSize:
                    type: string
                    title: Upper task bundle size
                    description: >-
                      Limits the bundle size for files above the lower task
                      bundle size. For example, if your upper bundle size is
                      10MB,
                              you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
                    default: 10MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
              else: false
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        workerAffinity:
          type: boolean
          title: Worker affinity
          description: If enabled, tasks are created and run by the same Worker Node
          default: false
        collector:
          type: object
          required:
            - type
            - conf
          properties:
            type:
              type: string
              title: Collector type
              description: The type of collector to run
            conf:
              type: object
              title: Collector-specific settings
              properties: {}
            destructive:
              type: boolean
              title: Destructive
              description: Delete any files collected (where applicable)
              default: false
            encoding:
              type: string
              title: Encoding
              description: Character encoding to use when parsing ingested data. When not set,
                @{product} will default to UTF-8 but may incorrectly interpret
                multi-byte characters.
        input:
          type: object
          properties:
            type:
              type: string
              enum:
                - collection
              default: collection
              x-speakeasy-unknown-values: allow
            breakerRulesets:
              type: array
              title: Event Breaker rulesets
              description: A list of event-breaking rulesets that will be applied, in order,
                to the input data stream
              items:
                type: string
            staleChannelFlushMs:
              type: number
              title: Event Breaker buffer timeout (ms)
              description: How long (in milliseconds) the Event Breaker will wait for new data
                to be sent to a specific channel before flushing the data stream
                out, as is, to the Pipelines
              default: 10000
              minimum: 10
              maximum: 43200000
            sendToRoutes:
              type: boolean
              title: Send to Routes
              description: Send events to normal routing and event processing. Disable to
                select a specific Pipeline/Destination combination.
              default: true
            preprocess:
              type: object
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                command:
                  type: string
                  title: Command
                  description: Command to feed the data through (via stdin) and process its output
                    (stdout)
                args:
                  type: array
                  title: Arguments
                  description: Arguments to be added to the custom command
                  items:
                    type: string
            throttleRatePerSec:
              type: string
              title: Throttling
              description: "Rate (in bytes per second) to throttle while writing to an output.
                Accepts values with multiple-byte units, such as KB, MB, and GB.
                (Example: 42 MB) Default value of 0 specifies no throttling."
              pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
              default: "0"
            metadata:
              type: array
              title: Fields
              description: Fields to add to events from this input
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Field Name
                  value:
                    type: string
                    title: Value
                    description: JavaScript expression to compute field's value, enclosed in quotes
                      or backticks. (Can evaluate to a constant.)
            pipeline:
              type: string
              title: Pipeline
              description: Pipeline to process results
            output:
              type: string
              title: Destination
              description: Destination to send results to
      type: object
    SavedJobExecutor:
      required:
        - executor
        - type
      properties:
        id:
          type: string
          title: Job ID
          pattern: ^[a-zA-Z0-9_-]+$
          description: Unique ID for this Job
        description:
          type: string
          title: Description
        type:
          type: string
          title: Job type
          enum:
            - collection
            - executor
            - scheduledSearch
          x-speakeasy-unknown-values: allow
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        removeFields:
          type: array
          title: Remove Discover fields
          description: List of fields to remove from Discover results. Wildcards (for
            example, aws*) are allowed. This is useful when discovery returns
            sensitive fields that should not be exposed in the Jobs user
            interface.
          minItems: 0
          default: []
          items:
            type: string
            title: Items
            description: List of fields to remove from Discover results
        resumeOnBoot:
          type: boolean
          title: Resume job on boot
          description: Resume the ad hoc job if a failure condition causes Stream to
            restart during job execution
          default: false
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        schedule:
          type: object
          title: Schedule
          description: Configuration for a scheduled job
          properties:
            enabled:
              type: boolean
              title: Enabled
              description: Enable to configure scheduling for this Collector
            skippable:
              type: boolean
              title: Skippable
              description: Skippable jobs can be delayed, up to their next run time, if the
                system is hitting concurrency limits
              default: true
            resumeMissed:
              type: boolean
              title: Resume missed runs
              description: If Stream Leader (or single instance) restarts, run all missed jobs
                according to their original schedules
              default: false
            cronSchedule:
              type: string
              title: Cron schedule
              description: A cron schedule on which to run this job
              default: "*/5 * * * *"
            maxConcurrentRuns:
              type: number
              title: Concurrent run limit
              description: The maximum number of instances of this scheduled job that may be
                running at any time
              default: 1
              minimum: 1
            run:
              type: object
              title: Run settings
              if:
                properties:
                  type:
                    enum:
                      - collection
                    x-speakeasy-unknown-values: allow
              then:
                type: object
                required:
                  - mode
                properties:
                  rescheduleDroppedTasks:
                    type: boolean
                    title: Reschedule tasks
                    description: Reschedule tasks that failed with non-fatal errors
                    default: true
                  maxTaskReschedule:
                    type: number
                    title: Task reschedule limit
                    description: Maximum number of times a task can be rescheduled
                    default: 1
                    minimum: 1
                  logLevel:
                    type: string
                    title: Log level
                    description: Level at which to set task logging
                    enum:
                      - error
                      - warn
                      - info
                      - debug
                      - silly
                    default: info
                    x-speakeasy-unknown-values: allow
                  jobTimeout:
                    title: Job timeout
                    type: string
                    description: "Maximum time the job is allowed to run. Time unit defaults to
                      seconds if not specified (examples: 30, 45s, 15m). Enter 0
                      for unlimited time."
                    pattern: \d+[sm]?$
                    default: "0"
                  mode:
                    type: string
                    title: Mode
                    description: Job run mode. Preview will either return up to N matching results,
                      or will run until capture time T is reached. Discovery
                      will gather the list of files to turn into streaming
                      tasks, without running the data collection job. Full Run
                      will run the collection job.
                    default: list
                  timeRangeType:
                    type: string
                    title: Time range
                    default: relative
                  earliest:
                    type: number
                    title: Earliest
                    description: Earliest time to collect data for the selected timezone
                  latest:
                    type: number
                    title: Latest
                    description: Latest time to collect data for the selected timezone
                  timestampTimezone: {}
                  timeWarning:
                    type: object
                    properties: {}
                  expression:
                    type: string
                    title: Filter
                    description: A filter for tokens in the provided collect path and/or the events
                      being collected
                    default: "true"
                  minTaskSize:
                    type: string
                    title: Lower task bundle size
                    description: >-
                      Limits the bundle size for small tasks. For example,
                              if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
                    default: 1MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
                  maxTaskSize:
                    type: string
                    title: Upper task bundle size
                    description: >-
                      Limits the bundle size for files above the lower task
                      bundle size. For example, if your upper bundle size is
                      10MB,
                              you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
                    default: 10MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
              else: false
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        executor:
          type: object
          required:
            - type
          properties:
            type:
              type: string
              title: Executor type
              description: The type of executor to run
            storeTaskResults:
              type: boolean
              title: Store task results
              description: Determines whether or not to write task results to disk
              default: true
            conf:
              type: object
              title: Executor-specific settings
              properties: {}
      type: object
    SavedJobScheduledSearch:
      required:
        - savedQueryId
        - type
      properties:
        id:
          type: string
          title: Job ID
          pattern: ^[a-zA-Z0-9_-]+$
          description: Unique ID for this Job
        description:
          type: string
          title: Description
        type:
          type: string
          title: Job type
          enum:
            - collection
            - executor
            - scheduledSearch
          x-speakeasy-unknown-values: allow
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        removeFields:
          type: array
          title: Remove Discover fields
          description: List of fields to remove from Discover results. Wildcards (for
            example, aws*) are allowed. This is useful when discovery returns
            sensitive fields that should not be exposed in the Jobs user
            interface.
          minItems: 0
          default: []
          items:
            type: string
            title: Items
            description: List of fields to remove from Discover results
        resumeOnBoot:
          type: boolean
          title: Resume job on boot
          description: Resume the ad hoc job if a failure condition causes Stream to
            restart during job execution
          default: false
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        schedule:
          type: object
          title: Schedule
          description: Configuration for a scheduled job
          properties:
            enabled:
              type: boolean
              title: Enabled
              description: Enable to configure scheduling for this Collector
            skippable:
              type: boolean
              title: Skippable
              description: Skippable jobs can be delayed, up to their next run time, if the
                system is hitting concurrency limits
              default: true
            resumeMissed:
              type: boolean
              title: Resume missed runs
              description: If Stream Leader (or single instance) restarts, run all missed jobs
                according to their original schedules
              default: false
            cronSchedule:
              type: string
              title: Cron schedule
              description: A cron schedule on which to run this job
              default: "*/5 * * * *"
            maxConcurrentRuns:
              type: number
              title: Concurrent run limit
              description: The maximum number of instances of this scheduled job that may be
                running at any time
              default: 1
              minimum: 1
            run:
              type: object
              title: Run settings
              if:
                properties:
                  type:
                    enum:
                      - collection
                    x-speakeasy-unknown-values: allow
              then:
                type: object
                required:
                  - mode
                properties:
                  rescheduleDroppedTasks:
                    type: boolean
                    title: Reschedule tasks
                    description: Reschedule tasks that failed with non-fatal errors
                    default: true
                  maxTaskReschedule:
                    type: number
                    title: Task reschedule limit
                    description: Maximum number of times a task can be rescheduled
                    default: 1
                    minimum: 1
                  logLevel:
                    type: string
                    title: Log level
                    description: Level at which to set task logging
                    enum:
                      - error
                      - warn
                      - info
                      - debug
                      - silly
                    default: info
                    x-speakeasy-unknown-values: allow
                  jobTimeout:
                    title: Job timeout
                    type: string
                    description: "Maximum time the job is allowed to run. Time unit defaults to
                      seconds if not specified (examples: 30, 45s, 15m). Enter 0
                      for unlimited time."
                    pattern: \d+[sm]?$
                    default: "0"
                  mode:
                    type: string
                    title: Mode
                    description: Job run mode. Preview will either return up to N matching results,
                      or will run until capture time T is reached. Discovery
                      will gather the list of files to turn into streaming
                      tasks, without running the data collection job. Full Run
                      will run the collection job.
                    default: list
                  timeRangeType:
                    type: string
                    title: Time range
                    default: relative
                  earliest:
                    type: number
                    title: Earliest
                    description: Earliest time to collect data for the selected timezone
                  latest:
                    type: number
                    title: Latest
                    description: Latest time to collect data for the selected timezone
                  timestampTimezone: {}
                  timeWarning:
                    type: object
                    properties: {}
                  expression:
                    type: string
                    title: Filter
                    description: A filter for tokens in the provided collect path and/or the events
                      being collected
                    default: "true"
                  minTaskSize:
                    type: string
                    title: Lower task bundle size
                    description: >-
                      Limits the bundle size for small tasks. For example,
                              if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
                    default: 1MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
                  maxTaskSize:
                    type: string
                    title: Upper task bundle size
                    description: >-
                      Limits the bundle size for files above the lower task
                      bundle size. For example, if your upper bundle size is
                      10MB,
                              you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
                    default: 10MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
              else: false
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        savedQueryId:
          type: string
          title: ID of the SavedQuery
          description: Identifies which search query to run
      type: object
    SavedJob:
      oneOf:
        - $ref: "#/components/schemas/SavedJobCollection"
        - $ref: "#/components/schemas/SavedJobExecutor"
        - $ref: "#/components/schemas/SavedJobScheduledSearch"
    LookupFile:
      type: object
      required:
        - id
      properties:
        id:
          title: Filename
          type: string
          pattern: ^\w[\w -]+(?:\.csv|\.gz|\.csv\.gz|\.mmdb)?$
        description:
          type: string
          title: Description
        tags:
          type: string
          title: Tags
        size:
          type: number
          description: File size. Optional.
        version:
          type: string
          description: Unique string generated for each modification of this lookup
          readOnly: true
        mode:
          type: string
          title: Mode
          default: memory
          enum:
            - memory
            - disk
          x-speakeasy-unknown-values: allow
        pendingTask:
          type: object
          readOnly: true
          properties:
            id:
              type: string
              description: Task ID (generated).
              readOnly: true
            type:
              type: string
              description: Task type
              enum:
                - IMPORT
                - INDEX
              readOnly: true
              x-speakeasy-unknown-values: allow
            error:
              type: string
              description: Error message if task has failed
              readOnly: true
      anyOf:
        - properties:
            fileInfo:
              type: object
              required:
                - filename
              properties:
                filename:
                  type: string
                  pattern: ^\w[\w .-]+$
        - properties:
            content:
              type: string
              description: File content.
    Context:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - project
            - pack
          x-speakeasy-unknown-values: allow
      required:
        - id
        - type
    LookupCloneBody:
      type: object
      properties:
        context:
          $ref: "#/components/schemas/Context"
        newId:
          type: string
      required:
        - context
        - newId
    LookupFileInfoResponse:
      type: object
      properties:
        filename:
          type: string
        rows:
          type: number
        size:
          type: number
      required:
        - filename
        - rows
        - size
    LookupFileInfo:
      type: object
      required:
        - filename
      properties:
        filename:
          type: string
          pattern: ^\w[\w .-]+$
    ParserLibEntry:
      type: object
      additionalProperties: true
      required:
        - id
        - type
      properties:
        id:
          type: string
          title: ID
          pattern: ^[a-zA-Z0-9_-]+$
        lib:
          type: string
          title: Library
        description:
          type: string
          title: Description
        tags:
          type: string
          title: Tags
          description: Optionally, add tags that you can use for filtering
        type:
          title: Type
          description: Parser or formatter type to use
          type: string
          enum:
            - csv
            - elff
            - clf
            - kvp
            - json
            - delim
            - regex
            - grok
          x-speakeasy-enum-descriptions:
            - CSV
            - Extended Log File Format
            - Common Log Format
            - Key=Value Pairs
            - JSON Object
            - Delimited values
            - Regular Expression
            - Grok
          default: csv
          x-speakeasy-unknown-values: allow
    ProtobufEncodingConfig:
      type: object
      properties:
        eventModel:
          type: string
        id:
          type: string
        name:
          type: string
        wrapping:
          type: object
          properties:
            wrapperField:
              type: string
            wrapperFieldType:
              type: string
              enum:
                - single
                - array
              x-speakeasy-unknown-values: allow
            wrapperModel:
              type: string
          required:
            - wrapperField
            - wrapperFieldType
            - wrapperModel
      required:
        - eventModel
        - id
        - name
    ProtobufBytesConversion:
      type: string
      enum:
        - buffer
        - array
        - string
      x-speakeasy-unknown-values: allow
    ProtobufEnumConversion:
      type: string
      enum:
        - string
        - number
      x-speakeasy-unknown-values: allow
    ProtobufLongConversion:
      type: string
      enum:
        - number
        - string
        - object
      x-speakeasy-unknown-values: allow
    ProtobufLibraryConversionConfig:
      type: object
      properties:
        arrays:
          type: boolean
        bytes:
          $ref: "#/components/schemas/ProtobufBytesConversion"
        defaults:
          type: boolean
        enums:
          $ref: "#/components/schemas/ProtobufEnumConversion"
        json:
          type: boolean
        longs:
          $ref: "#/components/schemas/ProtobufLongConversion"
        objects:
          type: boolean
        oneofs:
          type: boolean
    ProtobufLibraryConfig:
      type: object
      properties:
        availableEncodings:
          type: array
          items:
            $ref: "#/components/schemas/ProtobufEncodingConfig"
        conversion:
          $ref: "#/components/schemas/ProtobufLibraryConversionConfig"
        dependsOn:
          type: array
          items:
            type: string
        description:
          type: string
        id:
          type: string
        name:
          type: string
        tags:
          type: string
      required:
        - dependsOn
        - description
        - id
        - name
    RegexLibEntry:
      type: object
      additionalProperties: false
      required:
        - id
        - regex
      properties:
        id:
          type: string
          title: ID
          pattern: ^[a-zA-Z0-9_-]+$
        lib:
          type: string
          title: Library
        description:
          type: string
          title: Description
        regex:
          type: string
          title: Regex pattern
        sampleData:
          type: string
          title: Sample data
          description: Optionally, paste in sample data to match against this regex
          maxLength: 4096
        tags:
          type: string
          title: Tags
    SensitiveDataContextKeyword:
      type: object
      properties:
        keyword:
          type: string
        placement:
          type: string
          enum:
            - before
            - after
          x-speakeasy-unknown-values: allow
      required:
        - keyword
    SensitiveDataRule:
      type: object
      properties:
        contextKeywords:
          type: array
          items:
            $ref: "#/components/schemas/SensitiveDataContextKeyword"
        description:
          type: string
        id:
          type: string
        lib:
          $ref: "#/components/schemas/CriblLib"
        regex:
          type: string
        rulesets:
          type: array
          items:
            type: string
      required:
        - id
        - regex
        - rulesets
    SensitiveDataRuleset:
      type: object
      properties:
        count:
          type: number
        id:
          type: string
        lib:
          type: string
      required:
        - id
    DataSample:
      type: object
      additionalProperties: true
      required:
        - id
        - sampleName
      properties:
        id:
          type: string
          title: ID
        sampleName:
          type: string
          title: File name
        pipelineId:
          type: string
          title: Associate with Pipeline
          description: Select a pipeline to associate with sample with. Select GLOBAL if
            not sure. Deprecated.
        description:
          type: string
          title: Description
          description: Brief description of this sample file. Optional.
        ttl:
          type: number
          title: Expiration (hours)
          description: Time to live (TTL) for the sample; reset after each use. Leave
            empty to never expire.
        tags:
          type: string
          title: Tags
          description: One or more tags related to this sample file. Optional.
    SampleContent:
      type: array
      items:
        type: object
        additionalProperties: true
    ElementConfigType:
      type: object
      additionalProperties: true
    DashboardLayout:
      type: object
      properties:
        h:
          type: number
        w:
          type: number
        x:
          type: number
        y:
          type: number
      required:
        - h
        - w
        - x
        - y
    SavesSearchRunMode:
      type: string
      enum:
        - newSearch
        - lastRun
      x-speakeasy-unknown-values: allow
    ExpectedOutputType:
      type: string
      enum:
        - range
        - instant
      x-speakeasy-unknown-values: allow
    PanelQueryDefinition:
      type: object
      properties:
        alias:
          type: string
        localId:
          type: string
        query:
          type: string
      required:
        - localId
        - query
    SearchQuery:
      oneOf:
        - type: object
          properties:
            query:
              type: string
            queryId:
              type: string
            runMode:
              $ref: "#/components/schemas/SavesSearchRunMode"
            type:
              type: string
              enum:
                - saved
              x-speakeasy-unknown-values: allow
          required:
            - queryId
            - type
        - type: object
          properties:
            earliest:
              oneOf:
                - type: string
                - type: number
            expectedOutputType:
              $ref: "#/components/schemas/ExpectedOutputType"
            latest:
              oneOf:
                - type: string
                - type: number
            parentSearchId:
              type: string
            query:
              type: string
            sampleRate:
              type: number
            timezone:
              type: string
            type:
              type: string
              enum:
                - inline
              x-speakeasy-unknown-values: allow
          required:
            - earliest
            - latest
            - query
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - values
              x-speakeasy-unknown-values: allow
            values:
              type: array
              items:
                type: string
          required:
            - type
            - values
        - type: object
          properties:
            type:
              type: string
              enum:
                - empty
              x-speakeasy-unknown-values: allow
          required:
            - type
        - type: object
          properties:
            earliest:
              oneOf:
                - type: string
                - type: number
            expectedOutputType:
              $ref: "#/components/schemas/ExpectedOutputType"
            latest:
              oneOf:
                - type: string
                - type: number
            queries:
              type: array
              items:
                $ref: "#/components/schemas/PanelQueryDefinition"
            timezone:
              type: string
            type:
              type: string
              enum:
                - metric
              x-speakeasy-unknown-values: allow
          required:
            - earliest
            - latest
            - queries
            - type
    TitleAction:
      type: object
      properties:
        label:
          type: string
        openInNewTab:
          type: boolean
        url:
          type: string
      required:
        - label
        - url
    VisualizationElementType:
      type: string
      enum:
        - chart.area
        - chart.column
        - chart.funnel
        - chart.gauge
        - chart.horizontalBar
        - chart.line
        - chart.map
        - chart.pie
        - chart.scatter
        - counter.single
        - list.events
        - list.table
        - custom.throughputMetrics
        - custom.flowMatrix
      x-speakeasy-unknown-values: allow
    InputElementType:
      type: string
      enum:
        - input.timerange
        - input.dropdown
        - input.text
        - input.number
      x-speakeasy-unknown-values: allow
    MarkdownElementConfig:
      type: object
      properties:
        markdown:
          type: string
      required:
        - markdown
    MarkdownElementType:
      type: string
      enum:
        - markdown.copilot
        - markdown.default
      x-speakeasy-unknown-values: allow
    DashboardElement:
      oneOf:
        - type: object
          properties:
            config:
              $ref: "#/components/schemas/ElementConfigType"
            description:
              type: string
            empty:
              type: boolean
            group:
              type: string
            hidePanel:
              type: boolean
            horizontalChart:
              type: boolean
            id:
              type: string
            index:
              type: number
            layout:
              $ref: "#/components/schemas/DashboardLayout"
            search:
              $ref: "#/components/schemas/SearchQuery"
            title:
              type: string
            titleAction:
              $ref: "#/components/schemas/TitleAction"
            type:
              $ref: "#/components/schemas/VisualizationElementType"
            variant:
              type: string
              enum:
                - visualization
              x-speakeasy-unknown-values: allow
          required:
            - id
            - layout
            - search
            - type
        - type: object
          properties:
            description:
              type: string
            empty:
              type: boolean
            group:
              type: string
            hidePanel:
              type: boolean
            horizontalChart:
              type: boolean
            id:
              type: string
            index:
              type: number
            inputId:
              type: string
            layout:
              $ref: "#/components/schemas/DashboardLayout"
            search:
              $ref: "#/components/schemas/SearchQuery"
            title:
              type: string
            titleAction:
              $ref: "#/components/schemas/TitleAction"
            type:
              $ref: "#/components/schemas/InputElementType"
            value:
              type: object
              additionalProperties: true
            variant:
              type: string
              enum:
                - input
              x-speakeasy-unknown-values: allow
          required:
            - id
            - inputId
            - layout
            - type
        - type: object
          properties:
            config:
              $ref: "#/components/schemas/MarkdownElementConfig"
            description:
              type: string
            empty:
              type: boolean
            group:
              type: string
            hidePanel:
              type: boolean
            horizontalChart:
              type: boolean
            id:
              type: string
            index:
              type: number
            layout:
              $ref: "#/components/schemas/DashboardLayout"
            title:
              type: string
            titleAction:
              $ref: "#/components/schemas/TitleAction"
            type:
              $ref: "#/components/schemas/MarkdownElementType"
            variant:
              type: string
              enum:
                - markdown
              x-speakeasy-unknown-values: allow
          required:
            - id
            - layout
            - type
            - variant
    DashboardElements:
      type: array
      items:
        $ref: "#/components/schemas/DashboardElement"
    DashboardGroups:
      type: object
      additionalProperties:
        type: object
        properties:
          action:
            type: object
            properties:
              label:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              target:
                type: string
            required:
              - label
              - target
          collapsed:
            type: boolean
          inputId:
            type: string
          title:
            type: string
        required:
          - title
    SavedQuerySchedule:
      type: object
      properties:
        cronSchedule:
          type: string
        enabled:
          type: boolean
        keepLastN:
          type: number
        notifications:
          type: object
          properties:
            disabled:
              type: boolean
            items:
              type: array
              items:
                $ref: "#/components/schemas/Notification"
          required:
            - disabled
        resumeMissed:
          type: boolean
        resumeOnBoot:
          type: boolean
        tz:
          type: string
      required:
        - cronSchedule
        - enabled
        - keepLastN
        - tz
    SearchDashboard:
      type: object
      properties:
        autoApplyDebounceMs:
          type: number
        autoApplyMode:
          type: string
          enum:
            - metric
            - all
            - off
          x-speakeasy-unknown-values: allow
        autoApplyUrlSync:
          type: string
          enum:
            - push
            - replace
            - off
          x-speakeasy-unknown-values: allow
        cacheTTLSeconds:
          type: number
        category:
          type: string
        created:
          type: number
        createdBy:
          type: string
        description:
          type: string
        displayCreatedBy:
          type: string
        displayModifiedBy:
          type: string
        elements:
          $ref: "#/components/schemas/DashboardElements"
        groups:
          $ref: "#/components/schemas/DashboardGroups"
        id:
          type: string
        modified:
          type: number
        modifiedBy:
          type: string
        name:
          type: string
        packId:
          type: string
        refreshRate:
          type: number
        resolvedDatasetIds:
          type: array
          items:
            type: string
        schedule:
          $ref: "#/components/schemas/SavedQuerySchedule"
      required:
        - created
        - createdBy
        - elements
        - id
        - modified
        - name
    SearchMacro:
      type: object
      properties:
        created:
          type: number
        createdBy:
          type: string
        description:
          type: string
        id:
          type: string
        modified:
          type: number
        replacement:
          type: string
        tags:
          type: string
      required:
        - id
        - replacement
    AreaStyleOption:
      type: object
      properties:
        opacity:
          type: number
        shadowBlur:
          type: number
        shadowColor:
          type: string
        shadowOffsetX:
          type: number
        shadowOffsetY:
          type: number
    ChartData:
      type: array
      items:
        type: object
    ChartType:
      type: string
      enum:
        - area
        - column
        - events
        - funnel
        - gauge
        - horizontalBar
        - line
        - map
        - pie
        - scatter
        - single
        - table
      x-speakeasy-unknown-values: allow
    ChartSeries:
      type: object
      properties:
        areaStyle:
          $ref: "#/components/schemas/AreaStyleOption"
        color:
          type: string
        data:
          $ref: "#/components/schemas/ChartData"
        map:
          type: string
        name:
          type: string
        type:
          $ref: "#/components/schemas/ChartType"
        yAxisField:
          type: string
      required:
        - name
    ChartConfig:
      type: object
      properties:
        applyThreshold:
          type: boolean
        axis:
          type: object
          properties:
            xAxis:
              type: string
            yAxis:
              type: array
              items:
                type: string
            yAxisExcluded:
              type: array
              items:
                type: string
        color:
          type: string
        colorPalette:
          type: number
        colorPaletteReversed:
          type: boolean
        colorThresholds:
          type: object
          properties:
            thresholds:
              type: array
              items:
                type: object
                properties:
                  color:
                    type: string
                  threshold:
                    type: number
                required:
                  - color
                  - threshold
          required:
            - thresholds
        customData:
          type: object
          properties:
            connectNulls:
              type: string
            dataFields:
              type: array
              items:
                type: string
            isPointColor:
              type: boolean
            limitToTopN:
              type: number
            lines:
              type: boolean
            nameField:
              type: string
            pointColorPalette:
              type: number
            pointColorPaletteReversed:
              type: boolean
            pointScale:
              oneOf:
                - type: string
                - type: number
            pointScaleDataField:
              type: string
            seriesCount:
              type: number
            splitBy:
              type: string
            stack:
              type: boolean
            summarizeOthers:
              type: boolean
            trellis:
              type: boolean
        decimals:
          type: number
        label:
          type: string
        legend:
          type: object
          properties:
            position:
              type: string
            selected:
              type: object
              additionalProperties:
                type: boolean
            truncate:
              type: boolean
        mapDetails:
          type: object
          properties:
            latitudeField:
              type: string
            longitudeField:
              type: string
            mapSourceID:
              type: string
            mapType:
              type: string
            nameField:
              type: string
            pointScale:
              oneOf:
                - type: string
                - type: number
            valueField:
              type: string
        onClickAction:
          type: object
          properties:
            search:
              type: string
            selectedDashboardId:
              type: string
            selectedInputId:
              type: string
            selectedLinkId:
              type: string
            selectedTimerangeInputId:
              type: string
            type:
              type: string
        prefix:
          type: string
        separator:
          type: boolean
        series:
          type: array
          items:
            $ref: "#/components/schemas/ChartSeries"
        seriesInfo:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/ChartType"
        shouldApplyUserChartSettings:
          type: boolean
        style:
          type: boolean
        suffix:
          type: string
        type:
          type: string
        xAxis:
          type: object
          properties:
            dataField:
              type: string
            inverse:
              type: boolean
            labelInterval:
              type: string
            labelOrientation:
              type: number
            name:
              type: string
            offset:
              type: number
            position:
              type: string
            type:
              type: string
        yAxis:
          type: object
          properties:
            dataField:
              type: array
              items:
                type: string
            interval:
              type: number
            max:
              type: number
            min:
              type: number
            position:
              type: string
            scale:
              type: string
            splitLine:
              type: boolean
            type:
              type: string
      required:
        - colorPalette
        - type
    SavedQuery:
      type: object
      properties:
        chartConfig:
          $ref: "#/components/schemas/ChartConfig"
        description:
          type: string
        displayUsername:
          type: string
        earliest:
          type: string
        id:
          type: string
        isPrivate:
          type: boolean
        isSystem:
          type: boolean
        latest:
          type: string
        lib:
          $ref: "#/components/schemas/CriblLib"
        name:
          type: string
        query:
          type: string
        resolvedDatasetIds:
          type: array
          items:
            type: string
        sampleRate:
          type: number
        schedule:
          $ref: "#/components/schemas/SavedQuerySchedule"
        searchJobSource:
          type: string
          enum:
            - command
            - standard
            - scheduled
            - datatypePreview
            - dashboard
            - notebook
            - systemInsights
          x-speakeasy-unknown-values: allow
        tableConfig:
          type: object
          additionalProperties: true
        user:
          type: string
      required:
        - id
        - name
        - query
    CPUTimeMetric:
      type: object
      properties:
        billableCPUSeconds:
          type: number
        executorsCPUSeconds:
          type: object
          additionalProperties:
            type: number
        totalCPUSeconds:
          type: number
        totalExecCPUSeconds:
          type: number
      required:
        - executorsCPUSeconds
        - totalCPUSeconds
        - totalExecCPUSeconds
    EventBreakerRuleset:
      type: object
      additionalProperties: false
      required:
        - id
      properties:
        id:
          type: string
          title: ID
          pattern: ^[a-zA-Z0-9\-_ ]+$
        lib:
          type: string
          title: Library
          enum:
            - custom
            - cribl-custom
          default: custom
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        tags:
          type: string
          title: Tags
        minRawLength:
          type: number
          title: Min raw length
          description: The  minimum number of characters in _raw to determine which rule
            to use
          default: 256
          minimum: 50
          maximum: 100000
        rules:
          type: array
          title: Rules
          description: A list of rules that will be applied, in order, to the input data
            stream
          items:
            type: object
            required:
              - name
              - type
              - condition
              - timestampAnchorRegex
              - timestamp
            properties:
              name:
                type: string
                title: Name
              condition:
                type: string
                title: Filter condition
                description: JavaScript expression applied to the beginning of a file or object,
                  to determine whether the rule applies to all contained events.
                default: "true"
              type:
                type: string
                title: Event Breaker type
                enum:
                  - regex
                  - json
                  - json_array
                  - header
                  - timestamp
                  - csv
                  - aws_cloudtrail
                  - aws_vpcflow
                x-speakeasy-enum-descriptions:
                  - Regex
                  - JSON Newline Delimited
                  - JSON Array
                  - File Header
                  - Timestamp
                  - CSV
                  - AWS CloudTrail
                  - AWS VPC Flow Log
                default: regex
                x-speakeasy-unknown-values: allow
              timestampAnchorRegex:
                type: string
                title: Timestamp anchor
                description: The regex to match before attempting timestamp extraction. Use $
                  (end-of-string anchor) to prevent extraction.
                default: /^/
              timestamp:
                type: object
                required:
                  - type
                title: Timestamp format
                description: Auto, manual format (strptime), or current time
                properties:
                  type:
                    type: string
                    title: Timestamp type
                    default: auto
                    enum:
                      - auto
                      - format
                      - current
                    x-speakeasy-unknown-values: allow
                  length:
                    type: number
                    title: Length
                    minimum: 2
                    default: 150
                  format:
                    type: string
                    title: Format
              timestampTimezone:
                type: string
                title: Default timezone
                description: Timezone to assign to timestamps without timezone info
                default: local
              timestampEarliest:
                title: Earliest timestamp allowed
                description: "The earliest timestamp value allowed relative to now. Example:
                  -42years. Parsed values prior to this date will be set to
                  current time."
                type: string
                default: -420weeks
              timestampLatest:
                title: Future timestamp allowed
                description: "The latest timestamp value allowed relative to now. Example:
                  +42days. Parsed values after this date will be set to current
                  time."
                type: string
                default: +1week
              maxEventBytes:
                type: number
                title: Max event bytes
                description: The maximum number of bytes in an event before it is flushed to the
                  pipelines
                default: 51200
                minimum: 1
                maximum: 134217728
              fields:
                title: Fields
                description: Key-value pairs to be added to each event
                type: array
                items:
                  type: object
                  required:
                    - value
                  properties:
                    name:
                      type: string
                      title: Name
                    value:
                      type: string
                      title: Value expression
                      description: The JavaScript expression used to compute the field's value (can be
                        constant)
              disabled:
                title: Disabled
                type: boolean
                default: false
                description: Disable this breaker rule (enabled by default)
              parserEnabled:
                title: Parser
                type: boolean
                default: false
              shouldUseDataRaw:
                title: Data _raw
                type: boolean
                default: false
                description: Enable to set an internal field on events indicating that the field
                  in the data called _raw should be used. This can be useful for
                  post processors that want to use that field for event._raw,
                  instead of replacing it with the actual raw event.
    DatatypeOverrides:
      type: object
      properties:
        breakerRulesets:
          type: array
          items:
            $ref: "#/components/schemas/EventBreakerRuleset"
        disableBreakers:
          type: boolean
      required:
        - disableBreakers
    SearchJobErrorStateConfig:
      type: object
      properties:
        coordinated:
          type: boolean
        errorMessages:
          type: array
          items:
            type: string
      required:
        - coordinated
        - errorMessages
    SearchJobMetadata:
      type: object
      properties:
        arguments:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              additionalProperties:
                type: string
        computeTypes:
          type: object
          properties:
            v1:
              type: number
            v2:
              type: number
            lakehouse:
              type: number
        datasets:
          type: object
          additionalProperties:
            type: number
        functions:
          type: object
          additionalProperties:
            type: number
        operators:
          type: object
          additionalProperties:
            type: number
        providerTypes:
          type: object
          additionalProperties:
            type: number
        providers:
          type: object
          additionalProperties:
            type: number
    SearchParameterValue:
      oneOf:
        - type: string
        - type: number
        - type: boolean
    SearchParameterType:
      type: string
      enum:
        - string
        - number
        - boolean
      x-speakeasy-unknown-values: allow
    SearchParameter:
      type: object
      properties:
        defaultValue:
          $ref: "#/components/schemas/SearchParameterValue"
        name:
          type: string
        type:
          $ref: "#/components/schemas/SearchParameterType"
      required:
        - name
        - type
    SearchParameters:
      type: object
      additionalProperties:
        oneOf:
          - type: string
          - type: number
          - type: boolean
    CacheStatusByDatasetId:
      type: object
      additionalProperties:
        oneOf:
          - type: object
            properties:
              usedCache:
                type: boolean
                enum:
                  - true
                x-speakeasy-unknown-values: allow
            required:
              - usedCache
          - type: object
            properties:
              reason:
                type: string
              usedCache:
                type: boolean
                enum:
                  - false
                x-speakeasy-unknown-values: allow
            required:
              - reason
              - usedCache
    StageId:
      type: string
    StageDependencyType:
      type: string
      enum:
        - stage
        - stage-scalar
      x-speakeasy-unknown-values: allow
    StageDependency:
      type: object
      properties:
        dependentFields:
          type: array
          items:
            type: string
        id:
          $ref: "#/components/schemas/StageId"
        type:
          $ref: "#/components/schemas/StageDependencyType"
      required:
        - id
        - type
    JobExecutionWarning:
      type: object
      properties:
        text:
          type: string
        type:
          type: string
      required:
        - type
    LogicalPlanNodeType:
      type: string
      enum:
        - aggregate
        - dedup
        - distinct
        - extract
        - filter
        - limit
        - mv-expand
        - mv-pull
        - noop
        - pivot
        - project
        - sort
      x-speakeasy-unknown-values: allow
    LogicalPlan:
      type: object
      additionalProperties:
        type: array
        items:
          type: object
          properties:
            isPreviewableOperation:
              type: boolean
            type:
              $ref: "#/components/schemas/LogicalPlanNodeType"
          required:
            - type
    PipelineFunctionConf:
      type: object
      required:
        - id
        - conf
      additionalProperties: false
      properties:
        filter:
          title: Filter
          description: Filter that selects data to be fed through this Function
          type: string
          default: "true"
        id:
          title: ID
          description: Function ID
          type: string
        description:
          title: Description
          description: Simple description of this step
          type: string
        disabled:
          title: Disabled
          description: If true, data will not be pushed through this function
          type: boolean
        final:
          title: Final
          description: If enabled, stops the results of this Function from being passed to
            the downstream Functions
          type: boolean
        conf:
          type: object
          title: Function-specific configs
          properties: {}
        groupId:
          title: Group ID
          description: Group ID
          type: string
    Pipeline:
      title: Pipeline Settings
      type: object
      required:
        - conf
        - id
      properties:
        id:
          title: ID
          type: string
        conf:
          type: object
          additionalProperties: false
          properties:
            asyncFuncTimeout:
              type: integer
              title: Async function timeout (ms)
              description: Time (in ms) to wait for an async function to complete processing
                of a data item
              minimum: 0
              maximum: 10000
            output:
              type: string
              title: Output event destination
              description: The output destination for events processed by this Pipeline
              default: default
            description:
              title: Description
              type: string
            streamtags:
              type: array
              title: Tags
              description: Tags for filtering and grouping in @{product}
              default: []
              items:
                type: string
            functions:
              title: Functions
              description: List of Functions to pass data through
              type: array
              items:
                $ref: "#/components/schemas/PipelineFunctionConf"
            groups:
              type: object
              additionalProperties:
                type: object
                required:
                  - name
                properties:
                  name:
                    type: string
                    title: Group Name
                  description:
                    type: string
                    title: Description
                    description: Short description of this group
                  disabled:
                    type: boolean
                    title: Disabled
                    description: Whether this group is disabled
    ColumnPath:
      type: array
      items:
        type: string
    SearchTerm:
      type: object
      properties:
        isCaseSensitive:
          type: boolean
        term:
          type: string
      required:
        - isCaseSensitive
        - term
    SortByField:
      type: object
      properties:
        direction:
          type: string
          enum:
            - ascending
            - descending
          x-speakeasy-unknown-values: allow
        fieldName:
          type: string
        nullPosition:
          type: string
          enum:
            - nullsFirst
            - nullsLast
          x-speakeasy-unknown-values: allow
      required:
        - direction
        - fieldName
        - nullPosition
    SearchConfig:
      type: object
      properties:
        canComputeMetadataDistributively:
          type: boolean
        datasets:
          type: array
          items:
            type: string
        hasSendOperator:
          type: boolean
        logicalPlans:
          type: object
          properties:
            Combined:
              $ref: "#/components/schemas/LogicalPlan"
            Coordinated:
              $ref: "#/components/schemas/LogicalPlan"
            Federated:
              $ref: "#/components/schemas/LogicalPlan"
        orderedFieldNames:
          type: array
          items:
            type: string
        pipelines:
          type: object
          properties:
            Combined:
              $ref: "#/components/schemas/Pipeline"
            Coordinated:
              $ref: "#/components/schemas/Pipeline"
            Federated:
              $ref: "#/components/schemas/Pipeline"
        referencedColumnPaths:
          type: array
          items:
            $ref: "#/components/schemas/ColumnPath"
        searchTerms:
          type: array
          items:
            $ref: "#/components/schemas/SearchTerm"
        sortFields:
          type: array
          items:
            $ref: "#/components/schemas/SortByField"
        useFormattedVisualization:
          type: boolean
      required:
        - datasets
        - hasSendOperator
        - logicalPlans
        - orderedFieldNames
        - pipelines
        - searchTerms
        - useFormattedVisualization
    SearchJobStageConfig:
      type: object
      properties:
        cacheStatusByDatasetId:
          $ref: "#/components/schemas/CacheStatusByDatasetId"
        dependencies:
          type: array
          items:
            $ref: "#/components/schemas/StageDependency"
        earliest:
          oneOf:
            - type: string
            - type: number
        executionWarnings:
          type: array
          items:
            $ref: "#/components/schemas/JobExecutionWarning"
        filter:
          type: string
        id:
          type: string
        latest:
          oneOf:
            - type: string
            - type: number
        resolvedDatasetIds:
          type: array
          items:
            type: string
        searchConfig:
          $ref: "#/components/schemas/SearchConfig"
        searchVersionByDatasetId:
          type: object
          additionalProperties:
            type: string
            enum:
              - v1
              - v2
            x-speakeasy-unknown-values: allow
        status:
          type: string
          enum:
            - failed
            - new
            - running
            - completed
            - canceled
            - queued
          x-speakeasy-unknown-values: allow
        subQueryText:
          type: string
      required:
        - dependencies
        - filter
        - id
        - resolvedDatasetIds
        - searchConfig
        - status
        - subQueryText
    ColumnSetting:
      type: object
      additionalProperties: true
    ColumnFilterSettings:
      type: object
      properties:
        contains:
          $ref: "#/components/schemas/ColumnSetting"
      required:
        - contains
    ColumnFormatSettings:
      type: object
      properties:
        palette:
          $ref: "#/components/schemas/ColumnSetting"
        precision:
          $ref: "#/components/schemas/ColumnSetting"
        prefix:
          $ref: "#/components/schemas/ColumnSetting"
        suffix:
          $ref: "#/components/schemas/ColumnSetting"
      required:
        - palette
        - precision
        - prefix
        - suffix
    ColumnOrderSettings:
      type: object
      properties:
        order:
          $ref: "#/components/schemas/ColumnSetting"
      required:
        - order
    ColumnSortSettings:
      type: object
      properties:
        sort:
          $ref: "#/components/schemas/ColumnSetting"
      required:
        - sort
    TableViewSettings:
      type: object
      properties:
        columnFilterSettings:
          $ref: "#/components/schemas/ColumnFilterSettings"
        columnFormatSettings:
          $ref: "#/components/schemas/ColumnFormatSettings"
        columnOrderSettings:
          $ref: "#/components/schemas/ColumnOrderSettings"
        columnSortSettings:
          $ref: "#/components/schemas/ColumnSortSettings"
        eventDetailsPanel:
          type: boolean
        eventTableFields:
          type: array
          items:
            type: string
        rowNumberColumnWidth:
          type: number
        showColumnTotals:
          type: boolean
        showColumnTotalsPinned:
          type: boolean
        showRowNumbers:
          type: boolean
        showRowTotals:
          type: boolean
        showRowTotalsPinned:
          type: boolean
        wrapCells:
          type: boolean
      required:
        - showColumnTotals
        - showColumnTotalsPinned
        - showRowNumbers
        - showRowTotals
        - showRowTotalsPinned
        - wrapCells
    SearchAuditMetrics:
      type: object
      properties:
        bytesIn:
          type: number
        bytesOut:
          type: number
        eventsIn:
          type: number
        eventsOut:
          type: number
        objects:
          type: object
          properties:
            discovered:
              type: number
            scanned:
              type: number
            skipped:
              type: number
          required:
            - discovered
            - scanned
            - skipped
        tasks:
          type: object
          properties:
            largeFileTaskCount:
              type: number
            standardTaskCount:
              type: number
          required:
            - largeFileTaskCount
            - standardTaskCount
        time:
          type: object
          properties:
            queuedSec:
              type: number
            runningSec:
              type: number
            taskCompletionTotalSec:
              type: number
            taskReceivingTotalSec:
              type: number
          required:
            - queuedSec
            - runningSec
            - taskCompletionTotalSec
            - taskReceivingTotalSec
      required:
        - bytesIn
        - bytesOut
        - eventsIn
        - eventsOut
        - objects
        - time
    SearchJob:
      type: object
      properties:
        accelerated:
          type: boolean
        aliasOfOriginalJobId:
          type: string
        chartConfig:
          type: object
          properties:
            applyThreshold:
              type: boolean
            axis:
              type: object
              properties:
                xAxis:
                  type: string
                yAxis:
                  type: array
                  items:
                    type: string
                yAxisExcluded:
                  type: array
                  items:
                    type: string
            color:
              type: string
            colorPalette:
              type: number
            colorPaletteReversed:
              type: boolean
            colorThresholds:
              type: object
              properties:
                thresholds:
                  type: array
                  items:
                    type: object
                    properties:
                      color:
                        type: string
                      threshold:
                        type: number
                    required:
                      - color
                      - threshold
              required:
                - thresholds
            customData:
              type: object
              properties:
                connectNulls:
                  type: string
                dataFields:
                  type: array
                  items:
                    type: string
                isPointColor:
                  type: boolean
                limitToTopN:
                  type: number
                lines:
                  type: boolean
                nameField:
                  type: string
                pointColorPalette:
                  type: number
                pointColorPaletteReversed:
                  type: boolean
                pointScale:
                  oneOf:
                    - type: string
                    - type: number
                pointScaleDataField:
                  type: string
                seriesCount:
                  type: number
                splitBy:
                  type: string
                stack:
                  type: boolean
                summarizeOthers:
                  type: boolean
                trellis:
                  type: boolean
            decimals:
              type: number
            label:
              type: string
            legend:
              type: object
              properties:
                position:
                  type: string
                selected:
                  type: object
                  additionalProperties:
                    type: boolean
                truncate:
                  type: boolean
            mapDetails:
              type: object
              properties:
                latitudeField:
                  type: string
                longitudeField:
                  type: string
                mapSourceID:
                  type: string
                mapType:
                  type: string
                nameField:
                  type: string
                pointScale:
                  oneOf:
                    - type: string
                    - type: number
                valueField:
                  type: string
            onClickAction:
              type: object
              properties:
                search:
                  type: string
                selectedDashboardId:
                  type: string
                selectedInputId:
                  type: string
                selectedLinkId:
                  type: string
                selectedTimerangeInputId:
                  type: string
                type:
                  type: string
            prefix:
              type: string
            separator:
              type: boolean
            series:
              type: array
              items:
                $ref: "#/components/schemas/ChartSeries"
            seriesInfo:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/ChartType"
            shouldApplyUserChartSettings:
              type: boolean
            style:
              type: boolean
            suffix:
              type: string
            type:
              type: string
            xAxis:
              type: object
              properties:
                dataField:
                  type: string
                inverse:
                  type: boolean
                labelInterval:
                  type: string
                labelOrientation:
                  type: number
                name:
                  type: string
                offset:
                  type: number
                position:
                  type: string
                type:
                  type: string
            yAxis:
              type: object
              properties:
                dataField:
                  type: array
                  items:
                    type: string
                interval:
                  type: number
                max:
                  type: number
                min:
                  type: number
                position:
                  type: string
                scale:
                  type: string
                splitLine:
                  type: boolean
                type:
                  type: string
        compatibilityChecks:
          type: object
          properties:
            datatypes:
              type: boolean
            stageIds:
              type: array
              items:
                type: string
        completionInfo:
          type: string
        context:
          type: string
        correlationId:
          type: string
        cpuMetrics:
          $ref: "#/components/schemas/CPUTimeMetric"
        datatypeOverrides:
          $ref: "#/components/schemas/DatatypeOverrides"
        disableNotifications:
          type: boolean
        displayUsername:
          type: string
        earliest:
          oneOf:
            - type: string
            - type: number
        earliestEpoch:
          type: number
        errorStateConfig:
          $ref: "#/components/schemas/SearchJobErrorStateConfig"
        group:
          type: string
        id:
          type: string
        isPrivate:
          type: boolean
        latest:
          oneOf:
            - type: string
            - type: number
        latestEpoch:
          type: number
        metadata:
          $ref: "#/components/schemas/SearchJobMetadata"
        notebookId:
          type: string
        numEventsAfter:
          type: number
        numEventsBefore:
          type: number
        query:
          type: string
        queryWithMacrosResolved:
          type: string
        sampleRate:
          type: number
        savedQueryName:
          type: string
        searchParameterDeclarations:
          type: array
          items:
            $ref: "#/components/schemas/SearchParameter"
        searchParameterValues:
          $ref: "#/components/schemas/SearchParameters"
        setOptions:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: number
        stages:
          type: array
          items:
            $ref: "#/components/schemas/SearchJobStageConfig"
        status:
          type: string
          enum:
            - failed
            - new
            - running
            - completed
            - canceled
            - queued
          x-speakeasy-unknown-values: allow
        tableConfig:
          $ref: "#/components/schemas/TableViewSettings"
        targetEventTime:
          type: number
        timeCompleted:
          type: number
        timeCreated:
          type: number
        timeStarted:
          type: number
        timeToFirstByte:
          type: number
        totalBytesScanned:
          type: number
        totalEventCount:
          type: number
        type:
          type: string
          enum:
            - command
            - standard
            - scheduled
            - datatypePreview
            - dashboard
            - notebook
            - systemInsights
          x-speakeasy-unknown-values: allow
        usageGroupId:
          type: string
        usageMetrics:
          $ref: "#/components/schemas/SearchAuditMetrics"
        user:
          type: string
      required:
        - displayUsername
        - group
        - id
        - query
        - status
        - timeCreated
        - user
    CreateSearchJobSchema:
      type: object
      required:
        - query
      properties:
        query:
          type: string
          title: Query
          description: Query to execute
        earliest:
          type: number
          title: Earliest time for the query
          description: Earliest time in the query time range
        latest:
          type: number
          title: Query end time
          description: Latest time in the query time range
        numEventsBefore:
          type: number
          minimum: 0
          title: Num events before the current one to query
          description: Start of the query time range
        numEventsAfter:
          minimum: 0
          type: number
          title: Num events after the current one to query
          description: Start of the query time range
        targetEventTime:
          type: number
          title: The target event time. If set, numEventsBefore and numEventsAfter need to
            also be set
          description: Start of the query time range
        sampleRate:
          type: number
          title: Sampling Rate
          description: Number between 0 and 1 that represents a sampling rate to pick
            events for search.
          minimum: 0
          maximum: 1
          default: 1
        isPrivate:
          type: boolean
          title: Results Access
          description: Whether the results of the job are accessible to all members or
            only to the owner.
          default: true
        setOptions:
          type: object
          title: Execution Options
          description: Query execution options.
        expectedOutputType:
          type: string
          title: Expected output type
          description: Output type expected from the System Insights query
      not:
        required:
          - numEventsBefore
          - numEventsAfter
          - targetEventTime
          - earliest
          - latest
    UpdateSearchJobSchema:
      type: object
      properties:
        status:
          title: Status
          description: The new status for the job
          enum:
            - completed
            - canceled
          x-speakeasy-unknown-values: allow
        isPrivate:
          type: boolean
          title: Private results
          description: Whether the results of the job are accessible to all users or only
            to the owner.
          default: true
    SearchJobSettings:
      type: object
      properties:
        reaperKeepUntil:
          type: number
    StatusResponse:
      type: object
      properties:
        bytesIn:
          type: number
        bytesSkipped:
          type: number
        cacheStatusesByStageId:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              oneOf:
                - type: object
                  properties:
                    usedCache:
                      type: boolean
                      enum:
                        - true
                      x-speakeasy-unknown-values: allow
                  required:
                    - usedCache
                - type: object
                  properties:
                    reason:
                      type: string
                    usedCache:
                      type: boolean
                      enum:
                        - false
                      x-speakeasy-unknown-values: allow
                  required:
                    - reason
                    - usedCache
        eventsFound:
          type: number
        eventsIn:
          type: number
        eventsSkipped:
          type: number
        objectsFound:
          type: number
        objectsSearched:
          type: number
        objectsSkipped:
          type: number
        stageDetails:
          type: array
          items:
            type: object
            properties:
              cacheStatusByDatasetId:
                $ref: "#/components/schemas/CacheStatusByDatasetId"
              stageId:
                type: string
              status:
                type: string
                enum:
                  - failed
                  - new
                  - running
                  - completed
                  - canceled
                  - queued
                x-speakeasy-unknown-values: allow
            required:
              - cacheStatusByDatasetId
              - stageId
              - status
        status:
          type: string
          enum:
            - failed
            - new
            - running
            - completed
            - canceled
            - queued
          x-speakeasy-unknown-values: allow
        timeCompleted:
          type: number
        timeCreated:
          type: number
        timeNow:
          type: number
        timeStarted:
          type: number
      required:
        - status
        - timeCreated
    Bucket:
      type: object
      properties:
        duration:
          type: number
        earliest:
          type: number
        eventCount:
          type: number
      required:
        - duration
        - earliest
        - eventCount
    SearchTimeline:
      type: object
      properties:
        buckets:
          type: array
          items:
            $ref: "#/components/schemas/Bucket"
        totalEventCount:
          type: number
      required:
        - buckets
        - totalEventCount
    TopValue:
      type: object
      properties:
        count:
          type: number
        value:
          type: string
      required:
        - count
        - value
    FieldType:
      type: string
      enum:
        - array
        - boolean
        - number
        - object
        - string
        - timestamp
      x-speakeasy-unknown-values: allow
    Field:
      type: object
      properties:
        buckets:
          type: array
          items:
            $ref: "#/components/schemas/Bucket"
        count:
          type: number
        countDistinct:
          type: number
        countNull:
          type: number
        max:
          oneOf:
            - type: string
            - type: number
        mean:
          type: number
        min:
          oneOf:
            - type: string
            - type: number
        name:
          type: string
        stdev:
          type: number
        topValues:
          type: array
          items:
            $ref: "#/components/schemas/TopValue"
        type:
          $ref: "#/components/schemas/FieldType"
      required:
        - buckets
        - count
        - countDistinct
        - countNull
        - name
        - topValues
        - type
    FieldSummaries:
      type: object
      properties:
        fields:
          type: array
          items:
            $ref: "#/components/schemas/Field"
        partial:
          type: boolean
        totalEventCount:
          type: number
      required:
        - fields
        - totalEventCount
    DatabaseConnectionType:
      type: string
      enum:
        - mysql
        - oracle
        - postgres
        - sqlserver
      x-speakeasy-unknown-values: allow
    DatabaseConnectionConfig:
      type: object
      properties:
        authType:
          type: string
        configObj:
          type: string
        connectionString:
          type: string
        connectionTimeout:
          type: number
        credsSecrets:
          type: string
        databaseType:
          $ref: "#/components/schemas/DatabaseConnectionType"
        description:
          type: string
        id:
          type: string
        password:
          type: string
        requestTimeout:
          type: number
        tags:
          type: string
        user:
          type: string
      required:
        - authType
        - databaseType
        - description
        - id
    DatabaseConnectionTestResult:
      type: object
      properties:
        errorMsg:
          type: string
        success:
          type: boolean
      required:
        - success
    DatabaseConnectionTest:
      type: object
      properties:
        authType:
          type: string
        configObj:
          type: string
        connectionString:
          type: string
        connectionTimeout:
          type: number
        credsSecrets:
          type: string
        databaseType:
          type: string
        password:
          type: string
        textSecret:
          type: string
        user:
          type: string
      required:
        - authType
        - databaseType
    GlobalVar:
      type: object
      required:
        - id
        - type
      properties:
        id:
          type: string
          title: Name
          pattern: ^[a-zA-Z0-9_-]+$
          description: Global variable name
        lib:
          type: string
          title: Library
        description:
          type: string
          title: Description
        type:
          type: string
          title: Type
          enum:
            - string
            - number
            - encryptedString
            - boolean
            - array
            - object
            - expression
            - any
          x-speakeasy-enum-descriptions:
            - string
            - number
            - encrypted string
            - boolean
            - array
            - object
            - expression
            - any
          default: any
          x-speakeasy-unknown-values: allow
        value:
          type: string
          title: Value
        tags:
          type: string
          title: Tags
    HmacFunction:
      type: object
      properties:
        description:
          type: string
        headerExpression:
          type: string
        headerName:
          type: string
        id:
          type: string
        lib:
          $ref: "#/components/schemas/CriblLib"
        stringBuilders:
          type: array
          items:
            type: string
        stringDelim:
          type: string
      required:
        - headerExpression
        - headerName
        - id
        - lib
        - stringBuilders
    InputCollection:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - collection
          default: collection
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process results
        sendToRoutes:
          type: boolean
          title: Send to Routes
          description: Send events to normal routing and event processing. Disable to
            select a specific Pipeline/Destination combination.
          default: true
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        preprocess:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            command:
              type: string
              title: Command
              description: Command to feed the data through (via stdin) and process its output
                (stdout)
            args:
              type: array
              title: Arguments
              description: Arguments to be added to the custom command
              items:
                type: string
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        output:
          type: string
          title: Destination
          description: Destination to send results to
      required:
        - type
    InputKafka:
      type: object
      required:
        - type
        - brokers
        - topics
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - kafka
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        brokers:
          type: array
          title: Bootstrap servers
          description: Enter each Kafka bootstrap server you want to use. Specify the
            hostname and port (such as mykafkabroker:9092) or just the hostname
            (in which case @{product} will assign port 9092).
          minItems: 1
          items:
            type: string
            minLength: 1
        topics:
          type: array
          title: Topic
          description: "Topic to subscribe to. Warning: To optimize performance, Cribl
            suggests subscribing each Kafka Source to a single topic only."
          minItems: 1
          default: []
          items:
            type: string
            minLength: 1
        groupId:
          type: string
          default: Cribl
          title: Group ID
          description: The consumer group to which this instance belongs. Defaults to
            'Cribl'.
        fromBeginning:
          type: boolean
          default: true
          title: From beginning
          description: Leave enabled if you want the Source, upon first subscribing to a
            topic, to read starting with the earliest available message
        kafkaSchemaRegistry:
          type: object
          title: Kafka Schema Registry Authentication
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            schemaRegistryURL:
              type: string
              title: Schema Registry URL
              description: "URL for accessing the Confluent Schema Registry. Example:
                http://localhost:8081. To connect over TLS, use https instead of
                http."
              default: http://localhost:8081
            connectionTimeout:
              type: number
              title: Connection timeout (ms)
              description: Maximum time to wait for a Schema Registry connection to complete
                successfully
              default: 30000
              minimum: 1000
              maximum: 60000
            requestTimeout:
              type: number
              title: Request timeout (ms)
              description: Maximum time to wait for the Schema Registry to respond to a
                request
              default: 30000
              minimum: 1000
              maximum: 60000
            maxRetries:
              type: number
              title: Retry limit
              description: Maximum number of times to try fetching schemas from the Schema
                Registry
              default: 1
              minimum: 0
              maximum: 100
            auth:
              type: object
              description: Credentials to use when authenticating with the schema registry
                using basic HTTP authentication
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                credentialsSecret:
                  type: string
                  title: Credentials secret
                  description: Select or create a secret that references your credentials
            tls:
              type: object
              title: TLS settings (client side)
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                rejectUnauthorized:
                  type: boolean
                  title: Validate server certs
                  description: >-
                    Reject certificates that are not authorized by a CA in the
                    CA certificate path, or by another 
                                        trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
                  default: true
                servername:
                  type: string
                  title: Server name (SNI)
                  description: Server name for the SNI (Server Name Indication) TLS extension. It
                    must be a host name, and not an IP address.
                certificateName:
                  type: string
                  title: Certificate
                  description: The name of the predefined certificate
                caPath:
                  type: string
                  title: CA certificate path
                  description: Path on client in which to find CA certificates to verify the
                    server's cert. PEM format. Can reference $ENV_VARS.
                privKeyPath:
                  type: string
                  title: Private key path (mutual auth)
                  description: Path on client in which to find the private key to use. PEM format.
                    Can reference $ENV_VARS.
                certPath:
                  type: string
                  title: Certificate path (mutual auth)
                  description: Path on client in which to find certificates to use. PEM format.
                    Can reference $ENV_VARS.
                passphrase:
                  type: string
                  title: Passphrase
                  description: Passphrase to use to decrypt private key
                minVersion:
                  type: string
                  title: Minimum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
                maxVersion:
                  type: string
                  title: Maximum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        sasl:
          type: object
          title: Authentication
          description: Authentication parameters to use when connecting to brokers. Using
            TLS is highly recommended.
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            authType:
              enum:
                - manual
                - secret
              title: Authentication method
              type: string
              default: manual
              description: Enter credentials directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            mechanism:
              enum:
                - plain
                - scram-sha-256
                - scram-sha-512
                - kerberos
              type: string
              default: plain
              x-speakeasy-enum-descriptions:
                - PLAIN
                - SCRAM-SHA-256
                - SCRAM-SHA-512
                - GSSAPI/Kerberos
              title: SASL mechanism
              x-speakeasy-unknown-values: allow
            keytabLocation:
              type: string
              title: Keytab Location
              description: Location of keytab file for authentication principal
            principal:
              type: string
              title: Principal
              description: Authentication principal, such as `kafka_user@example.com`
            brokerServiceClass:
              type: string
              title: Broker service class
              description: Kerberos service class for Kafka brokers, such as `kafka`
            oauthEnabled:
              type: boolean
              title: Enable OAuth
              description: Enable OAuth authentication
              default: false
            tokenUrl:
              type: string
              title: Token URL
              description: URL of the token endpoint to use for OAuth authentication
            clientId:
              type: string
              title: Client ID
              description: Client ID to use for OAuth authentication
            oauthSecretType:
              type: string
              default: secret
            clientTextSecret:
              type: string
              title: Client secret (text secret)
              description: Select or create a stored text secret
            oauthParams:
              type: array
              title: Add OAuth Parameters
              description: Additional fields to send to the token endpoint, such as scope or
                audience
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Parameter Name
                  value:
                    type: string
                    title: Parameter Value
            saslExtensions:
              type: array
              title: Add SASL Extension Fields
              description: Additional SASL extension fields, such as Confluent's
                logicalCluster or identityPoolId
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Field Name
                  value:
                    type: string
                    title: Field Value
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        sessionTimeout:
          type: number
          title: Session timeout (ms)
          description: >2-
            
                  Timeout used to detect client failures when using Kafka's group-management facilities.
                  If the client sends no heartbeats to the broker before the timeout expires, 
                  the broker will remove the client from the group and initiate a rebalance.
                  Value must be between the broker's configured group.min.session.timeout.ms and group.max.session.timeout.ms.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#consumerconfigs_session.timeout.ms) for details.
          default: 30000
          minimum: 1000
          maximum: 3600000
        rebalanceTimeout:
          type: number
          title: Rebalance timeout (ms)
          description: >2-
            
                  Maximum allowed time for each worker to join the group after a rebalance begins.
                  If the timeout is exceeded, the coordinator broker will remove the worker from the group.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#connectconfigs_rebalance.timeout.ms) for details.
          default: 60000
          minimum: 1000
          maximum: 3600000
        heartbeatInterval:
          type: number
          title: Heartbeat interval (ms)
          description: >2-
            
                  Expected time between heartbeats to the consumer coordinator when using Kafka's group-management facilities.
                  Value must be lower than sessionTimeout and typically should not exceed 1/3 of the sessionTimeout value.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#consumerconfigs_heartbeat.interval.ms) for details.
          default: 3000
          minimum: 1000
          maximum: 3600000
        autoCommitInterval:
          type: number
          title: Offset commit interval (ms)
          description: How often to commit offsets. If both this and Offset commit
            threshold are set, @{product} commits offsets when either condition
            is met. If both are empty, @{product} commits offsets after each
            batch.
          minimum: 1000
          maximum: 3600000
        autoCommitThreshold:
          type: number
          title: Offset commit threshold
          description: How many events are needed to trigger an offset commit. If both
            this and Offset commit interval are set, @{product} commits offsets
            when either condition is met. If both are empty, @{product} commits
            offsets after each batch.
          minimum: 1
          maximum: 10000
        maxBytesPerPartition:
          type: number
          title: Byte limit, per partition
          description: Maximum amount of data that Kafka will return per partition, per
            fetch request. Must equal or exceed the maximum message size
            (maxBytesPerPartition) that Kafka is configured to allow. Otherwise,
            @{product} can get stuck trying to retrieve messages. Defaults to
            1048576 (1 MB).
          minimum: 1
          maximum: 10000000
          default: 1048576
        maxBytes:
          type: number
          title: Byte limit
          description: Maximum number of bytes that Kafka will return per fetch request.
            Defaults to 10485760 (10 MB).
          minimum: 1
          maximum: 1000000000
          default: 10485760
        maxSocketErrors:
          type: number
          title: Error limit, per socket
          description: Maximum number of network errors before the consumer re-creates a
            socket
          minimum: 0
          maximum: 100
          default: 0
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputMsk:
      type: object
      required:
        - type
        - brokers
        - topics
        - region
        - awsAuthenticationMethod
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - msk
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        brokers:
          type: array
          title: Bootstrap servers
          description: Enter each Kafka bootstrap server you want to use. Specify the
            hostname and port (such as mykafkabroker:9092) or just the hostname
            (in which case @{product} will assign port 9092).
          minItems: 1
          items:
            type: string
            minLength: 1
        topics:
          type: array
          title: Topic
          description: "Topic to subscribe to. Warning: To optimize performance, Cribl
            suggests subscribing each Kafka Source to a single topic only."
          minItems: 1
          default: []
          items:
            type: string
            minLength: 1
        groupId:
          type: string
          default: Cribl
          title: Group ID
          description: The consumer group to which this instance belongs. Defaults to
            'Cribl'.
        fromBeginning:
          type: boolean
          default: true
          title: From beginning
          description: Leave enabled if you want the Source, upon first subscribing to a
            topic, to read starting with the earliest available message
        sessionTimeout:
          type: number
          title: Session timeout (ms)
          description: >2-
            
                  Timeout used to detect client failures when using Kafka's group-management facilities.
                  If the client sends no heartbeats to the broker before the timeout expires, 
                  the broker will remove the client from the group and initiate a rebalance.
                  Value must be between the broker's configured group.min.session.timeout.ms and group.max.session.timeout.ms.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#consumerconfigs_session.timeout.ms) for details.
          default: 30000
          minimum: 1000
          maximum: 3600000
        rebalanceTimeout:
          type: number
          title: Rebalance timeout (ms)
          description: >2-
            
                  Maximum allowed time for each worker to join the group after a rebalance begins.
                  If the timeout is exceeded, the coordinator broker will remove the worker from the group.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#connectconfigs_rebalance.timeout.ms) for details.
          default: 60000
          minimum: 1000
          maximum: 3600000
        heartbeatInterval:
          type: number
          title: Heartbeat interval (ms)
          description: >2-
            
                  Expected time between heartbeats to the consumer coordinator when using Kafka's group-management facilities.
                  Value must be lower than sessionTimeout and typically should not exceed 1/3 of the sessionTimeout value.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#consumerconfigs_heartbeat.interval.ms) for details.
          default: 3000
          minimum: 1000
          maximum: 3600000
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        kafkaSchemaRegistry:
          type: object
          title: Kafka Schema Registry Authentication
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            schemaRegistryURL:
              type: string
              title: Schema Registry URL
              description: "URL for accessing the Confluent Schema Registry. Example:
                http://localhost:8081. To connect over TLS, use https instead of
                http."
              default: http://localhost:8081
            connectionTimeout:
              type: number
              title: Connection timeout (ms)
              description: Maximum time to wait for a Schema Registry connection to complete
                successfully
              default: 30000
              minimum: 1000
              maximum: 60000
            requestTimeout:
              type: number
              title: Request timeout (ms)
              description: Maximum time to wait for the Schema Registry to respond to a
                request
              default: 30000
              minimum: 1000
              maximum: 60000
            maxRetries:
              type: number
              title: Retry limit
              description: Maximum number of times to try fetching schemas from the Schema
                Registry
              default: 1
              minimum: 0
              maximum: 100
            auth:
              type: object
              description: Credentials to use when authenticating with the schema registry
                using basic HTTP authentication
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                credentialsSecret:
                  type: string
                  title: Credentials secret
                  description: Select or create a secret that references your credentials
            tls:
              type: object
              title: TLS settings (client side)
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                rejectUnauthorized:
                  type: boolean
                  title: Validate server certs
                  description: >-
                    Reject certificates that are not authorized by a CA in the
                    CA certificate path, or by another 
                                        trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
                  default: true
                servername:
                  type: string
                  title: Server name (SNI)
                  description: Server name for the SNI (Server Name Indication) TLS extension. It
                    must be a host name, and not an IP address.
                certificateName:
                  type: string
                  title: Certificate
                  description: The name of the predefined certificate
                caPath:
                  type: string
                  title: CA certificate path
                  description: Path on client in which to find CA certificates to verify the
                    server's cert. PEM format. Can reference $ENV_VARS.
                privKeyPath:
                  type: string
                  title: Private key path (mutual auth)
                  description: Path on client in which to find the private key to use. PEM format.
                    Can reference $ENV_VARS.
                certPath:
                  type: string
                  title: Certificate path (mutual auth)
                  description: Path on client in which to find certificates to use. PEM format.
                    Can reference $ENV_VARS.
                passphrase:
                  type: string
                  title: Passphrase
                  description: Passphrase to use to decrypt private key
                minVersion:
                  type: string
                  title: Minimum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
                maxVersion:
                  type: string
                  title: Maximum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the MSK cluster is located
        endpoint:
          type: string
          title: Endpoint
          description: MSK cluster service endpoint. If empty, defaults to the AWS
            Region-specific endpoint. Otherwise, it must point to MSK
            cluster-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing MSK cluster requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for MSK
          description: Use Assume Role credentials to access MSK
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        autoCommitInterval:
          type: number
          title: Offset commit interval (ms)
          description: How often to commit offsets. If both this and Offset commit
            threshold are set, @{product} commits offsets when either condition
            is met. If both are empty, @{product} commits offsets after each
            batch.
          minimum: 1000
          maximum: 3600000
        autoCommitThreshold:
          type: number
          title: Offset commit threshold
          description: How many events are needed to trigger an offset commit. If both
            this and Offset commit interval are set, @{product} commits offsets
            when either condition is met. If both are empty, @{product} commits
            offsets after each batch.
          minimum: 1
          maximum: 10000
        maxBytesPerPartition:
          type: number
          title: Byte limit, per partition
          description: Maximum amount of data that Kafka will return per partition, per
            fetch request. Must equal or exceed the maximum message size
            (maxBytesPerPartition) that Kafka is configured to allow. Otherwise,
            @{product} can get stuck trying to retrieve messages. Defaults to
            1048576 (1 MB).
          minimum: 1
          maximum: 10000000
          default: 1048576
        maxBytes:
          type: number
          title: Byte limit
          description: Maximum number of bytes that Kafka will return per fetch request.
            Defaults to 10485760 (10 MB).
          minimum: 1
          maximum: 1000000000
          default: 10485760
        maxSocketErrors:
          type: number
          title: Error limit, per socket
          description: Maximum number of network errors before the consumer re-creates a
            socket
          minimum: 0
          maximum: 100
          default: 0
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
    InputHttp:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - http
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: string
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        criblAPI:
          type: string
          title: Cribl HTTP event API
          description: Absolute path on which to listen for the Cribl HTTP API requests.
            Only _bulk (default /cribl/_bulk) is available. Use empty string to
            disable.
          default: /cribl
          pattern: ^/|^$
        elasticAPI:
          type: string
          title: Elasticsearch API endpoint (Bulk API)
          description: Absolute path on which to listen for the Elasticsearch API
            requests. Only _bulk (default /elastic/_bulk) is available. Use
            empty string to disable.
          default: /elastic
          pattern: ^/|^$
        splunkHecAPI:
          type: string
          title: Splunk HEC endpoint
          description: Absolute path on which listen for the Splunk HTTP Event Collector
            API requests. Use empty string to disable.
          default: /services/collector
          pattern: ^/|^$
        splunkHecAcks:
          type: boolean
          title: Enable Splunk HEC acknowledgements
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        authTokensExt:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: object
            required:
              - token
            properties:
              token:
                type: string
                title: Token
                description: "Shared secret to be provided by any client (Authorization:
                  <token>)"
              description:
                type: string
                title: Description
              metadata:
                type: array
                title: Fields
                description: Fields to add to events referencing this token
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputSplunk:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - splunk
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to establish a
            connection
          default: /.*/
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process.
            Use 0 for unlimited.
          default: 1000
          minimum: 0
        socketIdleTimeout:
          type: number
          title: Socket idle timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. After this time, the connection will be
            closed. Leave at 0 for no inactive socket monitoring.
          default: 0
          minimum: 0
        socketEndingMaxWait:
          type: number
          title: Forced socket termination timeout (seconds)
          description: How long the server will wait after initiating a closure for a
            client to close its end of the connection. If the client doesn't
            close the connection within this time, the server will forcefully
            terminate the socket to prevent resource leaks and ensure efficient
            connection cleanup and system stability. Leave at 0 for no inactive
            socket monitoring.
          default: 30
          minimum: 0
        socketMaxLifespan:
          type: number
          title: Socket max lifespan (seconds)
          description: The maximum duration a socket can remain open, even if active. This
            helps manage resources and mitigate issues caused by TCP pinning.
            Set to 0 to disable.
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Enable proxy protocol
          description: Enable if the connection is proxied by a device that supports proxy
            protocol v1 or v2
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        authTokens:
          type: array
          title: Auth tokens
          description: Shared secrets to be provided by any Splunk forwarder. If empty,
            unauthorized access is permitted.
          items:
            type: object
            required:
              - token
            properties:
              token:
                type: string
                title: Token
                description: Shared secrets to be provided by any Splunk forwarder. If empty,
                  unauthorized access is permitted.
              description:
                type: string
                title: Description
        maxS2Sversion:
          type: string
          title: Max S2S version
          description: The highest S2S protocol version to advertise during handshake
          enum:
            - v3
            - v4
          default: v3
          x-speakeasy-enum-descriptions:
            - v3
            - v4
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        useFwdTimezone:
          type: boolean
          title: Use Universal Forwarder time zone
          default: true
          description: Event Breakers will determine events' time zone from UF-provided
            metadata, when TZ can't be inferred from the raw event
        dropControlFields:
          type: boolean
          title: Drop control fields
          description: Drop Splunk control fields such as `crcSalt` and `_savedPort`. If
            disabled, control fields are stored in the internal field
            `__ctrlFields`.
          default: true
        extractMetrics:
          type: boolean
          title: Extract metrics
          description: Extract and process Splunk-generated metrics as Cribl metrics
          default: false
        compress:
          type: string
          title: Compression
          description: Controls whether to support reading compressed data from a
            forwarder. Select 'Automatic' to match the forwarder's
            configuration, or 'Disabled' to reject compressed connections.
          default: disabled
          enum:
            - disabled
            - auto
            - always
          x-speakeasy-enum-descriptions:
            - Disabled
            - Automatic
            - Always
          x-speakeasy-unknown-values: allow
    InputSplunkSearch:
      type: object
      required:
        - type
        - searchHead
        - search
        - cronSchedule
        - endpoint
        - outputMode
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - splunk_search
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        searchHead:
          title: Search head
          type: string
          default: https://localhost:8089
          description: Search head base URL. Can be an expression. Default is
            https://localhost:8089.
        search:
          type: string
          title: Search
          description: "Enter Splunk search here. Examples: 'index=myAppLogs level=error
            channel=myApp' OR '| mstats avg(myStat) as myStat WHERE
            index=myStatsIndex.'"
        earliest:
          title: Earliest
          type: string
          description: "The earliest time boundary for the search. Can be an exact or
            relative time. Examples: '2022-01-14T12:00:00Z' or '-16m@m'"
          default: -16m@m
        latest:
          title: Latest
          type: string
          description: "The latest time boundary for the search. Can be an exact or
            relative time. Examples: '2022-01-14T12:00:00Z' or '-1m@m'"
          default: -1m@m
        cronSchedule:
          type: string
          title: Cron schedule
          description: A cron schedule on which to run this job
          default: "*/15 * * * *"
        endpoint:
          type: string
          title: Search endpoint
          default: /services/search/v2/jobs/export
          description: REST API used to create a search
        outputMode:
          type: string
          title: Output mode
          description: Format of the returned output
          enum:
            - csv
            - json
          default: json
          x-speakeasy-unknown-values: allow
        endpointParams:
          title: Endpoint parameters
          type: array
          description: Optional request parameters to send to the endpoint
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                title: Parameter Name
                type: string
              value:
                title: Value
                type: string
                description: JavaScript expression to compute the parameter's value, normally
                  enclosed in backticks (e.g., `${earliest}`). If a constant,
                  use single quotes (e.g., 'earliest'). Values without
                  delimiters (e.g., earliest) are evaluated as strings.
        endpointHeaders:
          title: Endpoint headers
          description: Optional request headers to send to the endpoint
          type: array
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Header Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute the header's value, normally
                  enclosed in backticks (e.g., `${earliest}`). If a constant,
                  use single quotes (e.g., 'earliest'). Values without
                  delimiters (e.g., earliest) are evaluated as strings.
        logLevel:
          type: string
          title: Log level
          enum:
            - error
            - warn
            - info
            - debug
          description: Collector runtime log level (verbosity)
          x-speakeasy-unknown-values: allow
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: HTTP request inactivity timeout. Use 0 for no timeout.
          minimum: 0
          maximum: 2400
          default: 0
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: When a DNS server returns multiple addresses, @{product} will cycle
            through them in the order returned
          default: false
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA
            (such as self-signed certificates)
          default: false
        encoding:
          type: string
          title: Encoding
          description: Character encoding to use when parsing ingested data. When not set,
            @{product} will default to UTF-8 but may incorrectly interpret
            multi-byte characters.
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often workers should check in with the scheduler to keep job
            subscription alive
          minimum: 10
          default: 30
        jobTimeout:
          type: string
          title: Job timeout
          description: Maximum time the job is allowed to run (e.g., 30, 45s or 15m).
            Units are seconds, if not specified. Enter 0 for unlimited time.
          pattern: ^\d+[sm]?$
          default: "0"
        maxMissedKeepAlives:
          type: number
          title: Worker timeout (periods)
          description: The number of Keep Alive Time periods before an inactive worker
            will have its job subscription revoked.
          minimum: 2
          default: 3
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        retryRules:
          type: object
          required:
            - type
          properties:
            type:
              type: string
              title: Retry type
              description: The algorithm to use when performing HTTP retries
              enum:
                - none
                - backoff
                - static
              x-speakeasy-enum-descriptions:
                - Disabled
                - Backoff
                - Static
              default: backoff
              x-speakeasy-unknown-values: allow
            interval:
              type: number
              title: Initial retry interval (ms)
              description: Time interval between failed request and first retry (kickoff).
                Maximum allowed value is 20,000 ms (1/3 minute).
              minimum: 0
              maximum: 20000
              default: 1000
            limit:
              type: number
              title: Retry limit
              description: The maximum number of times to retry a failed HTTP request
              minimum: 0
              maximum: 20
              default: 5
            multiplier:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff, e.g., base 2 means that retries will
                occur after 2, then 4, then 8 seconds, and so on
              minimum: 1
              maximum: 20
              default: 2
            codes:
              type: array
              title: Retry HTTP codes
              description: List of HTTP codes that trigger a retry. Leave empty to use the
                default list of 429 and 503.
              minItems: 1
              default:
                - 429
                - 503
              items:
                type: number
                minLength: 1
            enableHeader:
              type: boolean
              title: Honor Retry-After header
              description: Honor any Retry-After header that specifies a delay (in seconds) or
                a timestamp after which to retry the request. The delay is
                limited to 20 seconds, even if the Retry-After header specifies
                a longer delay. When disabled, all Retry-After headers are
                ignored.
              default: true
            retryConnectTimeout:
              type: boolean
              title: Retry connection timeout
              description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
                error occurs
              default: false
            retryConnectReset:
              type: boolean
              title: Retry connection reset
              description: Retry request when a connection reset (ECONNRESET) error occurs
              default: false
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          default:
            - Splunk Search Ruleset
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        authType:
          type: string
          title: Authentication type
          description: Splunk Search authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          default: basic
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
    InputSplunkHec:
      type: object
      required:
        - type
        - host
        - port
        - splunkHecAPI
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - splunk_hec
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: object
            required:
              - token
            properties:
              authType:
                title: Authentication method
                type: string
                enum:
                  - manual
                  - secret
                default: manual
                description: Select Manual to enter an auth token directly, or select Secret to
                  use a text secret to authenticate
                x-speakeasy-unknown-values: allow
              tokenSecret: {}
              token: {}
              enabled:
                type: boolean
                title: Enable token
                default: true
              description:
                type: string
                title: Description
                description: Optional token description
              allowedIndexesAtToken:
                type: array
                title: Allowed indexes
                description: Enter the values you want to allow in the HEC event index field at
                  the token level. Supports wildcards. To skip validation, leave
                  blank.
                minItems: 0
                items:
                  type: string
                  minLength: 1
              metadata:
                type: array
                title: Fields
                description: Fields to add to events referencing this token
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck: {}
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        splunkHecAPI:
          type: string
          title: Splunk HEC endpoint
          description: Absolute path on which to listen for the Splunk HTTP Event
            Collector API requests. This input supports the /event, /raw and
            /s2s endpoints.
          default: /services/collector
          pattern: ^/
        metadata:
          type: array
          title: Fields
          description: Fields to add to every event. Overrides fields added at the token
            or request level. See [the Source
            documentation](https://docs.cribl.io/stream/sources-splunk-hec/#fields)
            for more info.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        allowedIndexes:
          type: array
          title: Allowed indexes
          description: List values allowed in HEC event index field. Leave blank to skip
            validation. Supports wildcards. The values here can expand index
            validation at the token level.
          minItems: 0
          items:
            type: string
            minLength: 1
        splunkHecAcks:
          type: boolean
          title: Splunk HEC acks
          description: Enable Splunk HEC acknowledgements
          default: false
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        useFwdTimezone:
          type: boolean
          title: Use Universal Forwarder time zone (S2S only)
          default: true
          description: Event Breakers will determine events' time zone from UF-provided
            metadata, when TZ can't be inferred from the raw event
        dropControlFields:
          type: boolean
          title: Drop control fields (S2S only)
          description: Drop Splunk control fields such as `crcSalt` and `_savedPort`. If
            disabled, control fields are stored in the internal field
            `__ctrlFields`.
          default: true
        extractMetrics:
          type: boolean
          title: Extract metrics (S2S only)
          description: Extract and process Splunk-generated metrics as Cribl metrics
          default: false
        accessControlAllowOrigin:
          title: CORS allowed origins
          type: array
          description: Optionally, list HTTP origins to which @{product} should send CORS
            (cross-origin resource sharing) Access-Control-Allow-* headers.
            Supports wildcards.
          minItems: 0
          items:
            type: string
            minLength: 1
        accessControlAllowHeaders:
          title: CORS allowed headers
          type: array
          description: Optionally, list HTTP headers that @{product} will send to allowed
            origins as "Access-Control-Allow-Headers" in a CORS preflight
            response. Use "*" to allow all headers.
          minItems: 0
          items:
            type: string
            minLength: 1
        emitTokenMetrics:
          type: boolean
          title: Emit per-token request metrics
          description: Emit per-token (<prefix>.http.perToken) and summary
            (<prefix>.http.summary) request metrics
          default: false
        description:
          type: string
          title: Description
    InputAzureBlob:
      type: object
      required:
        - type
        - queueName
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - azure_blob
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        queueName:
          type: string
          title: Queue
          description: "The storage account queue name blob notifications will be read
            from. Value must be a JavaScript expression (which can evaluate to a
            constant value), enclosed in quotes or backticks. Can be evaluated
            only at initialization time. Example referencing a Global Variable:
            `myQueue-${C.vars.myVar}`"
        fileFilter:
          type: string
          title: Filename filter
          description: "Regex matching file names to download and process. Defaults to: .*"
          default: /.*/
        visibilityTimeout:
          type: number
          title: Visibility timeout (secs)
          description: The duration (in seconds) that the received messages are hidden
            from subsequent retrieve requests after being retrieved by a
            ReceiveMessage request.
          default: 600
          minimum: 0
          maximum: 604800
        numReceivers:
          type: number
          title: Number of receivers
          description: How many receiver processes to run. The higher the number, the
            better the throughput - at the expense of CPU overhead.
          default: 1
          minimum: 1
          maximum: 100
        maxMessages:
          type: number
          title: Message limit
          description: "The maximum number of messages to return in a poll request. Azure
            storage queues never returns more messages than this value (however,
            fewer messages might be returned). Valid values: 1 to 32."
          default: 1
          minimum: 1
          maximum: 32
        servicePeriodSecs:
          type: number
          title: Service period (secs)
          description: The duration (in seconds) which pollers should be validated and
            restarted if exited
          default: 5
          minimum: 1
          maximum: 10
        skipOnError:
          type: boolean
          title: Skip file on error
          description: Skip files that trigger a processing error. Disabled by default,
            which allows retries after processing errors.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        parquetChunkSizeMB:
          type: number
          title: Parquet chunk size limit (MB)
          description: Maximum file size for each Parquet chunk
          default: 5
          maximum: 100
          minimum: 1
        parquetChunkDownloadTimeout:
          type: number
          title: Parquet chunk download timeout (seconds)
          description: The maximum time allowed for downloading a Parquet chunk.
            Processing will stop if a chunk cannot be downloaded within the time
            specified.
          default: 600
          maximum: 3600
          minimum: 1
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
            - clientSecret
            - clientCert
          default: manual
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        connectionString:
          type: string
          title: Connection string
          description: Enter your Azure Storage account connection string. If left blank,
            Stream will fall back to env.AZURE_STORAGE_CONNECTION_STRING.
        textSecret:
          type: string
          title: Connection string (text secret)
          description: Select or create a stored text secret
        storageAccountName:
          type: string
          title: Storage account name
          description: The name of your Azure storage account
        tenantId:
          type: string
          title: Tenant ID
          description: The service principal's tenant ID
        clientId:
          type: string
          title: Client ID
          description: The service principal's client ID
        azureCloud:
          type: string
          title: Azure Cloud
          description: The Azure cloud to use. Defaults to Azure Public Cloud.
        endpointSuffix:
          type: string
          title: Endpoint suffix
          description: Endpoint suffix for the service URL. Takes precedence over the
            Azure Cloud setting. Defaults to core.windows.net.
        clientTextSecret:
          type: string
          title: Client secret (text secret)
          description: Select or create a stored text secret
        certificate:
          type: object
          required:
            - certificateName
          properties:
            certificateName:
              type: string
              title: Certificate
              description: The certificate you registered as credentials for your app in the
                Azure portal
    InputElastic:
      type: object
      required:
        - type
        - host
        - port
        - elasticAPI
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - elastic
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        elasticAPI:
          type: string
          title: Elasticsearch API endpoint
          description: Absolute path on which to listen for Elasticsearch API requests.
            Defaults to /. _bulk will be appended automatically. For example,
            /myPath becomes /myPath/_bulk. Requests can then be made to either
            /myPath/_bulk or /myPath/<myIndexName>/_bulk. Other entries are
            faked as success.
          default: /
          pattern: ^/
        authType:
          type: string
          title: Authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - authTokens
          x-speakeasy-enum-descriptions:
            - None
            - Basic
            - Basic (credentials secret)
            - Auth Tokens
          default: none
          x-speakeasy-unknown-values: allow
        apiVersion:
          type: string
          title: API version
          description: The API version to use for communicating with the server
          enum:
            - 6.8.4
            - 8.3.2
            - custom
          x-speakeasy-enum-descriptions:
            - 6.8.4
            - 8.3.2
            - Custom
          default: 8.3.2
          x-speakeasy-unknown-values: allow
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
          default:
            - name: X-elastic-product
              value: Elasticsearch
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        proxyMode:
          type: object
          title: ""
          required:
            - enabled
          properties:
            enabled:
              type: boolean
              title: Enable proxy mode
              default: false
              description: Enable proxying of non-bulk API requests to an external Elastic
                server. Enable this only if you understand the implications. See
                [Cribl
                Docs](https://docs.cribl.io/stream/sources-elastic/#proxy-mode)
                for more details.
            authType:
              enum:
                - none
                - manual
                - secret
              title: Authentication method
              type: string
              default: none
              description: Enter credentials directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            url:
              type: string
              title: Proxy URL
              description: URL of the Elastic server to proxy non-bulk requests to, such as
                http://elastic:9200
            rejectUnauthorized:
              type: boolean
              title: Reject unauthorized certificates
              description: Reject certificates that cannot be verified against a valid CA
                (such as self-signed certificates)
              default: false
            removeHeaders:
              type: array
              title: Remove headers
              description: List of headers to remove from the request to proxy
              minItems: 0
              items:
                type: string
                minLength: 1
            timeoutSec:
              type: number
              default: 60
              minimum: 1
              maximum: 9007199254740991
              title: Proxy request timeout
              description: Amount of time, in seconds, to wait for a proxy request to complete
                before canceling it
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        authTokens:
          type: array
          title: Token
          description: Bearer tokens to include in the authorization header
          items:
            type: string
        customAPIVersion:
          type: string
          title: Custom API Version
          description: Custom version information to respond to requests
          default: |-
            {
                "name": "AzU84iL",
                "cluster_name": "cribl",
                "cluster_uuid": "Js6_Z2VKS3KbfRSxPmPbaw",
                "version": {
                    "number": "8.3.2",
                    "build_type": "tar",
                    "build_hash": "bca0c8d",
                    "build_date": "2019-10-16T06:19:49.319352Z",
                    "build_snapshot": false,
                    "lucene_version": "9.7.2",
                    "minimum_wire_compatibility_version": "7.17.0",
                    "minimum_index_compatibility_version": "7.0.0"
                },
                "tagline": "You Know, for Search"
            }
    InputConfluentCloud:
      type: object
      required:
        - type
        - brokers
        - topics
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - confluent_cloud
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        brokers:
          type: array
          title: Bootstrap servers
          description: List of Confluent Cloud bootstrap servers to use, such as
            yourAccount.confluent.cloud:9092
          minItems: 1
          items:
            type: string
            minLength: 1
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        topics:
          type: array
          title: Topic
          description: "Topic to subscribe to. Warning: To optimize performance, Cribl
            suggests subscribing each Kafka Source to a single topic only."
          minItems: 1
          default: []
          items:
            type: string
            minLength: 1
        groupId:
          type: string
          default: Cribl
          title: Group ID
          description: The consumer group to which this instance belongs. Defaults to
            'Cribl'.
        fromBeginning:
          type: boolean
          default: true
          title: From beginning
          description: Leave enabled if you want the Source, upon first subscribing to a
            topic, to read starting with the earliest available message
        kafkaSchemaRegistry:
          type: object
          title: Kafka Schema Registry Authentication
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            schemaRegistryURL:
              type: string
              title: Schema Registry URL
              description: "URL for accessing the Confluent Schema Registry. Example:
                http://localhost:8081. To connect over TLS, use https instead of
                http."
              default: http://localhost:8081
            connectionTimeout:
              type: number
              title: Connection timeout (ms)
              description: Maximum time to wait for a Schema Registry connection to complete
                successfully
              default: 30000
              minimum: 1000
              maximum: 60000
            requestTimeout:
              type: number
              title: Request timeout (ms)
              description: Maximum time to wait for the Schema Registry to respond to a
                request
              default: 30000
              minimum: 1000
              maximum: 60000
            maxRetries:
              type: number
              title: Retry limit
              description: Maximum number of times to try fetching schemas from the Schema
                Registry
              default: 1
              minimum: 0
              maximum: 100
            auth:
              type: object
              description: Credentials to use when authenticating with the schema registry
                using basic HTTP authentication
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                credentialsSecret:
                  type: string
                  title: Credentials secret
                  description: Select or create a secret that references your credentials
            tls:
              type: object
              title: TLS settings (client side)
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                rejectUnauthorized:
                  type: boolean
                  title: Validate server certs
                  description: >-
                    Reject certificates that are not authorized by a CA in the
                    CA certificate path, or by another 
                                        trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
                  default: true
                servername:
                  type: string
                  title: Server name (SNI)
                  description: Server name for the SNI (Server Name Indication) TLS extension. It
                    must be a host name, and not an IP address.
                certificateName:
                  type: string
                  title: Certificate
                  description: The name of the predefined certificate
                caPath:
                  type: string
                  title: CA certificate path
                  description: Path on client in which to find CA certificates to verify the
                    server's cert. PEM format. Can reference $ENV_VARS.
                privKeyPath:
                  type: string
                  title: Private key path (mutual auth)
                  description: Path on client in which to find the private key to use. PEM format.
                    Can reference $ENV_VARS.
                certPath:
                  type: string
                  title: Certificate path (mutual auth)
                  description: Path on client in which to find certificates to use. PEM format.
                    Can reference $ENV_VARS.
                passphrase:
                  type: string
                  title: Passphrase
                  description: Passphrase to use to decrypt private key
                minVersion:
                  type: string
                  title: Minimum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
                maxVersion:
                  type: string
                  title: Maximum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        sasl:
          type: object
          title: Authentication
          description: Authentication parameters to use when connecting to brokers. Using
            TLS is highly recommended.
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            authType:
              enum:
                - manual
                - secret
              title: Authentication method
              type: string
              default: manual
              description: Enter credentials directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            mechanism:
              enum:
                - plain
                - scram-sha-256
                - scram-sha-512
                - kerberos
              type: string
              default: plain
              x-speakeasy-enum-descriptions:
                - PLAIN
                - SCRAM-SHA-256
                - SCRAM-SHA-512
                - GSSAPI/Kerberos
              title: SASL mechanism
              x-speakeasy-unknown-values: allow
            keytabLocation:
              type: string
              title: Keytab Location
              description: Location of keytab file for authentication principal
            principal:
              type: string
              title: Principal
              description: Authentication principal, such as `kafka_user@example.com`
            brokerServiceClass:
              type: string
              title: Broker service class
              description: Kerberos service class for Kafka brokers, such as `kafka`
            oauthEnabled:
              type: boolean
              title: Enable OAuth
              description: Enable OAuth authentication
              default: false
            tokenUrl:
              type: string
              title: Token URL
              description: URL of the token endpoint to use for OAuth authentication
            clientId:
              type: string
              title: Client ID
              description: Client ID to use for OAuth authentication
            oauthSecretType:
              type: string
              default: secret
            clientTextSecret:
              type: string
              title: Client secret (text secret)
              description: Select or create a stored text secret
            oauthParams:
              type: array
              title: Add OAuth Parameters
              description: Additional fields to send to the token endpoint, such as scope or
                audience
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Parameter Name
                  value:
                    type: string
                    title: Parameter Value
            saslExtensions:
              type: array
              title: Add SASL Extension Fields
              description: Additional SASL extension fields, such as Confluent's
                logicalCluster or identityPoolId
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Field Name
                  value:
                    type: string
                    title: Field Value
        sessionTimeout:
          type: number
          title: Session timeout (ms)
          description: >2-
            
                  Timeout used to detect client failures when using Kafka's group-management facilities.
                  If the client sends no heartbeats to the broker before the timeout expires, 
                  the broker will remove the client from the group and initiate a rebalance.
                  Value must be between the broker's configured group.min.session.timeout.ms and group.max.session.timeout.ms.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#consumerconfigs_session.timeout.ms) for details.
          default: 30000
          minimum: 1000
          maximum: 3600000
        rebalanceTimeout:
          type: number
          title: Rebalance timeout (ms)
          description: >2-
            
                  Maximum allowed time for each worker to join the group after a rebalance begins.
                  If the timeout is exceeded, the coordinator broker will remove the worker from the group.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#connectconfigs_rebalance.timeout.ms) for details.
          default: 60000
          minimum: 1000
          maximum: 3600000
        heartbeatInterval:
          type: number
          title: Heartbeat interval (ms)
          description: >2-
            
                  Expected time between heartbeats to the consumer coordinator when using Kafka's group-management facilities.
                  Value must be lower than sessionTimeout and typically should not exceed 1/3 of the sessionTimeout value.
                  See [Kafka's documentation](https://kafka.apache.org/documentation/#consumerconfigs_heartbeat.interval.ms) for details.
          default: 3000
          minimum: 1000
          maximum: 3600000
        autoCommitInterval:
          type: number
          title: Offset commit interval (ms)
          description: How often to commit offsets. If both this and Offset commit
            threshold are set, @{product} commits offsets when either condition
            is met. If both are empty, @{product} commits offsets after each
            batch.
          minimum: 1000
          maximum: 3600000
        autoCommitThreshold:
          type: number
          title: Offset commit threshold
          description: How many events are needed to trigger an offset commit. If both
            this and Offset commit interval are set, @{product} commits offsets
            when either condition is met. If both are empty, @{product} commits
            offsets after each batch.
          minimum: 1
          maximum: 10000
        maxBytesPerPartition:
          type: number
          title: Byte limit, per partition
          description: Maximum amount of data that Kafka will return per partition, per
            fetch request. Must equal or exceed the maximum message size
            (maxBytesPerPartition) that Kafka is configured to allow. Otherwise,
            @{product} can get stuck trying to retrieve messages. Defaults to
            1048576 (1 MB).
          minimum: 1
          maximum: 10000000
          default: 1048576
        maxBytes:
          type: number
          title: Byte limit
          description: Maximum number of bytes that Kafka will return per fetch request.
            Defaults to 10485760 (10 MB).
          minimum: 1
          maximum: 1000000000
          default: 10485760
        maxSocketErrors:
          type: number
          title: Error limit, per socket
          description: Maximum number of network errors before the consumer re-creates a
            socket
          minimum: 0
          maximum: 100
          default: 0
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputGrafana:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - grafana
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep alive timeout (seconds)
          description: Maximum time to wait for additional data, after the last response
            was sent, before closing a socket connection. This can be very
            useful when Grafana Agent remote write's request frequency is high
            so, reusing connections, would help mitigating the cost of creating
            a new connection per request. Note that Grafana Agent's embedded
            Prometheus would attempt to keep connections open for up to 5
            minutes.
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        prometheusAPI:
          type: string
          title: Remote Write API endpoint
          description: "Absolute path on which to listen for Grafana Agent's Remote Write
            requests. Defaults to /api/prom/push, which will expand as:
            'http://<your‑upstream‑URL>:<your‑port>/api/prom/push'. Either this
            field or 'Logs API endpoint' must be configured."
          default: /api/prom/push
          pattern: ^/
        lokiAPI:
          type: string
          title: Logs API endpoint
          description: "Absolute path on which to listen for Loki logs requests. Defaults
            to /loki/api/v1/push, which will (in this example) expand as:
            'http://<your‑upstream‑URL>:<your‑port>/loki/api/v1/push'. Either
            this field or 'Remote Write API endpoint' must be configured."
          default: /loki/api/v1/push
          pattern: ^/
        prometheusAuth:
          type: object
          properties:
            authType:
              type: string
              title: Authentication type
              description: Remote Write authentication type
              enum:
                - none
                - basic
                - credentialsSecret
                - token
                - textSecret
                - oauth
              default: none
              x-speakeasy-unknown-values: allow
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            token:
              type: string
              title: Token
              description: Bearer token to include in the authorization header
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            textSecret:
              type: string
              title: Token (text secret)
              description: Select or create a stored text secret
            loginUrl:
              type: string
              title: Login URL
              description: URL for OAuth
              pattern: ^https?://.*
            secretParamName:
              type: string
              title: OAuth Secret parameter name
              description: Secret parameter name to pass in request body
            secret:
              type: string
              title: OAuth secret
              description: Secret parameter value to pass in request body
            tokenAttributeName:
              type: string
              title: Token attribute name
              description: Name of the auth token attribute in the OAuth response. Can be
                top-level (e.g., 'token'); or nested, using a period (e.g.,
                'data.token').
            authHeaderExpr:
              type: string
              title: Authorize expression
              description: "JavaScript expression to compute the Authorization header value to
                pass in requests. The value `${token}` is used to reference the
                token obtained from authentication, e.g.: `Bearer ${token}`."
              default: "`Bearer ${token}`"
            tokenTimeoutSecs:
              type: number
              title: Refresh interval (secs.)
              description: How often the OAuth token should be refreshed.
              minimum: 1
              maximum: 300000
              default: 3600
            oauthParams:
              type: array
              title: OAuth parameters
              description: Additional parameters to send in the OAuth login request.
                @{product} will combine the secret with these parameters, and
                will send the URL-encoded result in a POST request to the
                endpoint specified in the 'Login URL'. We'll automatically add
                the content-type header 'application/x-www-form-urlencoded' when
                sending this request.
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Name
                    description: OAuth parameter name
                  value:
                    type: string
                    title: Value
                    description: OAuth parameter value
            oauthHeaders:
              type: array
              title: OAuth headers
              description: Additional headers to send in the OAuth login request. @{product}
                will automatically add the content-type header
                'application/x-www-form-urlencoded' when sending this request.
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Name
                    description: OAuth header name
                  value:
                    type: string
                    title: Value
                    description: OAuth header value
        lokiAuth:
          type: object
          properties:
            authType:
              type: string
              title: Authentication type
              description: Loki logs authentication type
              enum:
                - none
                - basic
                - credentialsSecret
                - token
                - textSecret
                - oauth
              default: none
              x-speakeasy-unknown-values: allow
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            token:
              type: string
              title: Token
              description: Bearer token to include in the authorization header
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            textSecret:
              type: string
              title: Token (text secret)
              description: Select or create a stored text secret
            loginUrl:
              type: string
              title: Login URL
              description: URL for OAuth
              pattern: ^https?://.*
            secretParamName:
              type: string
              title: OAuth Secret parameter name
              description: Secret parameter name to pass in request body
            secret:
              type: string
              title: OAuth secret
              description: Secret parameter value to pass in request body
            tokenAttributeName:
              type: string
              title: Token attribute name
              description: Name of the auth token attribute in the OAuth response. Can be
                top-level (e.g., 'token'); or nested, using a period (e.g.,
                'data.token').
            authHeaderExpr:
              type: string
              title: Authorize expression
              description: "JavaScript expression to compute the Authorization header value to
                pass in requests. The value `${token}` is used to reference the
                token obtained from authentication, e.g.: `Bearer ${token}`."
              default: "`Bearer ${token}`"
            tokenTimeoutSecs:
              type: number
              title: Refresh interval (secs.)
              description: How often the OAuth token should be refreshed.
              minimum: 1
              maximum: 300000
              default: 3600
            oauthParams:
              type: array
              title: OAuth parameters
              description: Additional parameters to send in the OAuth login request.
                @{product} will combine the secret with these parameters, and
                will send the URL-encoded result in a POST request to the
                endpoint specified in the 'Login URL'. We'll automatically add
                the content-type header 'application/x-www-form-urlencoded' when
                sending this request.
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Name
                    description: OAuth parameter name
                  value:
                    type: string
                    title: Value
                    description: OAuth parameter value
            oauthHeaders:
              type: array
              title: OAuth headers
              description: Additional headers to send in the OAuth login request. @{product}
                will automatically add the content-type header
                'application/x-www-form-urlencoded' when sending this request.
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Name
                    description: OAuth header name
                  value:
                    type: string
                    title: Value
                    description: OAuth header value
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
      anyOf:
        - required:
            - prometheusAPI
        - required:
            - lokiAPI
    InputLoki:
      type: object
      required:
        - type
        - host
        - port
        - lokiAPI
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - loki
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        lokiAPI:
          type: string
          title: Logs API endpoint
          description: "Absolute path on which to listen for Loki logs requests. Defaults
            to /loki/api/v1/push, which will (in this example) expand as:
            'http://<your‑upstream‑URL>:<your‑port>/loki/api/v1/push'."
          default: /loki/api/v1/push
          pattern: ^/
        authType:
          type: string
          title: Authentication type
          description: Loki logs authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          default: none
          x-speakeasy-unknown-values: allow
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
    InputPrometheusRw:
      type: object
      required:
        - type
        - host
        - port
        - prometheusAPI
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - prometheus_rw
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        prometheusAPI:
          type: string
          title: Remote Write API endpoint
          description: "Absolute path on which to listen for Prometheus requests. Defaults
            to /write, which will expand as:
            http://<your‑upstream‑URL>:<your‑port>/write."
          default: /write
          pattern: ^/
        authType:
          type: string
          title: Authentication type
          description: Remote Write authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          default: none
          x-speakeasy-unknown-values: allow
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
    InputPrometheus:
      type: object
      required:
        - type
        - interval
        - logLevel
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - prometheus
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        dimensionList:
          type: array
          title: Extra Dimensions
          minItems: 0
          default:
            - host
            - source
          description: Other dimensions to include in events
          items:
            type: string
            title: dimension
        discoveryType:
          title: Discovery Type
          type: string
          enum:
            - static
            - dns
            - ec2
          x-speakeasy-enum-descriptions:
            - Static
            - DNS
            - AWS EC2
          description: Target discovery mechanism. Use static to manually enter a list of
            targets.
          default: static
          x-speakeasy-unknown-values: allow
        interval:
          type: number
          title: Poll Interval
          description: How often in minutes to scrape targets for metrics, 60 must be
            evenly divisible by the value or save will fail.
          minimum: 1
          maximum: 60
          default: 15
        logLevel:
          type: string
          title: Log Level
          enum:
            - error
            - warn
            - info
            - debug
          description: Collector runtime Log Level
          default: info
          x-speakeasy-unknown-values: allow
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often workers should check in with the scheduler to keep job
            subscription alive
          minimum: 10
          default: 30
        jobTimeout:
          type: string
          title: Job timeout
          description: Maximum time the job is allowed to run (e.g., 30, 45s or 15m).
            Units are seconds, if not specified. Enter 0 for unlimited time.
          pattern: ^\d+[sm]?$
          default: "0"
        maxMissedKeepAlives:
          type: number
          title: Worker timeout (periods)
          description: The number of Keep Alive Time periods before an inactive worker
            will have its job subscription revoked.
          minimum: 2
          default: 3
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter credentials directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        targetList:
          type: array
          title: Targets
          minItems: 1
          default: []
          description: "List of Prometheus targets to pull metrics from. Values can be in
            URL or host[:port] format. For example:
            http://localhost:9090/metrics, localhost:9090, or localhost. In
            cases where just host[:port] is specified, the endpoint will resolve
            to 'http://host[:port]/metrics'."
          items:
            type: string
            title: Targets
        recordType:
          enum:
            - SRV
            - A
            - AAAA
          type: string
          title: Record Type
          description: DNS Record type to resolve
          default: SRV
          x-speakeasy-unknown-values: allow
        scrapePort:
          type: number
          title: Metrics Port
          description: The port number in the metrics URL for discovered targets.
          minimum: 1
          maximum: 65535
          default: 9090
        nameList:
          type: array
          title: DNS Names
          minItems: 1
          default: []
          description: List of DNS names to resolve
          items:
            type: string
            title: DNS Names
        scrapeProtocol:
          type: string
          title: Metrics Protocol
          enum:
            - http
            - https
          description: Protocol to use when collecting metrics
          default: http
          x-speakeasy-unknown-values: allow
        scrapePath:
          type: string
          title: Metrics Path
          description: Path to use when collecting metrics from discovered targets
          default: /metrics
          pattern: ^/.*
        awsAuthenticationMethod:
          enum:
            - auto
            - manual
            - secret
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        usePublicIp:
          type: boolean
          title: Use Public IP
          description: Use public IP address for discovered targets. Set to false if the
            private IP address should be used.
          default: true
        searchFilter:
          title: Search Filter
          description: EC2 Instance Search Filter
          type: array
          items:
            type: object
            required:
              - Name
              - Values
            properties:
              Name:
                type: string
                title: Filter Name
                description: "Search filter attribute name, see:
                  https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_De\
                  scribeInstances.html for more information. Attributes can be
                  manually entered if not present in the drop down list"
              Values:
                type: array
                title: Filter Values
                description: Search Filter Values, if empty only "running" EC2 instances will be
                  returned
                minItems: 0
                default: []
                items:
                  type: string
                  minLength: 1
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the EC2 is located
        endpoint:
          type: string
          title: Endpoint
          description: EC2 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to EC2-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing EC2 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for EC2
          description: Use Assume Role credentials to access EC2
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        username:
          type: string
          title: Username
          description: Username for Prometheus Basic authentication
        password:
          type: string
          title: Password
          description: Password for Prometheus Basic authentication
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
    InputEdgePrometheus:
      type: object
      required:
        - type
        - interval
        - discoveryType
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - edge_prometheus
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        dimensionList:
          type: array
          title: Extra Dimensions
          minItems: 0
          default:
            - host
            - source
          description: Other dimensions to include in events
          items:
            type: string
            title: dimension
        discoveryType:
          title: Discovery Type
          type: string
          enum:
            - static
            - dns
            - ec2
            - k8s-node
            - k8s-pods
          x-speakeasy-enum-descriptions:
            - Static
            - DNS
            - AWS EC2
            - Kubernetes Node
            - Kubernetes Pods
          description: Target discovery mechanism. Use static to manually enter a list of
            targets.
          default: static
          x-speakeasy-unknown-values: allow
        interval:
          type: number
          title: Poll Interval
          description: How often in seconds to scrape targets for metrics.
          minimum: 2
          default: 15
        timeout:
          type: number
          title: HTTP Connection Timeout
          description: Timeout, in milliseconds, before aborting HTTP connection attempts;
            1-60000 or 0 to disable
          default: 5000
          maximum: 60000
          minimum: 0
        persistence:
          type: object
          title: Disk Spooling
          properties:
            enable:
              type: boolean
              title: Enable disk spooling
              description: Spool events on disk for Cribl Edge and Search. Default is
                disabled.
              default: false
            timeWindow:
              type: string
              title: Bucket time span
              description: Time period for grouping spooled events. Default is 10m.
              default: 10m
            maxDataSize:
              type: string
              title: Data size limit
              description: "Maximum disk space that can be consumed before older buckets are
                deleted. Examples: 420MB, 4GB. Default is 1GB."
              pattern: ^\d+(\.\d+)?\s*(?:[kmgKMG](b|B))?$
              default: 1GB
            maxDataTime:
              title: Data age limit
              type: string
              description: "Maximum amount of time to retain data before older buckets are
                deleted. Examples: 2h, 4d. Default is 24h."
              pattern: \d+[smhd]$
              default: 24h
            compress:
              type: string
              title: Compression
              description: Data compression format. Default is gzip.
              enum:
                - none
                - gzip
              default: gzip
              x-speakeasy-unknown-values: allow
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
            - kubernetes
          default: manual
          description: Enter credentials directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        targets:
          type: array
          title: Targets
          default: []
          minItems: 1
          items:
            type: object
            required:
              - host
            properties:
              protocol:
                type: string
                title: Protocol
                enum:
                  - http
                  - https
                description: Protocol to use when collecting metrics
                default: http
                x-speakeasy-unknown-values: allow
              host:
                type: string
                title: Host
                description: Name of host from which to pull metrics.
              port:
                type: number
                title: Port
                description: The port number in the metrics URL for discovered targets.
                minimum: 1
                maximum: 65535
                default: 9090
              path:
                type: string
                title: Path
                description: Path to use when collecting metrics from discovered targets
                default: /metrics
                pattern: ^/.*
        recordType:
          enum:
            - SRV
            - A
            - AAAA
          type: string
          title: Record Type
          description: DNS Record type to resolve
          default: SRV
          x-speakeasy-unknown-values: allow
        scrapePort:
          type: number
          title: Port
          description: The port number in the metrics URL for discovered targets.
          minimum: 1
          maximum: 65535
          default: 9090
        nameList:
          type: array
          title: DNS Names
          minItems: 1
          default: []
          description: List of DNS names to resolve
          items:
            type: string
            title: DNS Names
        scrapeProtocol:
          type: string
          title: Protocol
          enum:
            - http
            - https
          description: Protocol to use when collecting metrics
          default: http
          x-speakeasy-unknown-values: allow
        scrapePath:
          type: string
          title: Path
          description: Path to use when collecting metrics from discovered targets
          default: /metrics
          pattern: ^/.*
        awsAuthenticationMethod:
          enum:
            - auto
            - manual
            - secret
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        usePublicIp:
          type: boolean
          title: Use Public IP
          description: Use public IP address for discovered targets. Set to false if the
            private IP address should be used.
          default: true
        searchFilter:
          title: Search Filter
          description: EC2 Instance Search Filter
          type: array
          items:
            type: object
            required:
              - Name
              - Values
            properties:
              Name:
                type: string
                title: Filter Name
                description: "Search filter attribute name, see:
                  https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_De\
                  scribeInstances.html for more information. Attributes can be
                  manually entered if not present in the drop down list"
              Values:
                type: array
                title: Filter Values
                description: Search Filter Values, if empty only "running" EC2 instances will be
                  returned
                minItems: 0
                default: []
                items:
                  type: string
                  minLength: 1
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the EC2 is located
        endpoint:
          type: string
          title: Endpoint
          description: EC2 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to EC2-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing EC2 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for EC2
          description: Use Assume Role credentials to access EC2
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        scrapeProtocolExpr:
          type: string
          title: Protocol
          description: Protocol to use when collecting metrics
          default: metadata.annotations['prometheus.io/scheme'] || 'http'
        scrapePortExpr:
          type: string
          title: Port
          description: The port number in the metrics URL for discovered targets.
          default: metadata.annotations['prometheus.io/port'] || 9090
        scrapePathExpr:
          type: string
          title: Path
          description: Path to use when collecting metrics from discovered targets
          default: metadata.annotations['prometheus.io/path'] || '/metrics'
        podFilter:
          type: array
          title: Filter Rules
          description: |2
            
              Add rules to decide which pods to discover for metrics.
              Pods are searched if no rules are given or of all the rules'
              expressions evaluate to true.
          items:
            type: object
            required:
              - filter
            properties:
              filter:
                type: string
                title: Filter Expression
                description: JavaScript expression applied to pods objects. Return 'true' to
                  include it.
              description:
                type: string
                title: Description
                description: Optional description of this rule's purpose
          default:
            - filter: metadata.annotations['prometheus.io/scrape']
              description: Scrape pod if annotation is true
        username:
          type: string
          title: Username
          description: Username for Prometheus Basic authentication
        password:
          type: string
          title: Password
          description: Password for Prometheus Basic authentication
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
    InputOffice365Mgmt:
      type: object
      required:
        - type
        - tenantId
        - appId
        - planType
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - office365_mgmt
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        planType:
          type: string
          title: Subscription plan
          description: Office 365 subscription plan for your organization, typically
            Office 365 Enterprise
          enum:
            - enterprise_gcc
            - gcc
            - gcc_high
            - dod
          x-speakeasy-enum-descriptions:
            - Office 365 Enterprise
            - Office 365 GCC
            - Office 365 GCC High
            - Office 365 DoD
          default: enterprise_gcc
          x-speakeasy-unknown-values: allow
        tenantId:
          type: string
          title: Tenant ID
          description: Office 365 Azure Tenant ID
        appId:
          type: string
          title: App ID
          description: Office 365 Azure Application ID
        timeout:
          type: number
          title: Request timeout (seconds)
          description: HTTP request inactivity timeout, use 0 to disable
          minimum: 0
          maximum: 2400
          default: 300
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often workers should check in with the scheduler to keep job
            subscription alive
          minimum: 10
          default: 30
        jobTimeout:
          type: string
          title: Job timeout
          description: Maximum time the job is allowed to run (e.g., 30, 45s or 15m).
            Units are seconds, if not specified. Enter 0 for unlimited time.
          pattern: ^\d+[sm]?$
          default: "0"
        maxMissedKeepAlives:
          type: number
          title: Worker timeout (periods)
          description: The number of Keep Alive Time periods before an inactive worker
            will have its job subscription revoked.
          minimum: 2
          default: 3
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        publisherIdentifier:
          type: string
          title: Publisher Identifier
          description: Optional Publisher Identifier to use in API requests, defaults to
            tenant id if not defined. For more information see
            [here](https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-management-activity-api-reference#start-a-subscription)
        contentConfig:
          type: array
          title: Content Types
          default:
            - contentType: Active Directory
              description: Poll interval minutes (1-60)
              interval: 15
              logLevel: info
              enabled: false
            - contentType: Exchange
              description: Poll interval minutes (1-60)
              interval: 15
              logLevel: info
              enabled: false
            - contentType: SharePoint
              description: Poll interval minutes (1-60)
              interval: 15
              logLevel: info
              enabled: false
            - contentType: General
              description: Poll interval minutes (1-60)
              interval: 15
              logLevel: info
              enabled: false
            - contentType: DLP
              description: Poll interval minutes (1-60)
              interval: 15
              logLevel: info
              enabled: false
          items:
            type: object
            properties:
              contentType:
                type: string
                title: Content Type
                description: Office 365 Management Activity API Content Type
              description:
                type: string
                title: Interval Description
                description: If interval type is minutes the value entered must evenly divisible
                  by 60 or save will fail
              interval:
                type: number
                title: Interval
                minimum: 1
                maximum: 60
              logLevel:
                type: string
                title: Log Level
                enum:
                  - error
                  - warn
                  - info
                  - debug
                description: Collector runtime Log Level
                x-speakeasy-unknown-values: allow
              enabled:
                type: boolean
                title: Enabled
          description: "Enable Office 365 Management Activity API content types and
            polling intervals. Polling intervals are used to set up search date
            range and cron schedule, e.g.: */${interval} * * * *. Because of
            this, intervals entered must be evenly divisible by 60 to give a
            predictable schedule."
        ingestionLag:
          type: number
          title: Ingestion lag (minutes)
          description: Use this setting to account for ingestion lag. This is necessary
            because there can be a lag of 60 - 90 minutes (or longer) before
            Office 365 events are available for retrieval.
          default: 0
          minimum: 0
          maximum: 7200
        retryRules:
          type: object
          required:
            - type
          properties:
            type:
              type: string
              title: Retry type
              description: The algorithm to use when performing HTTP retries
              enum:
                - none
                - backoff
                - static
              x-speakeasy-enum-descriptions:
                - Disabled
                - Backoff
                - Static
              default: backoff
              x-speakeasy-unknown-values: allow
            interval:
              type: number
              title: Initial retry interval (ms)
              description: Time interval between failed request and first retry (kickoff).
                Maximum allowed value is 20,000 ms (1/3 minute).
              minimum: 0
              maximum: 20000
              default: 1000
            limit:
              type: number
              title: Retry limit
              description: The maximum number of times to retry a failed HTTP request
              minimum: 0
              maximum: 20
              default: 5
            multiplier:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff, e.g., base 2 means that retries will
                occur after 2, then 4, then 8 seconds, and so on
              minimum: 1
              maximum: 20
              default: 2
            codes:
              type: array
              title: Retry HTTP codes
              description: List of http codes that trigger a retry. Leave empty to use the
                default list of 429, 500, and 503.
              minItems: 1
              default:
                - 429
                - 500
                - 503
              items:
                type: number
                minLength: 1
            enableHeader:
              type: boolean
              title: Honor Retry-After header
              description: Honor any Retry-After header that specifies a delay (in seconds) or
                a timestamp after which to retry the request. The delay is
                limited to 20 seconds, even if the Retry-After header specifies
                a longer delay. When disabled, all Retry-After headers are
                ignored.
              default: true
            retryConnectTimeout:
              type: boolean
              title: Retry connection timeout
              description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
                error occurs
              default: false
            retryConnectReset:
              type: boolean
              title: Retry connection reset
              description: Retry request when a connection reset (ECONNRESET) error occurs
              default: false
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter client secret directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        clientSecret:
          type: string
          title: Client secret
          description: Office 365 Azure client secret
        textSecret:
          type: string
          title: Client secret (text secret)
          description: Select or create a stored text secret
    InputOffice365Service:
      type: object
      required:
        - type
        - tenantId
        - appId
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - office365_service
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        planType:
          type: string
          title: Subscription plan
          description: Office 365 subscription plan for your organization, typically
            Office 365 Enterprise
          enum:
            - enterprise_gcc
            - gcc
            - gcc_high
            - dod
          x-speakeasy-enum-descriptions:
            - Office 365 Enterprise
            - Office 365 GCC
            - Office 365 GCC High
            - Office 365 DoD
          default: enterprise_gcc
          x-speakeasy-unknown-values: allow
        tenantId:
          type: string
          title: Tenant ID
          description: Office 365 Azure Tenant ID
        appId:
          type: string
          title: App ID
          description: Office 365 Azure Application ID
        timeout:
          type: number
          title: Request timeout (seconds)
          description: HTTP request inactivity timeout, use 0 to disable
          minimum: 0
          maximum: 2400
          default: 300
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often workers should check in with the scheduler to keep job
            subscription alive
          minimum: 10
          default: 30
        jobTimeout:
          type: string
          title: Job timeout
          description: Maximum time the job is allowed to run (e.g., 30, 45s or 15m).
            Units are seconds, if not specified. Enter 0 for unlimited time.
          pattern: ^\d+[sm]?$
          default: "0"
        maxMissedKeepAlives:
          type: number
          title: Worker timeout (periods)
          description: The number of Keep Alive Time periods before an inactive worker
            will have its job subscription revoked.
          minimum: 2
          default: 3
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        contentConfig:
          type: array
          title: Content Types
          default:
            - contentType: Current Status
              description: Poll interval minutes (1-60)
              interval: 15
              logLevel: info
              enabled: false
            - contentType: Messages
              description: Poll interval minutes (1-60)
              interval: 15
              logLevel: info
              enabled: false
          items:
            type: object
            properties:
              contentType:
                type: string
                title: Content Type
                description: Office 365 Services API Content Type
              description:
                type: string
                title: Interval Description
                description: If interval type is minutes the value entered must evenly divisible
                  by 60 or save will fail
              interval:
                type: number
                title: Interval
                minimum: 0
                maximum: 60
              logLevel:
                type: string
                title: Log Level
                enum:
                  - error
                  - warn
                  - info
                  - debug
                description: Collector runtime Log Level
                x-speakeasy-unknown-values: allow
              enabled:
                type: boolean
                title: Enabled
          description: "Enable Office 365 Service Communication API content types and
            polling intervals. Polling intervals are used to set up search date
            range and cron schedule, e.g.: */${interval} * * * *. Because of
            this, intervals entered for current and historical status must be
            evenly divisible by 60 to give a predictable schedule."
        retryRules:
          type: object
          required:
            - type
          properties:
            type:
              type: string
              title: Retry type
              description: The algorithm to use when performing HTTP retries
              enum:
                - none
                - backoff
                - static
              x-speakeasy-enum-descriptions:
                - Disabled
                - Backoff
                - Static
              default: backoff
              x-speakeasy-unknown-values: allow
            interval:
              type: number
              title: Initial retry interval (ms)
              description: Time interval between failed request and first retry (kickoff).
                Maximum allowed value is 20,000 ms (1/3 minute).
              minimum: 0
              maximum: 20000
              default: 1000
            limit:
              type: number
              title: Retry limit
              description: The maximum number of times to retry a failed HTTP request
              minimum: 0
              maximum: 20
              default: 5
            multiplier:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff, e.g., base 2 means that retries will
                occur after 2, then 4, then 8 seconds, and so on
              minimum: 1
              maximum: 20
              default: 2
            codes:
              type: array
              title: Retry HTTP codes
              description: List of http codes that trigger a retry. Leave empty to use the
                default list of 429, 500, and 503.
              minItems: 1
              default:
                - 429
                - 500
                - 503
              items:
                type: number
                minLength: 1
            enableHeader:
              type: boolean
              title: Honor Retry-After header
              description: Honor any Retry-After header that specifies a delay (in seconds) or
                a timestamp after which to retry the request. The delay is
                limited to 20 seconds, even if the Retry-After header specifies
                a longer delay. When disabled, all Retry-After headers are
                ignored.
              default: true
            retryConnectTimeout:
              type: boolean
              title: Retry connection timeout
              description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
                error occurs
              default: false
            retryConnectReset:
              type: boolean
              title: Retry connection reset
              description: Retry request when a connection reset (ECONNRESET) error occurs
              default: false
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter client secret directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        clientSecret:
          type: string
          title: Client secret
          description: Office 365 Azure client secret
        textSecret:
          type: string
          title: Client secret (text secret)
          description: Select or create a stored text secret
    InputOffice365MsgTrace:
      type: object
      required:
        - type
        - url
        - interval
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - office365_msg_trace
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        url:
          title: Report URL
          type: string
          description: URL to use when retrieving report data.
          default: https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MessageTrace
        interval:
          type: number
          title: Poll interval
          description: How often (in minutes) to run the report. Must divide evenly into
            60 minutes to create a predictable schedule, or Save will fail.
          minimum: 1
          maximum: 60
          default: 60
        startDate:
          title: Date range start
          type: string
          description: "Backward offset for the search range's head. (E.g.: -3h@h) Message
            Trace data is delayed; this parameter (with Date range end)
            compensates for delay and gaps."
        endDate:
          title: Date range end
          type: string
          description: "Backward offset for the search range's tail. (E.g.: -2h@h) Message
            Trace data is delayed; this parameter (with Date range start)
            compensates for delay and gaps."
        timeout:
          type: number
          title: Request timeout (seconds)
          description: HTTP request inactivity timeout. Maximum is 2400 (40 minutes);
            enter 0 to wait indefinitely.
          minimum: 0
          maximum: 2400
          default: 300
        disableTimeFilter:
          type: boolean
          title: Disable time filter
          description: Disables time filtering of events when a date range is specified.
          default: true
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
            - oauth
            - oauthSecret
            - oauthCert
          default: oauth
          description: Select authentication method.
          x-speakeasy-unknown-values: allow
        rescheduleDroppedTasks:
          type: boolean
          title: Reschedule tasks
          description: Reschedule tasks that failed with non-fatal errors
          default: true
        maxTaskReschedule:
          type: number
          title: Task reschedule limit
          description: Maximum number of times a task can be rescheduled
          default: 1
          minimum: 1
        logLevel:
          type: string
          title: Log level
          description: Log Level (verbosity) for collection runtime behavior.
          enum:
            - error
            - warn
            - info
            - debug
            - silly
          default: info
          x-speakeasy-unknown-values: allow
        jobTimeout:
          type: string
          title: Job timeout
          description: Maximum time the job is allowed to run (e.g., 30, 45s or 15m).
            Units are seconds, if not specified. Enter 0 for unlimited time.
          pattern: ^\d+[sm]?$
          default: "0"
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often workers should check in with the scheduler to keep job
            subscription alive
          minimum: 10
          default: 30
        maxMissedKeepAlives:
          type: number
          title: Worker timeout (periods)
          description: The number of Keep Alive Time periods before an inactive worker
            will have its job subscription revoked.
          minimum: 2
          default: 3
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        retryRules:
          type: object
          required:
            - type
          properties:
            type:
              type: string
              title: Retry type
              description: The algorithm to use when performing HTTP retries
              enum:
                - none
                - backoff
                - static
              x-speakeasy-enum-descriptions:
                - Disabled
                - Backoff
                - Static
              default: backoff
              x-speakeasy-unknown-values: allow
            interval:
              type: number
              title: Initial retry interval (ms)
              description: Time interval between failed request and first retry (kickoff).
                Maximum allowed value is 20,000 ms (1/3 minute).
              minimum: 0
              maximum: 20000
              default: 1000
            limit:
              type: number
              title: Retry limit
              description: The maximum number of times to retry a failed HTTP request
              minimum: 0
              maximum: 20
              default: 5
            multiplier:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff, e.g., base 2 means that retries will
                occur after 2, then 4, then 8 seconds, and so on
              minimum: 1
              maximum: 20
              default: 2
            codes:
              type: array
              title: Retry HTTP codes
              description: List of http codes that trigger a retry. Leave empty to use the
                default list of 429, 500, and 503.
              minItems: 1
              default:
                - 429
                - 500
                - 503
              items:
                type: number
                minLength: 1
            enableHeader:
              type: boolean
              title: Honor Retry-After header
              description: Honor any Retry-After header that specifies a delay (in seconds) or
                a timestamp after which to retry the request. The delay is
                limited to 20 seconds, even if the Retry-After header specifies
                a longer delay. When disabled, all Retry-After headers are
                ignored.
              default: true
            retryConnectTimeout:
              type: boolean
              title: Retry connection timeout
              description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
                error occurs
              default: false
            retryConnectReset:
              type: boolean
              title: Retry connection reset
              description: Retry request when a connection reset (ECONNRESET) error occurs
              default: false
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
          description: Username to run Message Trace API call.
        password:
          type: string
          title: Password
          description: Password to run Message Trace API call.
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials.
        clientSecret:
          type: string
          title: Client secret
          description: client_secret to pass in the OAuth request parameter.
        tenantId:
          type: string
          title: Tenant identifier
          description: Directory ID (tenant identifier) in Azure Active Directory.
        clientId:
          type: string
          title: Client ID
          description: client_id to pass in the OAuth request parameter.
        resource:
          type: string
          title: Resource
          description: Resource to pass in the OAuth request parameter.
          default: https://outlook.office365.com
        planType:
          type: string
          title: Subscription plan
          description: Office 365 subscription plan for your organization, typically
            Office 365 Enterprise
          enum:
            - enterprise_gcc
            - gcc
            - gcc_high
            - dod
          x-speakeasy-enum-descriptions:
            - Office 365 Enterprise
            - Office 365 GCC
            - Office 365 GCC High
            - Office 365 DoD
          default: enterprise_gcc
          x-speakeasy-unknown-values: allow
        textSecret:
          type: string
          title: Client secret
          description: Select or create a secret that references your client_secret to
            pass in the OAuth request parameter.
        certOptions:
          type: object
          required:
            - privKeyPath
            - certPath
          properties:
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate.
            privKeyPath:
              type: string
              title: Private key path
              description: Path to the private key to use. Key should be in PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt the private key.
            certPath:
              type: string
              title: Certificate path
              description: Path to the certificate to use. Certificate should be in PEM
                format. Can reference $ENV_VARS.
    InputEventhub:
      type: object
      required:
        - type
        - brokers
        - topics
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - eventhub
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        brokers:
          type: array
          title: Brokers
          description: "List of Event Hubs Kafka brokers to connect to (example:
            yourdomain.servicebus.windows.net:9093). The hostname can be found
            in the host portion of the primary or secondary connection string in
            Shared Access Policies."
          minItems: 1
          items:
            type: string
            minLength: 1
        topics:
          type: array
          title: Event Hub name
          description: "The name of the Event Hub (Kafka topic) to subscribe to. Warning:
            To optimize performance, Cribl suggests subscribing each Event Hubs
            Source to only a single topic."
          minItems: 1
          default: []
          items:
            type: string
            minLength: 1
        groupId:
          type: string
          default: Cribl
          title: Group ID
          description: The consumer group this instance belongs to. Default is 'Cribl'.
        fromBeginning:
          type: boolean
          default: true
          title: From beginning
          description: Start reading from earliest available data; relevant only during
            initial subscription
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        sasl:
          type: object
          title: Authentication
          description: Authentication parameters to use when connecting to brokers. Using
            TLS is highly recommended.
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            authType:
              enum:
                - manual
                - secret
              title: Authentication method
              type: string
              default: manual
              description: Enter password directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            password:
              type: string
              title: Password
              description: Connection-string primary key, or connection-string secondary key,
                from the Event Hubs workspace
            textSecret:
              type: string
              title: Password (text secret)
              description: Select or create a stored text secret
            mechanism:
              enum:
                - plain
                - oauthbearer
              type: string
              x-speakeasy-enum-descriptions:
                - PLAIN
                - OAUTHBEARER
              title: SASL mechanism
              default: plain
              x-speakeasy-unknown-values: allow
            username:
              type: string
              title: Username
              default: $ConnectionString
              description: The username for authentication. For Event Hubs, this should always
                be $ConnectionString.
            clientSecretAuthType:
              enum:
                - manual
                - secret
                - certificate
              title: Authentication method
              type: string
              default: manual
              x-speakeasy-unknown-values: allow
            clientSecret:
              type: string
              title: Client secret
              description: client_secret to pass in the OAuth request parameter
            clientTextSecret:
              type: string
              title: Client secret (text secret)
              description: Select or create a stored text secret
            certificateName:
              type: string
              title: Certificate
              description: Select or create a stored certificate
            certPath:
              type: string
            privKeyPath:
              type: string
            passphrase:
              type: string
            oauthEndpoint:
              type: string
              title: Microsoft Entra ID authentication endpoint
              default: https://login.microsoftonline.com
              enum:
                - https://login.microsoftonline.com
                - https://login.microsoftonline.us
                - https://login.partner.microsoftonline.cn
              description: Endpoint used to acquire authentication tokens from Azure
              x-speakeasy-unknown-values: allow
            clientId:
              type: string
              title: Client ID
              description: client_id to pass in the OAuth request parameter
            tenantId:
              type: string
              title: Tenant identifier
              description: Directory ID (tenant identifier) in Azure Active Directory
            scope:
              type: string
              title: Scope
              description: Scope to pass in the OAuth request parameter
        tls:
          type: object
          title: TLS settings (client side)
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another trusted CA (such as the
                system's)
              default: true
        sessionTimeout:
          type: number
          title: Session timeout (ms)
          description: >2-
            
                  Timeout (session.timeout.ms in Kafka domain) used to detect client failures when using Kafka's group-management facilities.
                  If the client sends no heartbeats to the broker before the timeout expires, the broker will remove the client from the group and initiate a rebalance.
                  Value must be lower than rebalanceTimeout.
                  See details [here](https://github.com/Azure/azure-event-hubs-for-kafka/blob/master/CONFIGURATION.md).
          default: 30000
          minimum: 6000
          maximum: 300000
        rebalanceTimeout:
          type: number
          title: Rebalance timeout (ms)
          description: >2-
            
                  Maximum allowed time (rebalance.timeout.ms in Kafka domain) for each worker to join the group after a rebalance begins.
                  If the timeout is exceeded, the coordinator broker will remove the worker from the group.
                  See [Recommended configurations](https://github.com/Azure/azure-event-hubs-for-kafka/blob/master/CONFIGURATION.md).
          default: 60000
          minimum: 1000
          maximum: 3600000
        heartbeatInterval:
          type: number
          title: Heartbeat interval (ms)
          description: >2-
            
                  Expected time (heartbeat.interval.ms in Kafka domain) between heartbeats to the consumer coordinator when using Kafka's group-management facilities.
                  Value must be lower than sessionTimeout and typically should not exceed 1/3 of the sessionTimeout value.
                  See [Recommended configurations](https://github.com/Azure/azure-event-hubs-for-kafka/blob/master/CONFIGURATION.md).
          default: 3000
          minimum: 1000
          maximum: 3600000
        autoCommitInterval:
          type: number
          title: Offset commit interval (ms)
          description: How often to commit offsets. If both this and Offset commit
            threshold are set, @{product} commits offsets when either condition
            is met. If both are empty, @{product} commits offsets after each
            batch.
          minimum: 1000
          maximum: 3600000
        autoCommitThreshold:
          type: number
          title: Offset commit threshold
          description: How many events are needed to trigger an offset commit. If both
            this and Offset commit interval are set, @{product} commits offsets
            when either condition is met. If both are empty, @{product} commits
            offsets after each batch.
          minimum: 1
          maximum: 10000
        maxBytesPerPartition:
          type: number
          title: Byte limit, per partition
          description: Maximum amount of data that Kafka will return per partition, per
            fetch request. Must equal or exceed the maximum message size
            (maxBytesPerPartition) that Kafka is configured to allow. Otherwise,
            @{product} can get stuck trying to retrieve messages. Defaults to
            1048576 (1 MB).
          minimum: 1
          maximum: 10000000
          default: 1048576
        maxBytes:
          type: number
          title: Byte limit
          description: Maximum number of bytes that Kafka will return per fetch request.
            Defaults to 10485760 (10 MB).
          minimum: 1
          maximum: 1000000000
          default: 10485760
        maxSocketErrors:
          type: number
          title: Error limit, per socket
          description: Maximum number of network errors before the consumer re-creates a
            socket
          minimum: 0
          maximum: 100
          default: 0
        minimizeDuplicates:
          type: boolean
          title: Minimize duplicates
          description: Minimize duplicate events by starting only one consumer for each
            topic partition
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputExec:
      type: object
      required:
        - type
        - command
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          enum:
            - exec
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        command:
          type: string
          title: Command
          description: Command to execute; supports Bourne shell (or CMD on Windows) syntax
        retries:
          type: number
          title: Retry limit
          description: Maximum number of retry attempts in the event that the command fails
          default: 10
          minimum: 0
        scheduleType:
          title: Schedule type
          type: string
          enum:
            - interval
            - cronSchedule
          default: interval
          description: Select a schedule type; either an interval (in seconds) or a
            cron-style schedule.
          x-speakeasy-unknown-values: allow
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
        interval:
          type: number
          title: Interval
          description: Interval between command executions in seconds.
          default: 60
          minimum: 1
        cronSchedule:
          type: string
          title: Schedule
          description: Cron schedule to execute the command on.
          default: "* * * * *"
    InputFirehose:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - firehose
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: string
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputGooglePubsub:
      type: object
      required:
        - type
        - subscriptionName
        - topicName
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - google_pubsub
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        topicName:
          type: string
          title: Topic ID
          description: ID of the topic to receive events from. When Monitor subscription
            is enabled, any value may be entered.
          default: cribl
        subscriptionName:
          type: string
          title: Subscription ID
          description: "ID of the subscription to use when receiving events. When Monitor
            subscription is enabled, the fully qualified subscription name must
            be entered. Example:
            projects/myProject/subscriptions/mySubscription"
        monitorSubscription:
          type: boolean
          title: Monitor subscription for new messages
          description: Use when the subscription is not created by this Source and topic
            is not known
          default: false
        createTopic:
          type: boolean
          title: Create topic
          description: Create topic if it does not exist
          default: false
        createSubscription:
          type: boolean
          title: Create subscription
          description: Create subscription if it does not exist
          default: true
        region:
          type: string
          title: Region
          description: Region to retrieve messages from. Select 'default' to allow Google
            to auto-select the nearest region. When using ordered delivery, the
            selected region must be allowed by message storage policy.
        googleAuthMethod:
          type: string
          title: Google authentication method
          description: Choose Auto to use Google Application Default Credentials (ADC),
            Manual to enter Google service account credentials directly, or
            Secret to select or create a stored secret that references Google
            service account credentials.
          default: manual
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret
          x-speakeasy-unknown-values: allow
        serviceAccountCredentials:
          type: string
          title: Service account credentials
          description: Contents of service account credentials (JSON keys) file downloaded
            from Google Cloud. To upload a file, click the upload button at this
            field's upper right.
        secret:
          type: string
          title: Service account credentials (text secret)
          description: Select or create a stored text secret
        maxBacklog:
          type: number
          title: Backlog limit
          description: If Destination exerts backpressure, this setting limits how many
            inbound events Stream will queue for processing before it stops
            retrieving events
          default: 1000
          minimum: 1
        concurrency:
          type: number
          title: Number of concurrent streams
          description: How many streams to pull messages from at one time. Doubling the
            value doubles the number of messages this Source pulls from the
            topic (if available), while consuming more CPU and memory. Defaults
            to 5.
          default: 5
          minimum: 1
          maximum: 100
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Pull request timeout, in milliseconds
          default: 60000
          minimum: 10000
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
        orderedDelivery:
          type: boolean
          title: Ordered delivery
          description: Receive events in the order they were added to the queue. The
            process sending events must have ordering enabled.
          default: false
    InputCribl:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - cribl
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        filter:
          type: string
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
      required:
        - type
    InputCriblTcp:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - cribl_tcp
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process.
            Use 0 for unlimited.
          default: 1000
          minimum: 0
        socketIdleTimeout:
          type: number
          title: Socket idle timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. After this time, the connection will be
            closed. Leave at 0 for no inactive socket monitoring.
          default: 0
          minimum: 0
        socketEndingMaxWait:
          type: number
          title: Forced socket termination timeout (seconds)
          description: How long the server will wait after initiating a closure for a
            client to close its end of the connection. If the client doesn't
            close the connection within this time, the server will forcefully
            terminate the socket to prevent resource leaks and ensure efficient
            connection cleanup and system stability. Leave at 0 for no inactive
            socket monitoring.
          default: 30
          minimum: 0
        socketMaxLifespan:
          type: number
          title: Socket max lifespan (seconds)
          description: The maximum duration a socket can remain open, even if active. This
            helps manage resources and mitigate issues caused by TCP pinning.
            Set to 0 to disable.
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Enable proxy protocol
          description: Enable if the connection is proxied by a device that supports proxy
            protocol v1 or v2
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        enableLoadBalancing:
          type: boolean
          title: Enable load balancing
          description: Load balance traffic across all Worker Processes
          default: false
        authTokens:
          type: array
          title: Connected environment tokens
          description: Shared secrets to be used by connected environments to authorize
            connections. These tokens should be installed in Cribl TCP
            destinations in connected environments.
          items:
            type: object
            required:
              - tokenSecret
            properties:
              tokenSecret:
                type: string
                title: Token secret (text secret)
                description: Select or create a stored text secret
              enabled:
                type: boolean
                title: Enable token
                default: true
              description:
                type: string
                title: Description
                description: Optional token description
        description:
          type: string
          title: Description
    InputCriblHttp:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - cribl_http
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Connected environment tokens
          description: Shared secrets to be used by connected environments to authorize
            connections. These tokens should be installed in Cribl HTTP
            destinations in connected environments.
          items:
            type: object
            required:
              - tokenSecret
            properties:
              tokenSecret:
                type: string
                title: Token secret (text secret)
                description: Select or create a stored text secret
              enabled:
                type: boolean
                title: Enable token
                default: true
              description:
                type: string
                title: Description
                description: Optional token description
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputCriblLakeHttp:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - cribl_lake_http
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: string
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        criblAPI:
          type: string
          title: Cribl HTTP event API
          description: Absolute path on which to listen for the Cribl HTTP API requests.
            Only _bulk (default /cribl/_bulk) is available. Use empty string to
            disable.
          default: /cribl
          pattern: ^/|^$
        elasticAPI:
          type: string
          title: Elasticsearch API endpoint (Bulk API)
          description: Absolute path on which to listen for the Elasticsearch API
            requests. Only _bulk (default /elastic/_bulk) is available. Use
            empty string to disable.
          default: /elastic
          pattern: ^/|^$
        splunkHecAPI:
          type: string
          title: Splunk HEC endpoint
          description: Absolute path on which listen for the Splunk HTTP Event Collector
            API requests. Use empty string to disable.
          default: /services/collector
          pattern: ^/|^$
        splunkHecAcks:
          type: boolean
          title: Enable Splunk HEC acknowledgements
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        authTokensExt:
          type: array
          title: Auth tokens
          items:
            type: object
            required:
              - token
            properties:
              token:
                type: string
                title: Token
              description:
                type: string
              metadata:
                type: array
                title: Fields
                description: Fields to add to events referencing this token
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
              splunkHecMetadata:
                type: object
                properties:
                  enabled:
                    type: boolean
                    title: Splunk HEC
              elasticsearchMetadata:
                type: object
                properties:
                  enabled:
                    title: Elasticsearch
                    type: boolean
        description:
          type: string
          title: Description
    InputTcpjson:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - tcpjson
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to establish a
            connection
          default: /.*/
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process.
            Use 0 for unlimited.
          default: 1000
          minimum: 0
        socketIdleTimeout:
          type: number
          title: Socket idle timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. After this time, the connection will be
            closed. Leave at 0 for no inactive socket monitoring.
          default: 0
          minimum: 0
        socketEndingMaxWait:
          type: number
          title: Forced socket termination timeout (seconds)
          description: How long the server will wait after initiating a closure for a
            client to close its end of the connection. If the client doesn't
            close the connection within this time, the server will forcefully
            terminate the socket to prevent resource leaks and ensure efficient
            connection cleanup and system stability. Leave at 0 for no inactive
            socket monitoring.
          default: 30
          minimum: 0
        socketMaxLifespan:
          type: number
          title: Socket max lifespan (seconds)
          description: The maximum duration a socket can remain open, even if active. This
            helps manage resources and mitigate issues caused by TCP pinning.
            Set to 0 to disable.
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Enable proxy protocol
          description: Enable if the connection is proxied by a device that supports proxy
            protocol v1 or v2
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        enableLoadBalancing:
          type: boolean
          title: Enable load balancing
          description: Load balance traffic across all Worker Processes
          default: false
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        authToken:
          type: string
          title: Auth token
          description: Shared secret to be provided by any client (in authToken header
            field). If empty, unauthorized access is permitted.
          default: ""
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
    InputSystemMetrics:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - system_metrics
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        interval:
          type: number
          default: 10
          minimum: 1
          title: Polling interval
          description: Time, in seconds, between consecutive metric collections. Default
            is 10 seconds.
        host:
          type: object
          properties:
            mode:
              type: string
              description: Select level of detail for host metrics
              enum:
                - basic
                - all
                - custom
                - disabled
              x-speakeasy-enum-descriptions:
                - Basic
                - All
                - Custom
                - Disabled
              default: basic
              x-speakeasy-unknown-values: allow
            custom:
              type: object
              properties:
                system:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of detail for system metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    processes:
                      type: boolean
                      default: false
                      title: Process metrics
                      description: Generate metrics for the numbers of processes in various states
                cpu:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of detail for CPU metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    perCpu:
                      type: boolean
                      default: false
                      title: Per-CPU metrics
                      description: Generate metrics for each CPU
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate metrics for all CPU states
                    time:
                      type: boolean
                      default: false
                      title: CPU time metrics
                      description: Generate raw, monotonic CPU time counters
                memory:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of detail for memory metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate metrics for all memory states
                network:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of detail for network metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate full network metrics
                    protocols:
                      type: boolean
                      default: false
                      title: Protocol metrics
                      description: Generate protocol metrics for ICMP, ICMPMsg, IP, TCP, UDP and
                        UDPLite
                    devices:
                      type: array
                      title: Interface filter
                      description: "Network interfaces to include/exclude. Examples: eth0, !lo. All
                        interfaces are included if this list is empty."
                      default:
                        - "!lo"
                        - "*"
                      items:
                        type: string
                    perInterface:
                      type: boolean
                      default: false
                      title: Per-interface metrics
                      description: Generate separate metrics for each interface
                disk:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of detail for disk metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate full disk metrics
                    inodes:
                      type: boolean
                      default: false
                      title: Enable inode metrics
                      description: Generate filesystem inode metrics
                    devices:
                      type: array
                      title: Device filter
                      description: "Block devices to include/exclude. Examples: sda*, !loop*.
                        Wildcards and ! (not) operators are supported. All
                        devices are included if this list is empty."
                      default:
                        - "!loop*"
                        - "*"
                      items:
                        type: string
                    mountpoints:
                      type: array
                      title: Mountpoint filter
                      description: "Filesystem mountpoints to include/exclude. Examples: /, /home,
                        !/proc*, !/tmp. Wildcards and ! (not) operators are
                        supported. All mountpoints are included if this list is
                        empty."
                      default: []
                      items:
                        type: string
                    fstypes:
                      type: array
                      title: Filesystem type filter
                      description: "Filesystem types to include/exclude. Examples: ext4, !*tmpfs,
                        !squashfs. Wildcards and ! (not) operators are
                        supported. All types are included if this list is
                        empty."
                      default: []
                      items:
                        type: string
                    perDevice:
                      type: boolean
                      default: false
                      title: Per-device metrics
                      description: Generate separate metrics for each device
        process:
          type: object
          properties:
            sets:
              type: array
              title: Process sets
              description: Configure sets to collect process metrics
              items:
                type: object
                required:
                  - name
                  - filter
                properties:
                  name:
                    type: string
                    title: Set Name
                  filter:
                    type: string
                    title: Filter Expression
                  includeChildren:
                    type: boolean
                    title: Include Child Processes
                    default: false
        container:
          type: object
          properties:
            mode:
              type: string
              description: Select the level of detail for container metrics
              enum:
                - basic
                - all
                - custom
                - disabled
              x-speakeasy-enum-descriptions:
                - Basic
                - All
                - Custom
                - Disabled
              default: basic
              x-speakeasy-unknown-values: allow
            dockerSocket:
              type: array
              title: Docker socket
              description: Full paths for Docker's UNIX-domain socket
              default:
                - /var/run/docker.sock
                - /run/docker.sock
              items:
                type: string
            dockerTimeout:
              type: number
              default: 5
              minimum: 1
              title: Docker timeout
              description: Timeout, in seconds, for the Docker API
            filters:
              type: array
              title: Container filters
              description: Containers matching any of these will be included. All are included
                if no filters are added.
              items:
                type: object
                required:
                  - expr
                properties:
                  expr:
                    type: string
                    title: Expression
            allContainers:
              type: boolean
              default: false
              title: All containers
              description: Include stopped and paused containers
            perDevice:
              type: boolean
              default: false
              title: Per-device metrics
              description: Generate separate metrics for each device
            detail:
              type: boolean
              default: false
              title: Detailed metrics
              description: Generate full container metrics
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        persistence:
          type: object
          title: persistence
          properties:
            enable:
              type: boolean
              title: Enable disk spooling
              description: Spool metrics to disk for Cribl Edge and Search
              default: false
            timeWindow:
              type: string
              title: Bucket time span
              description: Time span for each file bucket
              default: 10m
            maxDataSize:
              type: string
              title: Data size limit
              description: "Maximum disk space allowed to be consumed (examples: 420MB, 4GB).
                When limit is reached, older data will be deleted."
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1GB
            maxDataTime:
              title: Data age limit
              type: string
              description: "Maximum amount of time to retain data (examples: 2h, 4d). When
                limit is reached, older data will be deleted."
              pattern: \d+[smhd]$
              default: 24h
            compress:
              type: string
              title: Data compression format
              enum:
                - none
                - gzip
              default: gzip
              x-speakeasy-unknown-values: allow
            destPath:
              type: string
              title: Path location
              default: $CRIBL_HOME/state/system_metrics
              description: Path to use to write metrics. Defaults to
                $CRIBL_HOME/state/system_metrics
        description:
          type: string
          title: Description
      required:
        - type
    InputSystemState:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - system_state
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        interval:
          type: number
          default: 300
          minimum: 1
          title: Polling interval
          description: Time, in seconds, between consecutive state collections. Default is
            300 seconds (5 minutes).
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        collectors:
          type: object
          properties:
            hostsfile:
              type: object
              title: Hosts File
              description: Creates events based on entries collected from the hosts file
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            interfaces:
              type: object
              title: Interfaces
              description: Creates events for each of the host’s network interfaces
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            disk:
              type: object
              title: Disks & File Systems
              description: Creates events for physical disks, partitions, and file systems
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            metadata:
              type: object
              title: Host Info
              description: Creates events based on the host system’s current state
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            routes:
              type: object
              title: Routes
              description: Creates events based on entries collected from the host’s network
                routes
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            dns:
              type: object
              title: DNS
              description: Creates events for DNS resolvers and search entries
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            user:
              type: object
              title: Users & Groups
              description: Creates events for local users and groups
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            firewall:
              type: object
              title: Firewall
              description: Creates events for Firewall rules entries
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            services:
              type: object
              title: Services
              description: Creates events from the list of services
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            ports:
              type: object
              title: Listening Ports
              description: Creates events from list of listening ports
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
            loginUsers:
              type: object
              title: Logged-In Users
              description: Creates events from list of logged-in users
              properties:
                enable:
                  type: boolean
                  title: Enabled
                  default: true
        persistence:
          type: object
          properties:
            enable:
              type: boolean
              title: Enable disk spooling
              description: Spool metrics to disk for Cribl Edge and Search
              default: false
            timeWindow:
              type: string
              title: Bucket time span
              description: Time span for each file bucket
              default: 10m
            maxDataSize:
              type: string
              title: Data size limit
              description: "Maximum disk space allowed to be consumed (examples: 420MB, 4GB).
                When limit is reached, older data will be deleted."
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1GB
            maxDataTime:
              title: Data age limit
              type: string
              description: "Maximum amount of time to retain data (examples: 2h, 4d). When
                limit is reached, older data will be deleted."
              pattern: \d+[smhd]$
              default: 24h
            compress:
              type: string
              title: Data compression format
              enum:
                - none
                - gzip
              default: none
              x-speakeasy-unknown-values: allow
            destPath:
              type: string
              title: Path location
              default: $CRIBL_HOME/state/system_state
              description: Path to use to write metrics. Defaults to
                $CRIBL_HOME/state/system_state
        disableNativeModule:
          type: boolean
          default: false
          title: Use Windows Tools
          description: Enable to use built-in tools (PowerShell) to collect events instead
            of native API (default) [Learn
            more](https://docs.cribl.io/edge/sources-system-state/#advanced-tab)
        description:
          type: string
          title: Description
      required:
        - type
    InputKubeMetrics:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - kube_metrics
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        interval:
          type: number
          default: 15
          minimum: 1
          title: Polling interval
          description: Time, in seconds, between consecutive metrics collections. Default
            is 15 secs.
        rules:
          type: array
          title: Filter Rules
          description: Add rules to decide which Kubernetes objects to generate metrics
            for. Events are generated if no rules are given or of all the rules'
            expressions evaluate to true.
          items:
            type: object
            required:
              - filter
            properties:
              filter:
                type: string
                title: Filter Expression
                description: JavaScript expression applied to Kubernetes objects. Return 'true'
                  to include it.
              description:
                type: string
                title: Description
                description: Optional description of this rule's purpose
          default:
            - filter: "!metadata.namespace.startsWith('kube-')"
              description: Ignore the kube-* namespace
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        persistence:
          type: object
          title: persistence
          properties:
            enable:
              type: boolean
              title: Enable disk spooling
              description: Spool metrics on disk for Cribl Search
              default: false
            timeWindow:
              type: string
              title: Bucket time span
              description: Time span for each file bucket
              default: 10m
            maxDataSize:
              type: string
              title: Data size limit
              description: "Maximum disk space allowed to be consumed (examples: 420MB, 4GB).
                When limit is reached, older data will be deleted."
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1GB
            maxDataTime:
              title: Data age limit
              type: string
              description: "Maximum amount of time to retain data (examples: 2h, 4d). When
                limit is reached, older data will be deleted."
              pattern: \d+[smhd]$
              default: 24h
            compress:
              type: string
              title: Data compression format
              enum:
                - none
                - gzip
              default: gzip
              x-speakeasy-unknown-values: allow
            destPath:
              type: string
              title: Path location
              default: $CRIBL_HOME/state/kube_metrics
              description: Path to use to write metrics. Defaults to $CRIBL_HOME/state/<id>
        description:
          type: string
          title: Description
      required:
        - type
    InputKubeLogs:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - kube_logs
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        interval:
          type: number
          default: 15
          minimum: 1
          title: Polling interval
          description: Time, in seconds, between checks for new containers. Default is 15
            secs.
        rules:
          type: array
          title: Filter Rules
          description: Add rules to decide which Pods to collect logs from. Logs are
            collected if no rules are given or if all the rules' expressions
            evaluate to true.
          items:
            type: object
            required:
              - filter
            properties:
              filter:
                type: string
                title: Filter Expression
                description: JavaScript expression applied to Pod objects. Return 'true' to
                  include it.
              description:
                type: string
                title: Description
                description: Optional description of this rule's purpose
          default:
            - filter: "!metadata.namespace.startsWith('kube-')"
              description: Ignore the kube-* namespace
        timestamps:
          type: boolean
          default: false
          title: Enable timestamps
          description: For use when containers do not emit a timestamp, prefix each line
            of output with a timestamp. If you enable this setting, you can use
            the Kubernetes Logs Event Breaker and the kubernetes_logs
            Pre-processing Pipeline to remove them from the events after the
            timestamps are extracted.
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        persistence:
          type: object
          title: Disk Spooling
          properties:
            enable:
              type: boolean
              title: Enable disk spooling
              description: Spool events on disk for Cribl Edge and Search. Default is
                disabled.
              default: false
            timeWindow:
              type: string
              title: Bucket time span
              description: Time period for grouping spooled events. Default is 10m.
              default: 10m
            maxDataSize:
              type: string
              title: Data size limit
              description: "Maximum disk space that can be consumed before older buckets are
                deleted. Examples: 420MB, 4GB. Default is 1GB."
              pattern: ^\d+(\.\d+)?\s*(?:[kmgKMG](b|B))?$
              default: 1GB
            maxDataTime:
              title: Data age limit
              type: string
              description: "Maximum amount of time to retain data before older buckets are
                deleted. Examples: 2h, 4d. Default is 24h."
              pattern: \d+[smhd]$
              default: 24h
            compress:
              type: string
              title: Compression
              description: Data compression format. Default is gzip.
              enum:
                - none
                - gzip
              default: gzip
              x-speakeasy-unknown-values: allow
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        enableLoadBalancing:
          type: boolean
          title: Enable load balancing
          description: Load balance traffic across all Worker Processes
          default: false
        description:
          type: string
          title: Description
      required:
        - type
    InputKubeEvents:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - kube_events
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        rules:
          type: array
          title: Filter Rules
          description: Filtering on event fields
          items:
            type: object
            required:
              - filter
            properties:
              filter:
                type: string
                title: Filter Expression
                description: JavaScript expression applied to Kubernetes objects. Return 'true'
                  to include it.
              description:
                type: string
                title: Description
                description: Optional description of this rule's purpose
          default: []
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
      required:
        - type
    InputWindowsMetrics:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - windows_metrics
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        interval:
          type: number
          default: 10
          minimum: 1
          title: Polling interval
          description: Time, in seconds, between consecutive metric collections. Default
            is 10 seconds.
        host:
          type: object
          properties:
            mode:
              type: string
              description: Select level of detail for host metrics
              enum:
                - basic
                - all
                - custom
                - disabled
              x-speakeasy-enum-descriptions:
                - Basic
                - All
                - Custom
                - Disabled
              default: basic
              x-speakeasy-unknown-values: allow
            custom:
              type: object
              properties:
                system:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of details for system metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate metrics for all system information
                cpu:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of details for CPU metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    perCpu:
                      type: boolean
                      default: false
                      title: Per-CPU metrics
                      description: Generate metrics for each CPU
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate metrics for all CPU states
                    time:
                      type: boolean
                      default: false
                      title: CPU time metrics
                      description: Generate raw, monotonic CPU time counters
                memory:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of details for memory metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate metrics for all memory states
                network:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of details for network metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate full network metrics
                    protocols:
                      type: boolean
                      default: false
                      title: Protocol metrics
                      description: Generate protocol metrics for ICMP, ICMPMsg, IP, TCP, UDP and
                        UDPLite
                    devices:
                      type: array
                      title: Interface filter
                      description: Network interfaces to include/exclude. All interfaces are included
                        if this list is empty.
                      default:
                        - "!6to4*"
                        - "!*Debug*"
                        - "!*Virtual*"
                        - "!*Tunneling*"
                        - "!*IP-HTTPS*"
                        - "*"
                      items:
                        type: string
                    perInterface:
                      type: boolean
                      default: false
                      title: Per interface metrics
                      description: Generate separate metrics for each interface
                disk:
                  type: object
                  properties:
                    mode:
                      type: string
                      description: Select the level of details for disk metrics
                      enum:
                        - basic
                        - all
                        - custom
                        - disabled
                      x-speakeasy-enum-descriptions:
                        - Basic
                        - All
                        - Custom
                        - Disabled
                      default: basic
                      x-speakeasy-unknown-values: allow
                    perVolume:
                      type: boolean
                      default: false
                      title: Per volume metrics
                      description: Generate separate metrics for each volume
                    detail:
                      type: boolean
                      default: false
                      title: Detailed metrics
                      description: Generate full disk metrics
                    volumes:
                      type: array
                      title: Volume filter
                      description: "Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards
                        and ! (not) operators are supported. All volumes are
                        included if this list is empty."
                      default:
                        - "!HarddiskVolume*"
                        - "*"
                      items:
                        type: string
        process:
          type: object
          properties:
            sets:
              type: array
              title: Process sets
              description: Configure sets to collect process metrics
              items:
                type: object
                required:
                  - name
                  - filter
                properties:
                  name:
                    type: string
                    title: Set Name
                  filter:
                    type: string
                    title: Filter Expression
                  includeChildren:
                    type: boolean
                    title: Include Child Processes
                    default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        persistence:
          type: object
          title: persistence
          properties:
            enable:
              type: boolean
              title: Enable disk spooling
              description: Spool metrics to disk for Cribl Edge and Search
              default: false
            timeWindow:
              type: string
              title: Bucket time span
              description: Time span for each file bucket
              default: 10m
            maxDataSize:
              type: string
              title: Data size limit
              description: "Maximum disk space allowed to be consumed (examples: 420MB, 4GB).
                When limit is reached, older data will be deleted."
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1GB
            maxDataTime:
              title: Data age limit
              type: string
              description: "Maximum amount of time to retain data (examples: 2h, 4d). When
                limit is reached, older data will be deleted."
              pattern: \d+[smhd]$
              default: 24h
            compress:
              type: string
              title: Data compression format
              enum:
                - none
                - gzip
              default: gzip
              x-speakeasy-unknown-values: allow
            destPath:
              type: string
              title: Path location
              default: $CRIBL_HOME/state/windows_metrics
              description: Path to use to write metrics. Defaults to
                $CRIBL_HOME/state/windows_metrics
        disableNativeModule:
          type: boolean
          default: false
          title: Use Windows Tools
          description: Enable to use built-in tools (PowerShell) to collect metrics
            instead of native API (default) [Learn
            more](https://docs.cribl.io/edge/sources-windows-metrics/#advanced-tab)
        description:
          type: string
          title: Description
      required:
        - type
    InputCrowdstrike:
      type: object
      required:
        - type
        - queueName
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - crowdstrike
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        queueName:
          type: string
          title: Queue
          description: "The name, URL, or ARN of the SQS queue to read notifications from.
            When a non-AWS URL is specified, format must be:
            '{url}/myQueueName'. Example: 'https://host:port/myQueueName'. Value
            must be a JavaScript expression (which can evaluate to a constant
            value), enclosed in quotes or backticks. Can be evaluated only at
            init time. Example referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`."
        fileFilter:
          type: string
          title: Filename filter
          description: "Regex matching file names to download and process. Defaults to: .*"
          default: /.*/
        awsAccountId:
          title: AWS account ID
          description: SQS queue owner's AWS account ID. Leave empty if SQS queue is in
            same AWS account.
          type: string
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: AWS Region where the S3 bucket and SQS queue are located. Required,
            unless the Queue entry is a URL or ARN that includes a Region.
        endpoint:
          type: string
          title: Endpoint
          description: S3 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to S3-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing S3 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        maxMessages:
          type: number
          title: Message limit
          description: "The maximum number of messages SQS should return in a poll
            request. Amazon SQS never returns more messages than this value
            (however, fewer messages might be returned). Valid values: 1 to 10."
          default: 1
          minimum: 1
          maximum: 10
        visibilityTimeout:
          type: number
          title: Visibility timeout seconds
          description: After messages are retrieved by a ReceiveMessage request,
            @{product} will hide them from subsequent retrieve requests for at
            least this duration. You can set this as high as 43200 sec. (12
            hours).
          default: 21600
          minimum: 0
          maximum: 43200
        numReceivers:
          type: number
          title: Number of receivers
          description: How many receiver processes to run. The higher the number, the
            better the throughput - at the expense of CPU overhead.
          default: 1
          minimum: 1
          maximum: 100
        socketTimeout:
          type: number
          title: Socket timeout
          description: Socket inactivity timeout (in seconds). Increase this value if
            timeouts occur due to backpressure.
          default: 300
          minimum: 1
          maximum: 43200
        skipOnError:
          type: boolean
          title: Skip file on error
          description: Skip files that trigger a processing error. Disabled by default,
            which allows retries after processing errors.
          default: false
        includeSqsMetadata:
          type: boolean
          title: Include notification metadata
          description: Attach SQS notification metadata to a __sqsMetadata field on each
            event
          default: false
        enableAssumeRole:
          type: boolean
          title: Enable for Amazon S3
          description: Use Assume Role credentials to access Amazon S3
          default: true
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        enableSQSAssumeRole:
          type: boolean
          title: Enable for Amazon SQS
          description: Use Assume Role credentials when accessing Amazon SQS
          default: false
        preprocess:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            command:
              type: string
              title: Command
              description: Command to feed the data through (via stdin) and process its output
                (stdout)
            args:
              type: array
              title: Arguments
              description: Arguments to be added to the custom command
              items:
                type: string
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        checkpointing:
          type: object
          required:
            - enabled
          properties:
            enabled:
              type: boolean
              title: Enable checkpointing
              description: Resume processing files after an interruption
              default: false
            retries:
              type: number
              title: Retries
              description: The number of times to retry processing when a processing error
                occurs. If Skip file on error is enabled, this setting is
                ignored.
              default: 5
              maximum: 100
              minimum: 0
        pollTimeout:
          type: number
          title: Poll timeout (secs)
          description: How long to wait for events before trying polling again. The lower
            the number the higher the AWS bill. The higher the number the longer
            it will take for the source to react to configuration changes and
            system restarts.
          default: 10
          minimum: 1
          maximum: 20
        encoding:
          type: string
          title: Encoding
          description: Character encoding to use when parsing ingested data. When not set,
            @{product} will default to UTF-8 but may incorrectly interpret
            multi-byte characters.
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        tagAfterProcessing:
          enum:
            - false
            - true
          x-speakeasy-unknown-values: allow
        processedTagKey:
          type: string
          title: Tag key
          description: The key for the S3 object tag applied after processing. This field
            accepts an expression for dynamic generation.
        processedTagValue:
          type: string
          title: Tag value
          description: The value for the S3 object tag applied after processing. This
            field accepts an expression for dynamic generation.
    InputDatadogAgent:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - datadog_agent
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        extractMetrics:
          type: boolean
          title: Extract metrics
          description: Toggle to Yes to extract each incoming metric to multiple events,
            one per data point. This works well when sending metrics to a
            statsd-type output. If sending metrics to DatadogHQ or any
            destination that accepts arbitrary JSON, leave toggled to No (the
            default).
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        proxyMode:
          type: object
          title: ""
          required:
            - enabled
          properties:
            enabled:
              type: boolean
              title: Forward API key validation requests
              default: false
              description: Toggle to Yes to send key validation requests from Datadog Agent to
                the Datadog API. If toggled to No (the default), Stream handles
                key validation requests by always responding that the key is
                valid.
            rejectUnauthorized:
              type: boolean
              title: Reject unauthorized certificates
              description: Whether to reject certificates that cannot be verified against a
                valid CA (e.g., self-signed certificates).
              default: true
        description:
          type: string
          title: Description
    InputDatagen:
      type: object
      required:
        - type
        - samples
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - datagen
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        samples:
          title: Datagens
          type: array
          minItems: 1
          items:
            type: object
            required:
              - sample
              - eventsPerSec
            properties:
              sample:
                type: string
                title: Data Generator File Name
              eventsPerSec:
                type: number
                title: Events Per Second Per Worker Node
                description: Maximum number of events to generate per second per Worker Node.
                  Defaults to 10.
                default: 10
                minimum: 1
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputHttpRaw:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - http_raw
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: string
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        allowedPaths:
          type: array
          title: Allowed URI paths
          description: List of URI paths accepted by this input, wildcards are supported,
            e.g /api/v*/hook. Defaults to allow all.
          default:
            - "*"
          items:
            type: string
            minLength: 1
        allowedMethods:
          type: array
          title: Allowed HTTP methods
          description: List of HTTP methods accepted by this input. Wildcards are
            supported (such as P*, GET). Defaults to allow all.
          default:
            - "*"
          items:
            type: string
            minLength: 1
        authTokensExt:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: object
            required:
              - token
            properties:
              token:
                type: string
                title: Token
                description: "Shared secret to be provided by any client (Authorization:
                  <token>)"
              description:
                type: string
                title: Description
              metadata:
                type: array
                title: Fields
                description: Fields to add to events referencing this token
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputKinesis:
      type: object
      required:
        - type
        - streamName
        - region
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - kinesis
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        streamName:
          type: string
          title: Stream name
          description: Kinesis Data Stream to read data from
        serviceInterval:
          type: number
          title: Service period
          description: Time interval in minutes between consecutive service calls
          default: 1
          minimum: 1
          maximum: 5
        shardExpr:
          type: string
          title: Shard selection expression
          description: A JavaScript expression to be called with each shardId for the
            stream. If the expression evaluates to a truthy value, the shard
            will be processed.
          default: "true"
        shardIteratorType:
          type: string
          title: Shard iterator start
          description: Location at which to start reading a shard for the first time
          enum:
            - TRIM_HORIZON
            - LATEST
          x-speakeasy-enum-descriptions:
            - Earliest record
            - Latest record
          default: TRIM_HORIZON
          x-speakeasy-unknown-values: allow
        payloadFormat:
          type: string
          title: Record data format
          description: Format of data inside the Kinesis Stream records. Gzip compression
            is automatically detected.
          enum:
            - cribl
            - ndjson
            - cloudwatch
            - line
          x-speakeasy-enum-descriptions:
            - Cribl
            - Newline JSON
            - Cloudwatch Logs
            - Event per line
          default: cribl
          x-speakeasy-unknown-values: allow
        getRecordsLimit:
          type: number
          title: Records limit per call
          description: Maximum number of records per getRecords call
          minimum: 5000
          default: 5000
          maximum: 10000
        getRecordsLimitTotal:
          type: number
          title: Total records limit
          description: Maximum number of records, across all shards, to pull down at once
            per Worker Process
          minimum: 20000
          default: 20000
        loadBalancingAlgorithm:
          type: string
          title: Shard load balancing
          description: The load-balancing algorithm to use for spreading out shards across
            Workers and Worker Processes
          enum:
            - ConsistentHashing
            - RoundRobin
          x-speakeasy-enum-descriptions:
            - Consistent Hashing
            - Round Robin
          default: ConsistentHashing
          x-speakeasy-unknown-values: allow
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the Kinesis stream is located
        endpoint:
          type: string
          title: Endpoint
          description: Kinesis stream service endpoint. If empty, defaults to the AWS
            Region-specific endpoint. Otherwise, it must point to Kinesis
            stream-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing Kinesis stream requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for Kinesis stream
          description: Use Assume Role credentials to access Kinesis stream
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        verifyKPLCheckSums:
          type: boolean
          title: Verify KPL checksums
          description: Verify Kinesis Producer Library (KPL) event checksums
          default: false
        avoidDuplicates:
          type: boolean
          title: Avoid duplicate records
          description: When resuming streaming from a stored state, Stream will read the
            next available record, rather than rereading the last-read record.
            Enabling this setting can cause data loss after a Worker Node's
            unexpected shutdown or restart.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
    InputCriblmetrics:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - criblmetrics
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        prefix:
          type: string
          title: Metric name prefix
          description: A prefix that is applied to the metrics provided by Cribl Stream
          default: cribl.logstream.
        fullFidelity:
          type: boolean
          title: Full fidelity
          description: "Include granular metrics. Disabling this will drop the following
            metrics events:
            `cribl.logstream.host.(in_bytes,in_events,out_bytes,out_events)`,
            `cribl.logstream.index.(in_bytes,in_events,out_bytes,out_events)`,
            `cribl.logstream.source.(in_bytes,in_events,out_bytes,out_events)`,
            `cribl.logstream.sourcetype.(in_bytes,in_events,out_bytes,out_event\
            s)`."
          default: true
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
      required:
        - type
    InputMetrics:
      type: object
      required:
        - type
        - host
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - metrics
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. For IPv4 (all addresses), use the default
            '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP
            address.
          default: 0.0.0.0
        udpPort:
          type: number
          title: UDP Port
          maximum: 65535
          description: Enter UDP port number to listen on. Not required if listening on TCP.
        tcpPort:
          type: number
          title: TCP Port
          maximum: 65535
          description: Enter TCP port number to listen on. Not required if listening on UDP.
        maxBufferSize:
          type: number
          title: Buffer size limit (events)
          description: Maximum number of events to buffer when downstream is blocking.
            Only applies to UDP.
          default: 1000
          minimum: 0
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to send data
          default: /.*/
        enableProxyHeader:
          type: boolean
          title: Enable proxy protocol
          description: Enable if the connection is proxied by a device that supports Proxy
            Protocol V1 or V2
          default: false
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        udpSocketRxBufSize:
          type: number
          title: UDP socket buffer size (bytes)
          description: "Optionally, set the SO_RCVBUF socket option for the UDP socket.
            This value tells the operating system how many bytes can be buffered
            in the kernel before events are dropped. Leave blank to use the OS
            default. Caution: Increasing this value will affect OS memory
            utilization."
          minimum: 256
          maximum: 4294967295
        description:
          type: string
          title: Description
    InputS3:
      type: object
      required:
        - type
        - queueName
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - s3
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        queueName:
          type: string
          title: Queue
          description: "The name, URL, or ARN of the SQS queue to read notifications from.
            When a non-AWS URL is specified, format must be:
            '{url}/myQueueName'. Example: 'https://host:port/myQueueName'. Value
            must be a JavaScript expression (which can evaluate to a constant
            value), enclosed in quotes or backticks. Can be evaluated only at
            init time. Example referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`."
        fileFilter:
          type: string
          title: Filename filter
          description: "Regex matching file names to download and process. Defaults to: .*"
          default: /.*/
        awsAccountId:
          title: AWS account ID
          description: SQS queue owner's AWS account ID. Leave empty if SQS queue is in
            same AWS account.
          type: string
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: AWS Region where the S3 bucket and SQS queue are located. Required,
            unless the Queue entry is a URL or ARN that includes a Region.
        endpoint:
          type: string
          title: Endpoint
          description: S3 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to S3-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing S3 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        maxMessages:
          type: number
          title: Message limit
          description: "The maximum number of messages SQS should return in a poll
            request. Amazon SQS never returns more messages than this value
            (however, fewer messages might be returned). Valid values: 1 to 10."
          default: 1
          minimum: 1
          maximum: 10
        visibilityTimeout:
          type: number
          title: Visibility timeout seconds
          description: After messages are retrieved by a ReceiveMessage request,
            @{product} will hide them from subsequent retrieve requests for at
            least this duration. You can set this as high as 43200 sec. (12
            hours).
          default: 600
          minimum: 0
          maximum: 43200
        numReceivers:
          type: number
          title: Number of receivers
          description: How many receiver processes to run. The higher the number, the
            better the throughput - at the expense of CPU overhead.
          default: 1
          minimum: 1
          maximum: 100
        socketTimeout:
          type: number
          title: Socket timeout
          description: Socket inactivity timeout (in seconds). Increase this value if
            timeouts occur due to backpressure.
          default: 300
          minimum: 1
          maximum: 43200
        skipOnError:
          type: boolean
          title: Skip file on error
          description: Skip files that trigger a processing error. Disabled by default,
            which allows retries after processing errors.
          default: false
        includeSqsMetadata:
          type: boolean
          title: Include notification metadata
          description: Attach SQS notification metadata to a __sqsMetadata field on each
            event
          default: false
        enableAssumeRole:
          type: boolean
          title: Enable for Amazon S3
          description: Use Assume Role credentials to access Amazon S3
          default: true
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        enableSQSAssumeRole:
          type: boolean
          title: Enable for Amazon SQS
          description: Use Assume Role credentials when accessing Amazon SQS
          default: false
        preprocess:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            command:
              type: string
              title: Command
              description: Command to feed the data through (via stdin) and process its output
                (stdout)
            args:
              type: array
              title: Arguments
              description: Arguments to be added to the custom command
              items:
                type: string
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        parquetChunkSizeMB:
          type: number
          title: Parquet chunk size limit (MB)
          description: Maximum file size for each Parquet chunk
          default: 5
          maximum: 100
          minimum: 1
        parquetChunkDownloadTimeout:
          type: number
          title: Parquet chunk download timeout (seconds)
          description: The maximum time allowed for downloading a Parquet chunk.
            Processing will stop if a chunk cannot be downloaded within the time
            specified.
          default: 600
          maximum: 3600
          minimum: 1
        checkpointing:
          type: object
          required:
            - enabled
          properties:
            enabled:
              type: boolean
              title: Enable checkpointing
              description: Resume processing files after an interruption
              default: false
            retries:
              type: number
              title: Retries
              description: The number of times to retry processing when a processing error
                occurs. If Skip file on error is enabled, this setting is
                ignored.
              default: 5
              maximum: 100
              minimum: 0
        pollTimeout:
          type: number
          title: Poll timeout (secs)
          description: How long to wait for events before trying polling again. The lower
            the number the higher the AWS bill. The higher the number the longer
            it will take for the source to react to configuration changes and
            system restarts.
          default: 10
          minimum: 1
          maximum: 20
        encoding:
          type: string
          title: Encoding
          description: Character encoding to use when parsing ingested data. When not set,
            @{product} will default to UTF-8 but may incorrectly interpret
            multi-byte characters.
        tagAfterProcessing:
          type: boolean
          title: Tag after processing
          description: Add a tag to processed S3 objects. Requires s3:GetObjectTagging and
            s3:PutObjectTagging AWS permissions.
          default: false
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        processedTagKey:
          type: string
          title: Tag key
          description: The key for the S3 object tag applied after processing. This field
            accepts an expression for dynamic generation.
        processedTagValue:
          type: string
          title: Tag value
          description: The value for the S3 object tag applied after processing. This
            field accepts an expression for dynamic generation.
    InputS3Inventory:
      type: object
      required:
        - type
        - queueName
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - s3_inventory
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        queueName:
          type: string
          title: Queue
          description: "The name, URL, or ARN of the SQS queue to read notifications from.
            When a non-AWS URL is specified, format must be:
            '{url}/myQueueName'. Example: 'https://host:port/myQueueName'. Value
            must be a JavaScript expression (which can evaluate to a constant
            value), enclosed in quotes or backticks. Can be evaluated only at
            init time. Example referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`."
        fileFilter:
          type: string
          title: Filename filter
          description: "Regex matching file names to download and process. Defaults to: .*"
          default: /.*/
        awsAccountId:
          title: AWS account ID
          description: SQS queue owner's AWS account ID. Leave empty if SQS queue is in
            same AWS account.
          type: string
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: AWS Region where the S3 bucket and SQS queue are located. Required,
            unless the Queue entry is a URL or ARN that includes a Region.
        endpoint:
          type: string
          title: Endpoint
          description: S3 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to S3-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing S3 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        maxMessages:
          type: number
          title: Message limit
          description: "The maximum number of messages SQS should return in a poll
            request. Amazon SQS never returns more messages than this value
            (however, fewer messages might be returned). Valid values: 1 to 10."
          default: 1
          minimum: 1
          maximum: 10
        visibilityTimeout:
          type: number
          title: Visibility timeout seconds
          description: After messages are retrieved by a ReceiveMessage request,
            @{product} will hide them from subsequent retrieve requests for at
            least this duration. You can set this as high as 43200 sec. (12
            hours).
          default: 600
          minimum: 0
          maximum: 43200
        numReceivers:
          type: number
          title: Number of receivers
          description: How many receiver processes to run. The higher the number, the
            better the throughput - at the expense of CPU overhead.
          default: 1
          minimum: 1
          maximum: 100
        socketTimeout:
          type: number
          title: Socket timeout
          description: Socket inactivity timeout (in seconds). Increase this value if
            timeouts occur due to backpressure.
          default: 300
          minimum: 1
          maximum: 43200
        skipOnError:
          type: boolean
          title: Skip file on error
          description: Skip files that trigger a processing error. Disabled by default,
            which allows retries after processing errors.
          default: false
        includeSqsMetadata:
          type: boolean
          title: Include notification metadata
          description: Attach SQS notification metadata to a __sqsMetadata field on each
            event
          default: false
        enableAssumeRole:
          type: boolean
          title: Enable for Amazon S3
          description: Use Assume Role credentials to access Amazon S3
          default: true
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        enableSQSAssumeRole:
          type: boolean
          title: Enable for Amazon SQS
          description: Use Assume Role credentials when accessing Amazon SQS
          default: false
        preprocess:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            command:
              type: string
              title: Command
              description: Command to feed the data through (via stdin) and process its output
                (stdout)
            args:
              type: array
              title: Arguments
              description: Arguments to be added to the custom command
              items:
                type: string
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        parquetChunkSizeMB:
          type: number
          title: Parquet chunk size limit (MB)
          description: Maximum file size for each Parquet chunk
          default: 5
          maximum: 100
          minimum: 1
        parquetChunkDownloadTimeout:
          type: number
          title: Parquet chunk download timeout (seconds)
          description: The maximum time allowed for downloading a Parquet chunk.
            Processing will stop if a chunk cannot be downloaded within the time
            specified.
          default: 600
          maximum: 3600
          minimum: 1
        checkpointing:
          type: object
          required:
            - enabled
          properties:
            enabled:
              type: boolean
              title: Enable checkpointing
              description: Resume processing files after an interruption
              default: false
            retries:
              type: number
              title: Retries
              description: The number of times to retry processing when a processing error
                occurs. If Skip file on error is enabled, this setting is
                ignored.
              default: 5
              maximum: 100
              minimum: 0
        pollTimeout:
          type: number
          title: Poll timeout (secs)
          description: How long to wait for events before trying polling again. The lower
            the number the higher the AWS bill. The higher the number the longer
            it will take for the source to react to configuration changes and
            system restarts.
          default: 10
          minimum: 1
          maximum: 20
        checksumSuffix:
          type: string
          title: Checksum Suffix
          description: Filename suffix of the manifest checksum file. If a filename
            matching this suffix is received        in the queue, the matching
            manifest file will be downloaded and validated against its value.
            Defaults to "checksum"
          default: checksum
        maxManifestSizeKB:
          type: integer
          title: Manifest size limit (KB)
          description: Maximum download size (KB) of each manifest or checksum file.
            Manifest files larger than this size will not be
            read.        Defaults to 4096.
          default: 4096
          minimum: 1
        validateInventoryFiles:
          type: boolean
          title: Validate inventory files
          description: If set to Yes, each inventory file in the manifest will be
            validated against its checksum. Defaults to false
          default: false
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        tagAfterProcessing:
          enum:
            - false
            - true
          x-speakeasy-unknown-values: allow
        processedTagKey:
          type: string
          title: Tag key
          description: The key for the S3 object tag applied after processing. This field
            accepts an expression for dynamic generation.
        processedTagValue:
          type: string
          title: Tag value
          description: The value for the S3 object tag applied after processing. This
            field accepts an expression for dynamic generation.
    InputSnmp:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - snmp
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. For IPv4 (all addresses), use the default
            '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP
            address.
          default: 0.0.0.0
        port:
          type: number
          title: UDP port
          maximum: 65535
          description: UDP port to receive SNMP traps on. Defaults to 162.
          default: 162
        snmpV3Auth:
          type: object
          title: SNMPv3 authentication
          description: Authentication parameters for SNMPv3 trap. Set the log level to
            debug if you are experiencing authentication or decryption issues.
          required:
            - v3AuthEnabled
          properties:
            v3AuthEnabled:
              type: boolean
              title: Enabled
              default: false
            allowUnmatchedTrap:
              type: boolean
              title: Allow unmatched traps
              description: Pass through traps that don't match any of the configured users.
                @{product} will not attempt to decrypt these traps.
              default: false
            v3Users:
              type: array
              title: SNMP v3 users
              description: User credentials for receiving v3 traps
              minItems: 1
              items:
                type: object
                required:
                  - name
                properties:
                  name:
                    title: V3 name
                    type: string
                    minLength: 1
                  authProtocol:
                    type: string
                    default: none
                    enum:
                      - none
                      - md5
                      - sha
                      - sha224
                      - sha256
                      - sha384
                      - sha512
                    x-speakeasy-enum-descriptions:
                      - None
                      - MD5
                      - SHA1
                      - SHA224
                      - SHA256
                      - SHA384
                      - SHA512
                    title: Authentication protocol
                    x-speakeasy-unknown-values: allow
                  authKey: {}
                  privProtocol:
                    default: none
        maxBufferSize:
          type: number
          title: Buffer size limit (events)
          description: Maximum number of events to buffer when downstream is blocking.
          default: 1000
          minimum: 0
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to send data
          default: /.*/
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        udpSocketRxBufSize:
          type: number
          title: UDP socket buffer size (bytes)
          description: "Optionally, set the SO_RCVBUF socket option for the UDP socket.
            This value tells the operating system how many bytes can be buffered
            in the kernel before events are dropped. Leave blank to use the OS
            default. Caution: Increasing this value will affect OS memory
            utilization."
          minimum: 256
          maximum: 4294967295
        varbindsWithTypes:
          type: boolean
          title: Include varbind types
          description: If enabled, parses varbinds as an array of objects that include
            OID, value, and type
          default: false
        bestEffortParsing:
          type: boolean
          title: Best effort parsing
          description: If enabled, the parser will attempt to parse varbind octet strings
            as UTF-8, first, otherwise will fallback to other methods
          default: false
        description:
          type: string
          title: Description
    InputOpenTelemetry:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - open_telemetry
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
          default: 4317
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader: {}
        captureHeaders: {}
        activityLogSampleRate: {}
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            sec.; maximum 600 sec. (10 min.).
          default: 15
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Enable to expose the /cribl_health endpoint, which returns 200 OK
            when this Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist.
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        protocol:
          type: string
          title: Protocol
          description: Select whether to leverage gRPC or HTTP for OpenTelemetry
          enum:
            - grpc
            - http
          x-speakeasy-enum-descriptions:
            - gRPC
            - HTTP
          default: grpc
          x-speakeasy-unknown-values: allow
        extractSpans:
          type: boolean
          title: Extract spans
          description: Enable to extract each incoming span to a separate event
          default: false
        extractMetrics:
          type: boolean
          title: Extract metrics
          description: Enable to extract each incoming Gauge or IntGauge metric to
            multiple events, one per data point
          default: false
        otlpVersion:
          type: string
          title: OTLP version
          description: The version of OTLP Protobuf definitions to use when interpreting
            received data
          enum:
            - 0.10.0
            - 1.3.1
          x-speakeasy-enum-descriptions:
            - 0.10.0
            - 1.3.1
          default: 0.10.0
          x-speakeasy-unknown-values: allow
        authType:
          type: string
          title: Authentication type
          description: OpenTelemetry authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          default: none
          x-speakeasy-unknown-values: allow
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process.
            Use 0 for unlimited.
          default: 1000
          minimum: 0
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
        extractLogs:
          type: boolean
          title: Extract logs
          description: Enable to extract each incoming log record to a separate event
          default: false
    InputModelDrivenTelemetry:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - model_driven_telemetry
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
          default: 57000
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process.
            Use 0 for unlimited.
          default: 1000
          minimum: 0
        shutdownTimeoutMs:
          type: number
          title: Shutdown timeout
          description: Time in milliseconds to allow the server to shutdown gracefully
            before forcing shutdown. Defaults to 5000.
          default: 5000
          minimum: 1
        description:
          type: string
          title: Description
    InputSqs:
      type: object
      required:
        - type
        - queueName
        - queueType
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - sqs
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        queueName:
          type: string
          title: Queue
          description: "The name, URL, or ARN of the SQS queue to read events from. When a
            non-AWS URL is specified, format must be: '{url}/myQueueName'.
            Example: 'https://host:port/myQueueName'. Value must be a JavaScript
            expression (which can evaluate to a constant value), enclosed in
            quotes or backticks. Can only be evaluated at init time. Example
            referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`."
        queueType:
          title: Queue type
          type: string
          description: The queue type used (or created)
          enum:
            - standard
            - fifo
          x-speakeasy-enum-descriptions:
            - Standard
            - FIFO
          x-speakeasy-unknown-values: allow
        awsAccountId:
          title: AWS account ID
          description: SQS queue owner's AWS account ID. Leave empty if SQS queue is in
            same AWS account.
          type: string
        createQueue:
          type: boolean
          title: Create queue
          description: Create queue if it does not exist
          default: false
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: AWS Region where the SQS queue is located. Required, unless the
            Queue entry is a URL or ARN that includes a Region.
        endpoint:
          type: string
          title: Endpoint
          description: SQS service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to SQS-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing SQS requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for SQS
          description: Use Assume Role credentials to access SQS
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        maxMessages:
          type: number
          title: Message limit
          description: "The maximum number of messages SQS should return in a poll
            request. Amazon SQS never returns more messages than this value
            (however, fewer messages might be returned). Valid values: 1 to 10."
          default: 10
          minimum: 1
          maximum: 10
        visibilityTimeout:
          type: number
          title: Visibility Timeout Seconds
          description: After messages are retrieved by a ReceiveMessage request,
            @{product} will hide them from subsequent retrieve requests for at
            least this duration. You can set this as high as 43200 sec. (12
            hours).
          default: 600
          minimum: 0
          maximum: 43200
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        pollTimeout:
          type: number
          title: Poll timeout (secs)
          description: How long to wait for events before trying polling again. The lower
            the number the higher the AWS bill. The higher the number the longer
            it will take for the source to react to configuration changes and
            system restarts.
          default: 10
          minimum: 1
          maximum: 20
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        numReceivers:
          type: number
          title: Number of receivers
          description: How many receiver processes to run. The higher the number, the
            better the throughput - at the expense of CPU overhead.
          default: 3
          minimum: 1
          maximum: 100
    InputSyslog:
      type: object
      required:
        - type
        - host
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - syslog
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. For IPv4 (all addresses), use the default
            '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP
            address.
          default: 0.0.0.0
        udpPort:
          type: number
          title: UDP port
          maximum: 65535
          description: Enter UDP port number to listen on. Not required if listening on TCP.
        tcpPort:
          type: number
          title: TCP port
          maximum: 65535
          description: Enter TCP port number to listen on. Not required if listening on UDP.
        maxBufferSize:
          type: number
          title: Buffer size limit (events)
          description: Maximum number of events to buffer when downstream is blocking.
            Only applies to UDP.
          default: 1000
          minimum: 0
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to send data
          default: /.*/
        timestampTimezone:
          type: string
          title: Default timezone
          description: Timezone to assign to timestamps without timezone info
          default: local
        singleMsgUdpPackets:
          type: boolean
          title: Single msg per UDP
          description: Treat UDP packet data received as full syslog message
          default: false
        enableProxyHeader:
          type: boolean
          title: Enable proxy protocol
          description: Enable if the connection is proxied by a device that supports Proxy
            Protocol V1 or V2
          default: false
        keepFieldsList:
          type: array
          title: Fields to keep
          description: Wildcard list of fields to keep from source data; * = ALL (default)
          default: []
          minItems: 0
          items:
            type: string
        octetCounting:
          type: boolean
          title: Octet count framing
          description: Enable if incoming messages use octet counting per RFC 6587.
          default: false
        inferFraming:
          type: boolean
          title: Infer Syslog framing
          description: Enable if we should infer the syslog framing of the incoming
            messages.
          default: true
        strictlyInferOctetCounting:
          type: boolean
          title: Strictly infer octet count framing
          description: Enable if we should infer octet counting only if the messages
            comply with RFC 5424.
          default: true
        allowNonStandardAppName:
          type: boolean
          title: Allow non-standard app name
          description: Enable if RFC 3164-formatted messages have hyphens in the app name
            portion of the TAG section. If disabled, only alphanumeric
            characters and underscores are allowed. Ignored for RFC
            5424-formatted messages.
          default: false
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process for
            TCP connections. Use 0 for unlimited.
          default: 1000
          minimum: 0
        socketIdleTimeout:
          type: number
          title: TCP socket idle timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. After this time, the connection will be
            closed. Leave at 0 for no inactive socket monitoring.
          default: 0
          minimum: 0
        socketEndingMaxWait:
          type: number
          title: TCP forced socket termination timeout (seconds)
          description: How long the server will wait after initiating a closure for a
            client to close its end of the connection. If the client doesn't
            close the connection within this time, the server will forcefully
            terminate the socket to prevent resource leaks and ensure efficient
            connection cleanup and system stability. Leave at 0 for no inactive
            socket monitoring.
          default: 30
          minimum: 0
        socketMaxLifespan:
          type: number
          title: TCP Socket max lifespan (seconds)
          description: The maximum duration a socket can remain open, even if active. This
            helps manage resources and mitigate issues caused by TCP pinning.
            Set to 0 to disable.
          default: 0
          minimum: 0
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        udpSocketRxBufSize:
          type: number
          title: UDP socket buffer size (bytes)
          description: "Optionally, set the SO_RCVBUF socket option for the UDP socket.
            This value tells the operating system how many bytes can be buffered
            in the kernel before events are dropped. Leave blank to use the OS
            default. Caution: Increasing this value will affect OS memory
            utilization."
          minimum: 256
          maximum: 4294967295
        enableLoadBalancing:
          type: boolean
          title: Enable TCP load balancing
          description: Load balance traffic across all Worker Processes
          default: false
        description:
          type: string
          title: Description
        enableEnhancedProxyHeaderParsing:
          type: boolean
          title: Enable enhanced TLS handshake for proxy protocol
          description: When enabled, parses PROXY protocol headers during the TLS
            handshake. Disable if compatibility issues arise.
      anyOf:
        - required:
            - host
            - udpPort
        - required:
            - host
            - tcpPort
    InputFile:
      type: object
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          enum:
            - file
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        mode:
          type: string
          enum:
            - manual
            - auto
          x-speakeasy-enum-descriptions:
            - Manual
            - Auto
          default: manual
          description: Choose how to discover files to monitor
          x-speakeasy-unknown-values: allow
        interval:
          type: number
          default: 10
          minimum: 1
          title: Polling interval
          description: Time, in seconds, between scanning for files
        filenames:
          type: array
          title: Filename allowlist
          description: The full path of discovered files are matched against this wildcard
            list
          default:
            - "*/log/*"
            - "*log"
          items:
            type: string
        filterArchivedFiles:
          type: boolean
          default: false
          title: Apply filename allowlist internal to archive files
          description: Apply filename allowlist to file entries in archive file types,
            like tar or zip.
        tailOnly:
          type: boolean
          default: true
          title: Collect from end
          description: Read only new entries at the end of all files discovered at next
            startup. @{product} will then read newly discovered files from the
            head. Disable this to resume reading all files from head.
        idleTimeout:
          type: number
          default: 300
          minimum: 1
          title: Idle timeout
          description: Time, in seconds, before an idle file is closed
        minAgeDur:
          type: string
          title: Minimum age duration
          description: "The minimum age of files to monitor. Format examples: 30s, 15m,
            1h. Age is relative to file modification time. Leave empty to apply
            no age filters."
        maxAgeDur:
          type: string
          title: Maximum age duration
          description: 'The maximum age of event timestamps to collect. Format examples:
            60s, 4h, 3d, 1w. Can be used in conjuction with "Check file
            modification times". Leave empty to apply no age filters.'
        checkFileModTime:
          type: boolean
          default: false
          title: Check file modification times
          description: Skip files with modification times earlier than the maximum age
            duration
        forceText:
          type: boolean
          default: false
          title: Force text format
          description: Forces files containing binary data to be streamed as text
        hashLen:
          type: number
          default: 256
          minimum: 1
          title: Hash length
          description: Length of file header bytes to use in hash for unique file
            identification
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        description:
          type: string
          title: Description
        path:
          type: string
          title: Search path
          description: Directory path to search for files. Environment variables will be
            resolved, e.g. $CRIBL_HOME/log/.
        depth:
          type: number
          minimum: 0
          title: Max depth
          description: Set how many subdirectories deep to search. Use 0 to search only
            files in the given path, 1 to also look in its immediate
            subdirectories, etc. Leave it empty for unlimited depth.
        suppressMissingPathErrors:
          type: boolean
          default: false
          title: Suppress errors when search path does not exist
        deleteFiles:
          type: boolean
          default: false
          title: Delete files
          description: Delete files after they have been collected
        includeUnidentifiableBinary:
          type: boolean
          default: false
          title: Enable binary files
          description: Stream binary files as Base64-encoded chunks.
      required:
        - type
    InputTcp:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - tcp
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to establish a
            connection
          default: /.*/
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process.
            Use 0 for unlimited.
          default: 1000
          minimum: 0
        socketIdleTimeout:
          type: number
          title: Socket idle timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. After this time, the connection will be
            closed. Leave at 0 for no inactive socket monitoring.
          default: 0
          minimum: 0
        socketEndingMaxWait:
          type: number
          title: Forced socket termination timeout (seconds)
          description: How long the server will wait after initiating a closure for a
            client to close its end of the connection. If the client doesn't
            close the connection within this time, the server will forcefully
            terminate the socket to prevent resource leaks and ensure efficient
            connection cleanup and system stability. Leave at 0 for no inactive
            socket monitoring.
          default: 30
          minimum: 0
        socketMaxLifespan:
          type: number
          title: Socket max lifespan (seconds)
          description: The maximum duration a socket can remain open, even if active. This
            helps manage resources and mitigate issues caused by TCP pinning.
            Set to 0 to disable.
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Enable proxy protocol
          description: Enable if the connection is proxied by a device that supports proxy
            protocol v1 or v2
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        enableHeader:
          type: boolean
          title: Enable header
          description: 'Client will pass the header record with every new connection. The
            header can contain an authToken, and an object with a list of fields
            and values to add to every event. These fields can be used to
            simplify Event Breaker selection, routing, etc. Header has this
            format, and must be followed by a newline: { "authToken" :
            "myToken", "fields": { "field1": "value1", "field2": "value2" } }'
          default: false
        preprocess:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            command:
              type: string
              title: Command
              description: Command to feed the data through (via stdin) and process its output
                (stdout)
            args:
              type: array
              title: Arguments
              description: Arguments to be added to the custom command
              items:
                type: string
        description:
          type: string
          title: Description
        authToken:
          type: string
          title: Auth token
          description: Shared secret to be provided by any client (in authToken header
            field). If empty, unauthorized access is permitted.
          default: ""
        authType:
          enum:
            - manual
            - secret
          title: Authentication method
          type: string
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
    InputAppscope:
      type: object
      required:
        - type
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - appscope
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to establish a
            connection
          default: /.*/
        maxActiveCxn:
          type: number
          title: Active connection limit
          description: Maximum number of active connections allowed per Worker Process.
            Use 0 for unlimited.
          default: 1000
          minimum: 0
        socketIdleTimeout:
          type: number
          title: Socket idle timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. After this time, the connection will be
            closed. Leave at 0 for no inactive socket monitoring.
          default: 0
          minimum: 0
        socketEndingMaxWait:
          type: number
          title: Forced socket termination timeout (seconds)
          description: How long the server will wait after initiating a closure for a
            client to close its end of the connection. If the client doesn't
            close the connection within this time, the server will forcefully
            terminate the socket to prevent resource leaks and ensure efficient
            connection cleanup and system stability. Leave at 0 for no inactive
            socket monitoring.
          default: 30
          minimum: 0
        socketMaxLifespan:
          type: number
          title: Socket max lifespan (seconds)
          description: The maximum duration a socket can remain open, even if active. This
            helps manage resources and mitigate issues caused by TCP pinning.
            Set to 0 to disable.
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Enable proxy protocol
          description: Enable if the connection is proxied by a device that supports proxy
            protocol v1 or v2
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        enableUnixPath:
          type: boolean
          title: UNIX domain socket
          description: Toggle to Yes to specify a file-backed UNIX domain socket
            connection, instead of a network host and port.
          default: false
        filter:
          type: object
          properties:
            allow:
              type: array
              title: Rules
              description: Specify processes that AppScope should be loaded into, and the
                config to use.
              items:
                type: object
                properties:
                  procname:
                    type: string
                    title: Process name
                    description: Specify the name of a process or family of processes.
                  arg:
                    type: string
                    title: Process argument
                    description: Specify a string to substring-match against process command-line.
                  config:
                    type: string
                    title: AppScope config
                    description: Choose a config to apply to processes that match the process name
                      and/or argument.
                required:
                  - procname
                  - config
            transportURL:
              type: string
              title: Transport override
              description: To override the UNIX domain socket or address/port specified in
                General Settings (while leaving Authentication settings as is),
                enter a URL.
        persistence:
          type: object
          title: Persistence
          properties:
            enable:
              type: boolean
              title: Enable disk spooling
              description: Spool events and metrics on disk for Cribl Edge and Search
              default: false
            timeWindow:
              type: string
              title: Bucket time span
              description: Time span for each file bucket
              default: 10m
            maxDataSize:
              type: string
              title: Data size limit
              description: "Maximum disk space allowed to be consumed (examples: 420MB, 4GB).
                When limit is reached, older data will be deleted."
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1GB
            maxDataTime:
              title: Data age limit
              type: string
              description: "Maximum amount of time to retain data (examples: 2h, 4d). When
                limit is reached, older data will be deleted."
              pattern: \d+[smhd]$
              default: 24h
            compress:
              type: string
              title: Data compression format
              enum:
                - none
                - gzip
              default: gzip
              x-speakeasy-unknown-values: allow
            destPath:
              type: string
              title: Path location
              default: $CRIBL_HOME/state/appscope
              description: Path to use to write metrics. Defaults to
                $CRIBL_HOME/state/appscope
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        unixSocketPath:
          type: string
          title: UNIX socket path
          default: $CRIBL_HOME/state/appscope.sock
          description: Path to the UNIX domain socket to listen on.
        unixSocketPerms:
          type: string
          title: UNIX socket permissions
          description: Permissions to set for socket e.g., 777. If empty, falls back to
            the runtime user's default permissions.
        authToken:
          type: string
          title: Auth token
          description: Shared secret to be provided by any client (in authToken header
            field). If empty, unauthorized access is permitted.
          default: ""
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
    InputWef:
      type: object
      required:
        - type
        - host
        - port
        - subscriptions
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - wef
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
          default: 5986
        authMethod:
          type: string
          title: Authentication method
          description: How to authenticate incoming client connections
          enum:
            - clientCert
            - kerberos
          x-speakeasy-enum-descriptions:
            - Client certificate
            - Kerberos
          default: clientCert
          x-speakeasy-unknown-values: allow
        tls:
          type: object
          title: mTLS settings
          required:
            - privKeyPath
            - certPath
            - caPath
          properties:
            disabled:
              type: boolean
              title: Disabled
              description: Enable TLS
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certs
              description: Required for WEF certificate authentication
              default: true
            requestCert:
              type: boolean
              title: Authenticate client
              description: Required for WEF certificate authentication
              default: true
            certificateName:
              type: string
              title: Certificate
              description: Name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Server path containing CA certificates (in PEM format) to use. Can
                reference $ENV_VARS. If multiple certificates are present in a
                .pem, each must directly certify the one preceding it.
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            ocspCheck:
              type: boolean
              title: Verify certificate via OCSP
              description: Enable OCSP check of certificate
              default: false
            keytab: {}
            principal: {}
            ocspCheckFailClose:
              type: boolean
              title: Strict validation
              description: If enabled, checks will fail on any OCSP error. Otherwise, checks
                will fail only when a certificate is revoked, ignoring other
                errors.
              default: false
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Preserve the client’s original IP address in the __srcIpPort field
            when connecting through an HTTP proxy that supports the
            X-Forwarded-For header. This does not apply to TCP-layer Proxy
            Protocol v1/v2.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events in the __headers field
          default: false
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 90
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        caFingerprint:
          type: string
          title: CA fingerprint override
          description: SHA1 fingerprint expected by the client, if it does not match the
            first certificate in the configured CA chain
        keytab:
          type: string
          title: Keytab location
          description: Path to the keytab file containing the service principal
            credentials. @{product} will use `/etc/krb5.keytab` if not provided.
        principal:
          type: string
          title: Service principal name
          description: Kerberos principal used for authentication, typically in the form
            HTTP/<hostname>@<REALM>
        allowMachineIdMismatch:
          type: boolean
          title: Allow MachineID mismatch
          description: Allow events to be ingested even if their MachineID does not match
            the client certificate CN
          default: false
        subscriptions:
          title: Subscriptions
          description: Subscriptions to events on forwarding endpoints
          type: array
          items:
            type: object
            required:
              - subscriptionName
              - contentFormat
              - heartbeatInterval
              - batchTimeout
              - targets
            minLength: 1
            properties:
              subscriptionName:
                title: Subscription name
                type: string
              version:
                title: Version
                type: string
                description: Version UUID for this subscription. If any subscription parameters
                  are modified, this value will change.
              contentFormat:
                title: Format
                type: string
                enum:
                  - Raw
                  - RenderedText
                description: Content format in which the endpoint should deliver events
                default: Raw
                x-speakeasy-unknown-values: allow
              heartbeatInterval:
                title: Heartbeat
                type: number
                description: Maximum time (in seconds) between endpoint checkins before
                  considering it unavailable
                minimum: 1
                default: 60
              batchTimeout:
                title: Batch timeout
                type: number
                description: Interval (in seconds) over which the endpoint should collect events
                  before sending them to Stream
                minimum: 0
                default: 60
              readExistingEvents:
                title: Read existing events
                type: boolean
                description: Newly subscribed endpoints will send previously existing events.
                  Disable to receive new events only.
                default: false
              sendBookmarks:
                title: Use bookmarks
                type: boolean
                description: Keep track of which events have been received, resuming from that
                  point after a re-subscription. This setting takes precedence
                  over 'Read existing events'. See [Cribl
                  Docs](https://docs.cribl.io/stream/sources-wef/#subscriptions)
                  for more details.
                default: true
              compress:
                title: Compression
                type: boolean
                description: Receive compressed events from the source
                default: true
              targets:
                type: array
                title: Targets
                description: The DNS names of the endpoints that should forward these events.
                  You may use wildcards, such as *.mydomain.com
                items:
                  type: string
                  minLength: 1
                default:
                  - "*"
              locale:
                title: Locale
                type: string
                description: The RFC-3066 locale the Windows clients should use when sending
                  events. Defaults to "en-US".
                default: en-US
              querySelector:
                type: string
                title: Query builder mode
                enum:
                  - simple
                  - xml
                default: simple
                x-speakeasy-unknown-values: allow
              metadata:
                type: array
                title: Fields
                description: Fields to add to events ingested under this subscription
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
        logFingerprintMismatch:
          type: boolean
          title: Log CA fingerprint mismatch warning
          description: Log a warning if the client certificate authority (CA) fingerprint
            does not match the expected value. A mismatch prevents Cribl from
            receiving events from the Windows Event Forwarder.
          default: false
    InputWinEventLogs:
      type: object
      required:
        - type
        - logNames
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - win_event_logs
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        logNames:
          type: array
          title: Event logs
          description: Enter the event logs to collect. Run "Get-WinEvent -ListLog *" in
            PowerShell to see the available logs.
          default:
            - ""
          items:
            minLength: 1
            type: string
          minItems: 1
          uniqueItems: true
        readMode:
          type: string
          default: newest
          enum:
            - oldest
            - newest
          title: Read mode
          x-speakeasy-enum-descriptions:
            - Entire log
            - From last entry
          description: Read all stored and future event logs, or only future events
          x-speakeasy-unknown-values: allow
        eventFormat:
          type: string
          default: json
          enum:
            - json
            - xml
          title: Event format
          x-speakeasy-enum-descriptions:
            - JSON
            - XML
          description: Format of individual events
          x-speakeasy-unknown-values: allow
        disableNativeModule:
          type: boolean
          default: false
          title: Use Windows Tools
          description: Enable to use built-in tools (PowerShell for JSON, wevtutil for
            XML) to collect event logs instead of native API (default) [Learn
            more](https://docs.cribl.io/edge/sources-windows-event-logs/#advanced-settings)
        interval:
          type: number
          default: 10
          minimum: 1
          title: Polling interval
          description: Time, in seconds, between checking for new entries (Applicable for
            pre-4.8.0 nodes that use Windows Tools)
        batchSize:
          type: number
          default: 500
          minimum: 1
          title: Batch size
          description: The maximum number of events to read in one polling interval. A
            batch size higher than 500 can cause delays when pulling from
            multiple event logs. (Applicable for pre-4.8.0 nodes that use
            Windows Tools)
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        maxEventBytes:
          type: number
          title: Max event bytes
          description: The maximum number of bytes in an event before it is flushed to the
            pipelines
          default: 51200
          minimum: 1
          maximum: 134217728
        description:
          type: string
          title: Description
        disableJsonRendering:
          type: boolean
          default: false
          title: Render event message strings
          description: Enable/disable the rendering of localized event message strings
            (Applicable for 4.8.0 nodes and newer that use the Native API)
        disableXmlRendering:
          type: boolean
          default: true
          title: Render event message strings
          description: Enable/disable the rendering of localized event message strings
            (Applicable for 4.8.0 nodes and newer that use the Native API)
    InputRawUdp:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - raw_udp
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. For IPv4 (all addresses), use the default
            '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP
            address.
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        maxBufferSize:
          type: number
          title: Buffer size limit (events)
          description: Maximum number of events to buffer when downstream is blocking.
          default: 1000
          minimum: 0
        ipWhitelistRegex:
          type: string
          title: IP allowlist regex
          description: Regex matching IP addresses that are allowed to send data
          default: /.*/
        singleMsgUdpPackets:
          type: boolean
          title: Single msg per UDP
          description: If true, each UDP packet is assumed to contain a single message. If
            false, each UDP packet is assumed to contain multiple messages,
            separated by newlines.
          default: false
        ingestRawBytes:
          type: boolean
          title: Ingest raw bytes
          description: If true, a __rawBytes field will be added to each event containing
            the raw bytes of the datagram.
          default: false
        udpSocketRxBufSize:
          type: number
          title: UDP socket buffer size (bytes)
          description: "Optionally, set the SO_RCVBUF socket option for the UDP socket.
            This value tells the operating system how many bytes can be buffered
            in the kernel before events are dropped. Leave blank to use the OS
            default. Caution: Increasing this value will affect OS memory
            utilization."
          minimum: 256
          maximum: 4294967295
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputJournalFiles:
      type: object
      required:
        - type
        - path
        - journals
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          enum:
            - journal_files
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        path:
          type: string
          title: Search path
          description: Directory path to search for journals. Environment variables will
            be resolved, e.g. $CRIBL_EDGE_FS_ROOT/var/log/journal/$MACHINE_ID.
        interval:
          type: number
          default: 10
          minimum: 1
          title: Polling interval
          description: "Time, in seconds, between scanning for journals. "
        journals:
          type: array
          title: Journal allowlist
          description: The full path of discovered journals are matched against this
            wildcard list.
          default:
            - system
          items:
            type: string
        rules:
          type: array
          title: Filter Rules
          description: Add rules to decide which journal objects to allow. Events are
            generated if no rules are given or if all the rules' expressions
            evaluate to true.
          items:
            type: object
            required:
              - filter
            properties:
              filter:
                type: string
                title: Filter Expression
                description: JavaScript expression applied to Journal objects. Return 'true' to
                  include it.
              description:
                type: string
                title: Description
                description: Optional description of this rule's purpose
          default:
            - filter: severity <= 4
              description: Allow log messages having 'emergency', 'alert', 'critical',
                'error', or 'warning' priority
        currentBoot:
          type: boolean
          default: false
          title: Current boot only
          description: Skip log messages that are not part of the current boot session.
        maxAgeDur:
          type: string
          title: Age duration limit
          description: "The maximum log message age, in duration form (e.g,: 60s, 4h, 3d,
            1w).  Default of no value will apply no max age filters."
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputWiz:
      type: object
      required:
        - type
        - endpoint
        - authUrl
        - clientId
        - contentConfig
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - wiz
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        endpoint:
          type: string
          title: GraphQL endpoint
          description: "The Wiz GraphQL API endpoint. Example:
            https://api.us1.app.wiz.io/graphql"
          default: https://api.<region>.app.wiz.io/graphql
          pattern: ^https:\/\/
        authUrl:
          type: string
          title: Authentication URL
          description: The authentication URL to generate an OAuth token
        authAudienceOverride:
          type: string
          title: Authentication audience
          description: The audience to use when requesting an OAuth token for a custom
            auth URL. When not specified, `wiz-api` will be used.
        clientId:
          type: string
          title: Client ID
          description: The client ID of the Wiz application
        contentConfig:
          type: array
          title: Content types
          default:
            - contentType: Audit Logs
              contentDescription: Get all Audit Logs
              contentQuery: >-
                ({
                  query: `query AuditLogTable($first: Int $after: String $filterBy: AuditLogEntryFilters){
                    auditLogEntries(first: $first after: $after filterBy: $filterBy) {
                      nodes {
                        id
                        action
                        requestId
                        status
                        timestamp
                        actionParameters
                        userAgent
                        sourceIP
                        serviceAccount {
                          id
                          name
                        }
                        user {
                          id
                          name
                        }
                      }
                      pageInfo {
                        hasNextPage
                        endCursor
                      }
                    }
                  }`,
                  variables: {
                    first: 100,
                    after: endCursor,
                    filterBy: {
                      timestamp: {
                        after: `${C.Time.strftime(state.latestTime || earliest, '%Y-%m-%dT%H:%M:%SZ')}`,
                        before: `${C.Time.strftime(latest, '%Y-%m-%dT%H:%M:%SZ')}`
                      },
                      status: ["SUCCESS", "FAILED","INVALID","ACCESS_DENIED"]
                    }
                  }
                })
              cronSchedule: "*/15 * * * *"
              earliest: -15m@m
              latest: now
              jobTimeout: "0"
              logLevel: info
              maxPages: 100
              enabled: false
              stateTracking: false
              stateUpdateExpression: "__timestampExtracted !== false && {latestTime:
                (state.latestTime || 0) > _time ? state.latestTime : _time}"
              stateMergeExpression: "prevState.latestTime > newState.latestTime ? prevState :
                newState"
            - contentType: Configuration Findings
              contentDescription: Get Cloud Configuration Report
              contentQuery: >-
                ({
                  query: `query CloudConfigurationFindingsPage($filterBy: ConfigurationFindingFilters, $first: Int, $after: String, $orderBy: ConfigurationFindingOrder) {
                    configurationFindings(filterBy: $filterBy first: $first after: $after orderBy: $orderBy) {
                      nodes {
                        id
                        targetExternalId
                        targetObjectProviderUniqueId
                        firstSeenAt
                        severity
                        result
                        status
                        remediation
                        resource {
                          id
                          providerId
                          name
                          nativeType
                          type
                          region
                          subscription {
                            id
                            name
                            externalId
                            cloudProvider
                          }
                          projects {
                            id
                            name
                            riskProfile {
                              businessImpact
                            }
                          }
                          tags {
                            key
                            value
                          }
                        }
                        rule {
                          id
                          graphId
                          name
                          description
                          remediationInstructions
                          functionAsControl
                        }
                        securitySubCategories {
                          id
                          title
                          category {
                            id
                            name
                            framework {
                              id
                              name
                            }
                          }
                        }
                        ignoreRules {
                          id
                          name
                          enabled
                          expiredAt
                        }
                      }
                      pageInfo {
                        hasNextPage
                        endCursor
                      }
                    }
                  }`,
                  variables: {
                    first: 100,
                    after: endCursor,
                    filterBy: {
                      id: [],
                      source: [],
                      rule: {
                        id: [],
                        name: [],
                        description: []
                      },
                      result: ["PASS","FAIL","ERROR", "NOT_ASSESSED"],
                      severity: ["NONE","LOW","MEDIUM","HIGH","CRITICAL"],
                      status: ["OPEN","IN_PROGRESS","RESOLVED","REJECTED"
                      ],
                      frameworkCategory: [],
                      firstSeenAt: {
                        after: `${C.Time.strftime(state.latestTime || earliest, '%Y-%m-%dT%H:%M:%SZ')}`,
                        before: `${C.Time.strftime(latest, '%Y-%m-%dT%H:%M:%SZ')}`
                      }
                    }
                  }
                })
              cronSchedule: 0 */12 * * *
              earliest: -12h@h
              latest: now
              jobTimeout: "0"
              logLevel: info
              maxPages: 100
              enabled: false
              stateTracking: false
              stateUpdateExpression: "__timestampExtracted !== false && {latestTime:
                (state.latestTime || 0) > _time ? state.latestTime : _time}"
              stateMergeExpression: "prevState.latestTime > newState.latestTime ? prevState :
                newState"
            - contentType: Issues
              contentDescription: Get Open Issues
              contentQuery: >-
                ({
                  query: `query IssuesTable($filterBy: IssueFilters, $first: Int, $after: String, $orderBy: IssueOrder) {
                    issues: issuesV2(filterBy: $filterBy first: $first after: $after orderBy: $orderBy) {
                      nodes {
                        id
                        control {
                          id
                          name
                          description
                          resolutionRecommendation
                          securitySubCategories {
                            title
                            category {
                              name
                              framework {
                                name
                              }
                            }
                          }
                        }
                        createdAt
                        updatedAt
                        sourceRule {
                          id
                          name
                        }
                        dueAt
                        resolvedAt
                        statusChangedAt
                        project {
                          id
                          name
                          slug
                          businessUnit
                          riskProfile {
                            businessImpact
                          }
                        }
                        status
                        severity
                        type
                        entitySnapshot {
                          id
                          type
                          nativeType
                          name
                          status
                          cloudPlatform
                          cloudProviderURL
                          providerId
                          region
                          resourceGroupExternalId
                          subscriptionExternalId
                          subscriptionName
                          subscriptionTags
                          tags
                          externalId
                        }
                        notes {
                          createdAt
                          updatedAt
                          text
                          user {
                            name
                            email
                          }
                          serviceAccount {
                            name
                          }
                        }
                        serviceTickets {
                          externalId
                          name
                          url
                        }
                      }
                      pageInfo {
                        hasNextPage
                        endCursor
                      }
                    }
                  }`,
                  variables: {
                    first: 100,
                    after: endCursor,
                    filterBy: {
                      sourceRule: {
                        id: []
                      },
                      relatedEntity: {
                        type: []
                      },
                      status: ["OPEN","IN_PROGRESS","RESOLVED","REJECTED"],
                      severity: ["INFORMATIONAL","LOW","MEDIUM","HIGH","CRITICAL"],
                      type: ["TOXIC_COMBINATION","THREAT_DETECTION","CLOUD_CONFIGURATION"],
                      createdAt: {
                        after: `${C.Time.strftime(state.latestTime || earliest, '%Y-%m-%dT%H:%M:%SZ')}`,
                        before: `${C.Time.strftime(latest, '%Y-%m-%dT%H:%M:%SZ')}`
                      }
                    }
                  }
                })
              cronSchedule: 0 */12 * * *
              earliest: -12h@h
              latest: now
              jobTimeout: "0"
              logLevel: info
              maxPages: 0
              enabled: false
              stateTracking: false
              stateUpdateExpression: "__timestampExtracted !== false && {latestTime:
                (state.latestTime || 0) > _time ? state.latestTime : _time}"
              stateMergeExpression: "prevState.latestTime > newState.latestTime ? prevState :
                newState"
            - contentType: Vulnerabilities
              contentDescription: Get Vulnerability Findings
              contentQuery: >-
                ({
                  query: `query VulnerabilityFindingsPage($filterBy: VulnerabilityFindingFilters, $first: Int, $after: String, $orderBy: VulnerabilityFindingOrder) {
                    vulnerabilityFindings(filterBy: $filterBy first: $first after: $after orderBy: $orderBy) {
                      nodes {
                        id
                        portalUrl
                        name
                        CVEDescription
                        CVSSSeverity
                        score
                        exploitabilityScore
                        impactScore
                        hasExploit
                        hasCisaKevExploit
                        status
                        vendorSeverity
                        firstDetectedAt
                        lastDetectedAt
                        resolvedAt
                        description
                        remediation
                        detailedName
                        version
                        fixedVersion
                        detectionMethod
                        link
                        locationPath
                        resolutionReason
                        vulnerableAsset {
                          ... on VulnerableAssetBase {
                            id
                            type
                            name
                            region
                            providerUniqueId
                            cloudProviderURL
                            cloudPlatform
                            status
                            subscriptionName
                            subscriptionExternalId
                            subscriptionId
                            tags
                          }
                          ... on VulnerableAssetVirtualMachine {
                            operatingSystem
                            ipAddresses
                          }
                          ... on VulnerableAssetServerless {
                            runtime
                          }
                          ... on VulnerableAssetContainerImage {
                            imageId
                          }
                          ... on VulnerableAssetContainer {
                            ImageExternalId
                            VmExternalId
                            ServerlessContainer
                            PodNamespace
                            PodName
                            NodeName
                          }
                        }
                      }
                      pageInfo {
                        hasNextPage
                        endCursor
                      }
                    }
                  }`,
                  variables: {
                    first: 100,
                    after: endCursor,
                    filterBy: {
                      id: [],
                      status: [],
                      assetType: [],
                      vendorSeverity: [],
                      assetId: [],
                      vulnerabilityId: [],
                      detectionMethod: [],
                      assetStatus: [],
                      firstSeenAt: {
                        after: `${C.Time.strftime(state.latestTime || earliest, '%Y-%m-%dT%H:%M:%SZ')}`,
                        before: `${C.Time.strftime(latest, '%Y-%m-%dT%H:%M:%SZ')}`
                      }
                    }
                  }
                })
              cronSchedule: 0 */12 * * *
              earliest: -12h@h
              latest: now
              jobTimeout: "0"
              logLevel: info
              maxPages: 0
              enabled: false
              stateTracking: false
              stateUpdateExpression: "__timestampExtracted !== false && {latestTime:
                (state.latestTime || 0) > _time ? state.latestTime : _time}"
              stateMergeExpression: "prevState.latestTime > newState.latestTime ? prevState :
                newState"
          items:
            type: object
            required:
              - contentType
              - contentQuery
              - cronSchedule
              - earliest
              - latest
            properties:
              contentType:
                type: string
                title: Content name
                description: The name of the Wiz query
                pattern: ^[a-zA-Z0-9_-\s]+$
              contentDescription:
                type: string
                title: Description
              enabled:
                type: boolean
                title: Enable content
                default: false
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: HTTP request inactivity timeout. Use 0 to disable.
          minimum: 0
          maximum: 2400
          default: 300
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often workers should check in with the scheduler to keep job
            subscription alive
          minimum: 10
          default: 30
        maxMissedKeepAlives:
          type: number
          title: Worker timeout (periods)
          description: The number of Keep Alive Time periods before an inactive worker
            will have its job subscription revoked.
          minimum: 2
          default: 3
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        retryRules:
          type: object
          required:
            - type
          properties:
            type:
              type: string
              title: Retry type
              description: The algorithm to use when performing HTTP retries
              enum:
                - none
                - backoff
                - static
              x-speakeasy-enum-descriptions:
                - Disabled
                - Backoff
                - Static
              default: backoff
              x-speakeasy-unknown-values: allow
            interval:
              type: number
              title: Initial retry interval (ms)
              description: Time interval between failed request and first retry (kickoff).
                Maximum allowed value is 20,000 ms (1/3 minute).
              minimum: 0
              maximum: 20000
              default: 1000
            limit:
              type: number
              title: Retry limit
              description: The maximum number of times to retry a failed HTTP request
              minimum: 0
              maximum: 20
              default: 5
            multiplier:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff, e.g., base 2 means that retries will
                occur after 2, then 4, then 8 seconds, and so on
              minimum: 1
              maximum: 20
              default: 2
            codes:
              type: array
              title: Retry HTTP codes
              description: List of HTTP codes that trigger a retry. Leave empty to use the
                default list of 429 and 503.
              minItems: 1
              default:
                - 429
                - 503
              items:
                type: number
                minLength: 1
            enableHeader:
              type: boolean
              title: Honor Retry-After header
              description: Honor any Retry-After header that specifies a delay (in seconds) or
                a timestamp after which to retry the request. The delay is
                limited to 20 seconds, even if the Retry-After header specifies
                a longer delay. When disabled, all Retry-After headers are
                ignored.
              default: true
            retryConnectTimeout:
              type: boolean
              title: Retry connection timeout
              description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
                error occurs
              default: false
            retryConnectReset:
              type: boolean
              title: Retry connection reset
              description: Retry request when a connection reset (ECONNRESET) error occurs
              default: false
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter client secret directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        clientSecret:
          type: string
          title: Client secret
          description: The client secret of the Wiz application
        textSecret:
          type: string
          title: Client Secret (text secret)
          description: Select or create a stored text secret
    InputWizWebhook:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - wiz_webhook
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: string
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck:
          type: boolean
          title: Health check endpoint
          description: Expose the /cribl_health endpoint, which returns 200 OK when this
            Source is healthy
          default: false
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          default:
            - Cribl - Do Not Break Ruleset
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        allowedPaths:
          type: array
          title: Allowed URI paths
          description: List of URI paths accepted by this input. Wildcards are supported
            (such as /api/v*/hook). Defaults to allow all.
          default:
            - "*"
          items:
            type: string
            minLength: 1
        allowedMethods:
          type: array
          title: Allowed HTTP methods
          description: List of HTTP methods accepted by this input. Wildcards are
            supported (such as P*, GET). Defaults to allow all.
          default:
            - "*"
          items:
            type: string
            minLength: 1
        authTokensExt:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: object
            required:
              - token
            properties:
              token:
                type: string
                title: Token
                description: "Shared secret to be provided by any client (Authorization:
                  <token>)"
              description:
                type: string
                title: Description
              metadata:
                type: array
                title: Fields
                description: Fields to add to events referencing this token
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputNetflow:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - netflow
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. For IPv4 (all addresses), use the default
            '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP
            address.
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
          default: 2055
        enablePassThrough:
          type: boolean
          title: Enable pass-through
          default: false
          description: Allow forwarding of events to a NetFlow destination. Enabling this
            feature will generate an extra event containing __netflowRaw which
            can be routed to a NetFlow destination. Note that these events will
            not count against ingest quota.
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist.
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        udpSocketRxBufSize:
          type: number
          title: UDP socket buffer size (bytes)
          description: "Optionally, set the SO_RCVBUF socket option for the UDP socket.
            This value tells the operating system how many bytes can be buffered
            in the kernel before events are dropped. Leave blank to use the OS
            default. Caution: Increasing this value will affect OS memory
            utilization."
          minimum: 256
          maximum: 4294967295
        templateCacheMinutes:
          type: number
          title: Template cache minutes
          description: Specifies how many minutes NetFlow v9 templates are cached before
            being discarded if not refreshed. Adjust based on your network's
            template update frequency to optimize performance and memory usage.
          minimum: 1
          maximum: 3600
          default: 30
        v5Enabled:
          type: boolean
          title: V5
          description: Accept messages in Netflow V5 format.
          default: true
        v9Enabled:
          type: boolean
          title: V9
          description: Accept messages in Netflow V9 format.
          default: true
        ipfixEnabled:
          type: boolean
          title: IPFIX
          description: Accept messages in IPFIX format.
          default: false
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        description:
          type: string
          title: Description
    InputSecurityLake:
      type: object
      required:
        - type
        - queueName
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - security_lake
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        queueName:
          type: string
          title: Queue
          description: "The name, URL, or ARN of the SQS queue to read notifications from.
            When a non-AWS URL is specified, format must be:
            '{url}/myQueueName'. Example: 'https://host:port/myQueueName'. Value
            must be a JavaScript expression (which can evaluate to a constant
            value), enclosed in quotes or backticks. Can be evaluated only at
            init time. Example referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`."
        fileFilter:
          type: string
          title: Filename filter
          description: "Regex matching file names to download and process. Defaults to: .*"
          default: /.*/
        awsAccountId:
          title: AWS account ID
          description: SQS queue owner's AWS account ID. Leave empty if SQS queue is in
            same AWS account.
          type: string
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: AWS Region where the S3 bucket and SQS queue are located. Required,
            unless the Queue entry is a URL or ARN that includes a Region.
        endpoint:
          type: string
          title: Endpoint
          description: S3 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to S3-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing S3 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        maxMessages:
          type: number
          title: Message limit
          description: "The maximum number of messages SQS should return in a poll
            request. Amazon SQS never returns more messages than this value
            (however, fewer messages might be returned). Valid values: 1 to 10."
          default: 1
          minimum: 1
          maximum: 10
        visibilityTimeout:
          type: number
          title: Visibility timeout seconds
          description: After messages are retrieved by a ReceiveMessage request,
            @{product} will hide them from subsequent retrieve requests for at
            least this duration. You can set this as high as 43200 sec. (12
            hours).
          default: 600
          minimum: 0
          maximum: 43200
        numReceivers:
          type: number
          title: Number of receivers
          description: How many receiver processes to run. The higher the number, the
            better the throughput - at the expense of CPU overhead.
          default: 1
          minimum: 1
          maximum: 100
        socketTimeout:
          type: number
          title: Socket timeout
          description: Socket inactivity timeout (in seconds). Increase this value if
            timeouts occur due to backpressure.
          default: 300
          minimum: 1
          maximum: 43200
        skipOnError:
          type: boolean
          title: Skip file on error
          description: Skip files that trigger a processing error. Disabled by default,
            which allows retries after processing errors.
          default: false
        includeSqsMetadata:
          type: boolean
          title: Include notification metadata
          description: Attach SQS notification metadata to a __sqsMetadata field on each
            event
          default: false
        enableAssumeRole:
          type: boolean
          title: Enable for Amazon S3
          description: Use Assume Role credentials to access Amazon S3
          default: true
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        enableSQSAssumeRole:
          type: boolean
          title: Enable for Amazon SQS
          description: Use Assume Role credentials when accessing Amazon SQS
          default: false
        preprocess:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            command:
              type: string
              title: Command
              description: Command to feed the data through (via stdin) and process its output
                (stdout)
            args:
              type: array
              title: Arguments
              description: Arguments to be added to the custom command
              items:
                type: string
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        parquetChunkSizeMB:
          type: number
          title: Parquet chunk size limit (MB)
          description: Maximum file size for each Parquet chunk
          default: 5
          maximum: 100
          minimum: 1
        parquetChunkDownloadTimeout:
          type: number
          title: Parquet chunk download timeout (seconds)
          description: The maximum time allowed for downloading a Parquet chunk.
            Processing will stop if a chunk cannot be downloaded within the time
            specified.
          default: 600
          maximum: 3600
          minimum: 1
        checkpointing:
          type: object
          required:
            - enabled
          properties:
            enabled:
              type: boolean
              title: Enable checkpointing
              description: Resume processing files after an interruption
              default: false
            retries:
              type: number
              title: Retries
              description: The number of times to retry processing when a processing error
                occurs. If Skip file on error is enabled, this setting is
                ignored.
              default: 5
              maximum: 100
              minimum: 0
        pollTimeout:
          type: number
          title: Poll timeout (secs)
          description: How long to wait for events before trying polling again. The lower
            the number the higher the AWS bill. The higher the number the longer
            it will take for the source to react to configuration changes and
            system restarts.
          default: 10
          minimum: 1
          maximum: 20
        encoding:
          type: string
          title: Encoding
          description: Character encoding to use when parsing ingested data. When not set,
            @{product} will default to UTF-8 but may incorrectly interpret
            multi-byte characters.
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        tagAfterProcessing:
          enum:
            - false
            - true
          x-speakeasy-unknown-values: allow
        processedTagKey:
          type: string
          title: Tag key
          description: The key for the S3 object tag applied after processing. This field
            accepts an expression for dynamic generation.
        processedTagValue:
          type: string
          title: Tag value
          description: The value for the S3 object tag applied after processing. This
            field accepts an expression for dynamic generation.
    InputZscalerHec:
      type: object
      required:
        - type
        - host
        - port
        - hecAPI
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - zscaler_hec
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: object
            required:
              - token
            properties:
              authType:
                title: Authentication method
                type: string
                enum:
                  - manual
                  - secret
                default: manual
                description: Select Manual to enter an auth token directly, or select Secret to
                  use a text secret to authenticate
                x-speakeasy-unknown-values: allow
              tokenSecret: {}
              token: {}
              enabled:
                type: boolean
                title: Enable token
                default: true
              description:
                type: string
                title: Description
              allowedIndexesAtToken:
                type: array
                title: Allowed indexes
                description: Enter the values you want to allow in the HEC event index field at
                  the token level. Supports wildcards. To skip validation, leave
                  blank.
                minItems: 0
                items:
                  type: string
                  minLength: 1
              metadata:
                type: array
                title: Fields
                description: Fields to add to events referencing this token
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck: {}
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        hecAPI:
          type: string
          title: HEC endpoint
          description: Absolute path on which to listen for the Zscaler HTTP Event
            Collector API requests. This input supports the /event endpoint.
          default: /services/collector
          pattern: ^/
        metadata:
          type: array
          title: Fields
          description: Fields to add to every event. May be overridden by fields added at
            the token or request level.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        allowedIndexes:
          type: array
          title: Allowed indexes
          description: List values allowed in HEC event index field. Leave blank to skip
            validation. Supports wildcards. The values here can expand index
            validation at the token level.
          minItems: 0
          items:
            type: string
            minLength: 1
        hecAcks:
          type: boolean
          title: Zscaler HEC Acks
          description: Whether to enable Zscaler HEC acknowledgements
          default: false
        accessControlAllowOrigin:
          title: CORS allowed origins
          type: array
          description: Optionally, list HTTP origins to which @{product} should send CORS
            (cross-origin resource sharing) Access-Control-Allow-* headers.
            Supports wildcards.
          minItems: 0
          items:
            type: string
            minLength: 1
        accessControlAllowHeaders:
          title: CORS allowed headers
          type: array
          description: Optionally, list HTTP headers that @{product} will send to allowed
            origins as "Access-Control-Allow-Headers" in a CORS preflight
            response. Use "*" to allow all headers.
          minItems: 0
          items:
            type: string
            minLength: 1
        emitTokenMetrics:
          type: boolean
          title: Emit per-token request metrics
          description: Enable to emit per-token (<prefix>.http.perToken) and summary
            (<prefix>.http.summary) request metrics
          default: false
        description:
          type: string
          title: Description
    InputCloudflareHec:
      type: object
      required:
        - type
        - host
        - port
        - hecAPI
      properties:
        id:
          type: string
          title: Input ID
          description: Unique ID for this input
        type:
          type: string
          enum:
            - cloudflare_hec
        disabled:
          type: boolean
          title: Disabled
          default: false
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data from this Source before sending it through
            the Routes
        sendToRoutes:
          type: boolean
          default: true
          description: Select whether to send data to Routes, or directly to Destinations.
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        pqEnabled:
          type: boolean
          default: false
          title: Enable persistent queue
          description: Use a disk queue to minimize data loss when connected services
            block. See [Cribl
            Docs](https://docs.cribl.io/stream/persistent-queues) for PQ
            defaults (Cribl-managed Cloud Workers) and configuration options
            (on-prem and hybrid Workers).
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        connections:
          type: array
          title: Use QuickConnect
          description: Direct connections to Destinations, and optionally via a Pipeline
            or a Pack
          items:
            type: object
            required:
              - output
            properties:
              pipeline:
                title: Pipeline or Pack
                type: string
              output:
                title: Destination
                type: string
        pq:
          type: object
          properties:
            mode:
              type: string
              title: Mode
              description: With Smart mode, PQ will write events to the filesystem only when
                it detects backpressure from the processing engine.
                With Always On mode, PQ will always write events directly to the
                queue before forwarding them to the processing engine.
              default: always
              enum:
                - smart
                - always
              x-speakeasy-enum-descriptions:
                - Smart
                - Always On
              x-speakeasy-unknown-values: allow
            maxBufferSize:
              type: number
              title: Buffer size limit
              description: The maximum number of events to hold in memory before writing the
                events to disk
              default: 1000
              minimum: 42
            commitFrequency:
              type: number
              title: Commit frequency
              description: The number of events to send downstream before committing that
                Stream has read them
              default: 42
              minimum: 1
            maxFileSize:
              type: string
              title: File size limit
              description: The maximum size to store in each queue file before closing and
                optionally compressing. Enter a numeral with units of KB, MB,
                etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 1 MB
            maxSize:
              type: string
              title: Queue size limit
              description: The maximum disk space that the queue can consume (as an average
                per Worker Process) before queueing stops. Enter a numeral with
                units of KB, MB, etc.
              pattern: ^\d+\s*(?:\w{2})?$
              default: 5GB
            path:
              type: string
              default: $CRIBL_HOME/state/queues
              title: Queue file path
              description: "The location for the persistent queue files. To this field's
                value, the system will append: /<worker-id>/inputs/<input-id>"
            compress:
              type: string
              default: none
              enum:
                - none
                - gzip
              x-speakeasy-enum-descriptions:
                - None
                - Gzip
              title: Compression
              description: Codec to use to compress the persisted data
              x-speakeasy-unknown-values: allow
            pqControls:
              type: object
              title: ""
        host:
          type: string
          title: Address
          description: Address to bind on. Defaults to 0.0.0.0 (all addresses).
          default: 0.0.0.0
        port:
          type: number
          title: Port
          maximum: 65535
          description: Port to listen on
        authTokens:
          type: array
          title: Auth tokens
          description: "Shared secrets to be provided by any client (Authorization:
            <token>). If empty, unauthorized access is permitted."
          items:
            type: object
            required: []
            properties:
              authType:
                title: Authentication method
                type: string
                enum:
                  - secret
                default: secret
                description: Select Secret to use a text secret to authenticate
                x-speakeasy-unknown-values: allow
              tokenSecret: {}
              token: {}
              enabled:
                type: boolean
                title: Enable token
                default: true
              description:
                type: string
                title: Description
              allowedIndexesAtToken:
                type: array
                title: Allowed indexes
                description: Enter the values you want to allow in the HEC event index field at
                  the token level. Supports wildcards. To skip validation, leave
                  blank.
                minItems: 0
                items:
                  type: string
                  minLength: 1
              metadata:
                type: array
                title: Fields
                description: Fields to add to events referencing this token
                items:
                  type: object
                  required:
                    - name
                    - value
                  properties:
                    name:
                      type: string
                      title: Field Name
                    value:
                      type: string
                      title: Value
                      description: JavaScript expression to compute field's value, enclosed in quotes
                        or backticks. (Can evaluate to a constant.)
        tls:
          type: object
          title: TLS settings (server side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            requestCert:
              type: boolean
              title: Authenticate client (mutual auth)
              description: Require clients to present their certificates. Used to perform
                client authentication using SSL certs.
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate client certificates
              description: Reject certificates not authorized by a CA in the CA certificate
                path or by another trusted CA (such as the system's)
              default: true
            commonNameRegex:
              type: string
              title: Common name
              description: Regex matching allowable common names in peer certificates' subject
                attribute
              default: /.*/
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            privKeyPath:
              type: string
              title: Private key path
              description: Path on server containing the private key to use. PEM format. Can
                reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            certPath:
              type: string
              title: Certificate path
              description: Path on server containing certificates to use. PEM format. Can
                reference $ENV_VARS.
            caPath:
              type: string
              title: CA certificate path
              description: Path on server containing CA certificates to use. PEM format. Can
                reference $ENV_VARS.
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        maxActiveReq:
          type: number
          title: Active request limit
          description: "Maximum number of active requests allowed per Worker Process. Set
            to 0 for unlimited. Caution: Increasing the limit above the default
            value, or setting it to unlimited, may degrade performance and
            reduce throughput."
          default: 256
          minimum: 0
        maxRequestsPerSocket:
          type: integer
          title: Requests-per-socket limit
          description: Maximum number of requests per socket before @{product} instructs
            the client to close the connection. Default is 0 (unlimited).
          default: 0
          minimum: 0
        enableProxyHeader:
          type: boolean
          title: Show originating IP
          description: Extract the client IP and port from PROXY protocol v1/v2. When
            enabled, the X-Forwarded-For header is ignored. Disable to use the
            X-Forwarded-For header for client IP extraction.
          default: false
        captureHeaders:
          type: boolean
          title: Capture request headers
          description: Add request headers to events, in the __headers field
          default: false
        activityLogSampleRate:
          type: number
          title: Activity log sample rate
          description: How often request activity is logged at the `info` level. A value
            of 1 would log every request, 10 every 10th request, etc.
          default: 100
          minimum: 1
        requestTimeout:
          type: number
          title: Request timeout (seconds)
          description: How long to wait for an incoming request to complete before
            aborting it. Use 0 to disable.
          default: 0
          minimum: 0
        socketTimeout:
          type: number
          title: Socket timeout (seconds)
          description: How long @{product} should wait before assuming that an inactive
            socket has timed out. To wait forever, set to 0.
          default: 0
          minimum: 0
        keepAliveTimeout:
          type: number
          title: Keep-alive timeout (seconds)
          description: After the last response is sent, @{product} will wait this long for
            additional data before closing the socket connection. Minimum 1
            second, maximum 600 seconds (10 minutes).
          default: 5
          minimum: 1
          maximum: 600
        enableHealthCheck: {}
        ipAllowlistRegex:
          type: string
          title: IP allowlist regex
          description: Messages from matched IP addresses will be processed, unless also
            matched by the denylist
          default: /.*/
        ipDenylistRegex:
          type: string
          title: IP denylist regex
          description: Messages from matched IP addresses will be ignored. This takes
            precedence over the allowlist.
          default: /^$/
        hecAPI:
          type: string
          title: HEC endpoint
          description: Absolute path on which to listen for the Cloudflare HTTP Event
            Collector API requests. This input supports the /event endpoint.
          pattern: ^/
        metadata:
          type: array
          title: Fields
          description: Fields to add to every event. May be overridden by fields added at
            the token or request level.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        allowedIndexes:
          type: array
          title: Allowed indexes
          description: List values allowed in HEC event index field. Leave blank to skip
            validation. Supports wildcards. The values here can expand index
            validation at the token level.
          minItems: 0
          items:
            type: string
            minLength: 1
        breakerRulesets:
          type: array
          title: Event Breaker rulesets
          description: A list of event-breaking rulesets that will be applied, in order,
            to the input data stream
          items:
            type: string
        staleChannelFlushMs:
          type: number
          title: Event Breaker buffer timeout (ms)
          description: How long (in milliseconds) the Event Breaker will wait for new data
            to be sent to a specific channel before flushing the data stream
            out, as is, to the Pipelines
          default: 10000
          minimum: 10
          maximum: 43200000
        accessControlAllowOrigin:
          title: CORS allowed origins
          type: array
          description: HTTP origins to which @{product} should send CORS (cross-origin
            resource sharing) Access-Control-Allow-* headers. Supports
            wildcards.
          minItems: 0
          items:
            type: string
            minLength: 1
        accessControlAllowHeaders:
          title: CORS allowed headers
          type: array
          description: HTTP headers that @{product} will send to allowed origins as
            "Access-Control-Allow-Headers" in a CORS preflight response. Use "*"
            to allow all headers.
          minItems: 0
          items:
            type: string
            minLength: 1
        emitTokenMetrics:
          type: boolean
          title: Emit per-token request metrics
          description: Emit per-token (<prefix>.http.perToken) and summary
            (<prefix>.http.summary) request metrics
          default: false
        description:
          type: string
          title: Description
    Input:
      oneOf:
        - $ref: "#/components/schemas/InputCollection"
        - $ref: "#/components/schemas/InputKafka"
        - $ref: "#/components/schemas/InputMsk"
        - $ref: "#/components/schemas/InputHttp"
        - $ref: "#/components/schemas/InputSplunk"
        - $ref: "#/components/schemas/InputSplunkSearch"
        - $ref: "#/components/schemas/InputSplunkHec"
        - $ref: "#/components/schemas/InputAzureBlob"
        - $ref: "#/components/schemas/InputElastic"
        - $ref: "#/components/schemas/InputConfluentCloud"
        - $ref: "#/components/schemas/InputGrafana"
        - $ref: "#/components/schemas/InputLoki"
        - $ref: "#/components/schemas/InputPrometheusRw"
        - $ref: "#/components/schemas/InputPrometheus"
        - $ref: "#/components/schemas/InputEdgePrometheus"
        - $ref: "#/components/schemas/InputOffice365Mgmt"
        - $ref: "#/components/schemas/InputOffice365Service"
        - $ref: "#/components/schemas/InputOffice365MsgTrace"
        - $ref: "#/components/schemas/InputEventhub"
        - $ref: "#/components/schemas/InputExec"
        - $ref: "#/components/schemas/InputFirehose"
        - $ref: "#/components/schemas/InputGooglePubsub"
        - $ref: "#/components/schemas/InputCribl"
        - $ref: "#/components/schemas/InputCriblTcp"
        - $ref: "#/components/schemas/InputCriblHttp"
        - $ref: "#/components/schemas/InputCriblLakeHttp"
        - $ref: "#/components/schemas/InputTcpjson"
        - $ref: "#/components/schemas/InputSystemMetrics"
        - $ref: "#/components/schemas/InputSystemState"
        - $ref: "#/components/schemas/InputKubeMetrics"
        - $ref: "#/components/schemas/InputKubeLogs"
        - $ref: "#/components/schemas/InputKubeEvents"
        - $ref: "#/components/schemas/InputWindowsMetrics"
        - $ref: "#/components/schemas/InputCrowdstrike"
        - $ref: "#/components/schemas/InputDatadogAgent"
        - $ref: "#/components/schemas/InputDatagen"
        - $ref: "#/components/schemas/InputHttpRaw"
        - $ref: "#/components/schemas/InputKinesis"
        - $ref: "#/components/schemas/InputCriblmetrics"
        - $ref: "#/components/schemas/InputMetrics"
        - $ref: "#/components/schemas/InputS3"
        - $ref: "#/components/schemas/InputS3Inventory"
        - $ref: "#/components/schemas/InputSnmp"
        - $ref: "#/components/schemas/InputOpenTelemetry"
        - $ref: "#/components/schemas/InputModelDrivenTelemetry"
        - $ref: "#/components/schemas/InputSqs"
        - $ref: "#/components/schemas/InputSyslog"
        - $ref: "#/components/schemas/InputFile"
        - $ref: "#/components/schemas/InputTcp"
        - $ref: "#/components/schemas/InputAppscope"
        - $ref: "#/components/schemas/InputWef"
        - $ref: "#/components/schemas/InputWinEventLogs"
        - $ref: "#/components/schemas/InputRawUdp"
        - $ref: "#/components/schemas/InputJournalFiles"
        - $ref: "#/components/schemas/InputWiz"
        - $ref: "#/components/schemas/InputWizWebhook"
        - $ref: "#/components/schemas/InputNetflow"
        - $ref: "#/components/schemas/InputSecurityLake"
        - $ref: "#/components/schemas/InputZscalerHec"
        - $ref: "#/components/schemas/InputCloudflareHec"
      discriminator:
        propertyName: type
        mapping:
          collection: "#/components/schemas/InputCollection"
          kafka: "#/components/schemas/InputKafka"
          msk: "#/components/schemas/InputMsk"
          http: "#/components/schemas/InputHttp"
          splunk: "#/components/schemas/InputSplunk"
          splunk_search: "#/components/schemas/InputSplunkSearch"
          splunk_hec: "#/components/schemas/InputSplunkHec"
          azure_blob: "#/components/schemas/InputAzureBlob"
          elastic: "#/components/schemas/InputElastic"
          confluent_cloud: "#/components/schemas/InputConfluentCloud"
          grafana: "#/components/schemas/InputGrafana"
          loki: "#/components/schemas/InputLoki"
          prometheus_rw: "#/components/schemas/InputPrometheusRw"
          prometheus: "#/components/schemas/InputPrometheus"
          edge_prometheus: "#/components/schemas/InputEdgePrometheus"
          office365_mgmt: "#/components/schemas/InputOffice365Mgmt"
          office365_service: "#/components/schemas/InputOffice365Service"
          office365_msg_trace: "#/components/schemas/InputOffice365MsgTrace"
          eventhub: "#/components/schemas/InputEventhub"
          exec: "#/components/schemas/InputExec"
          firehose: "#/components/schemas/InputFirehose"
          google_pubsub: "#/components/schemas/InputGooglePubsub"
          cribl: "#/components/schemas/InputCribl"
          cribl_tcp: "#/components/schemas/InputCriblTcp"
          cribl_http: "#/components/schemas/InputCriblHttp"
          cribl_lake_http: "#/components/schemas/InputCriblLakeHttp"
          tcpjson: "#/components/schemas/InputTcpjson"
          system_metrics: "#/components/schemas/InputSystemMetrics"
          system_state: "#/components/schemas/InputSystemState"
          kube_metrics: "#/components/schemas/InputKubeMetrics"
          kube_logs: "#/components/schemas/InputKubeLogs"
          kube_events: "#/components/schemas/InputKubeEvents"
          windows_metrics: "#/components/schemas/InputWindowsMetrics"
          crowdstrike: "#/components/schemas/InputCrowdstrike"
          datadog_agent: "#/components/schemas/InputDatadogAgent"
          datagen: "#/components/schemas/InputDatagen"
          http_raw: "#/components/schemas/InputHttpRaw"
          kinesis: "#/components/schemas/InputKinesis"
          criblmetrics: "#/components/schemas/InputCriblmetrics"
          metrics: "#/components/schemas/InputMetrics"
          s3: "#/components/schemas/InputS3"
          s3_inventory: "#/components/schemas/InputS3Inventory"
          snmp: "#/components/schemas/InputSnmp"
          open_telemetry: "#/components/schemas/InputOpenTelemetry"
          model_driven_telemetry: "#/components/schemas/InputModelDrivenTelemetry"
          sqs: "#/components/schemas/InputSqs"
          syslog: "#/components/schemas/InputSyslog"
          file: "#/components/schemas/InputFile"
          tcp: "#/components/schemas/InputTcp"
          appscope: "#/components/schemas/InputAppscope"
          wef: "#/components/schemas/InputWef"
          win_event_logs: "#/components/schemas/InputWinEventLogs"
          raw_udp: "#/components/schemas/InputRawUdp"
          journal_files: "#/components/schemas/InputJournalFiles"
          wiz: "#/components/schemas/InputWiz"
          wiz_webhook: "#/components/schemas/InputWizWebhook"
          netflow: "#/components/schemas/InputNetflow"
          security_lake: "#/components/schemas/InputSecurityLake"
          zscaler_hec: "#/components/schemas/InputZscalerHec"
          cloudflare_hec: "#/components/schemas/InputCloudflareHec"
    AddHecTokenRequest:
      type: object
      properties:
        allowedIndexesAtToken:
          type: array
          items:
            type: string
        description:
          type: string
        enabled:
          type: boolean
        metadata:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
            required:
              - name
              - value
        token:
          type: string
      required:
        - token
    UpdateHecTokenRequest:
      type: object
      properties:
        allowedIndexesAtToken:
          type: array
          items:
            type: string
        description:
          type: string
        enabled:
          type: boolean
        metadata:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
            required:
              - name
              - value
    IoMetricsEntryLevel:
      type: string
      enum:
        - minimal
        - basic
        - detailed
        - comprehensive
      x-speakeasy-unknown-values: allow
    IoMetricsEntry:
      type: object
      properties:
        canDelete:
          type: boolean
        id:
          type: string
        level:
          $ref: "#/components/schemas/IoMetricsEntryLevel"
      required:
        - id
        - level
    OutputDefault:
      type: object
      required:
        - type
        - defaultId
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - default
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        defaultId:
          type: string
          title: Default Output ID
          description: ID of the default output. This will be used whenever a
            nonexistent/deleted output is referenced.
    OutputWebhook:
      type: object
      required:
        - type
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - webhook
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        method:
          type: string
          title: Method
          description: The method to use when sending events
          enum:
            - POST
            - PUT
            - PATCH
          default: POST
          x-speakeasy-unknown-values: allow
        format:
          type: string
          title: Format
          description: How to format events before sending out
          enum:
            - ndjson
            - json_array
            - custom
            - advanced
          x-speakeasy-enum-descriptions:
            - NDJSON (Newline Delimited JSON)
            - JSON Array
            - Custom
            - Advanced
          default: ndjson
          x-speakeasy-unknown-values: allow
        keepAlive:
          type: boolean
          title: Keep alive
          description: Disable to close the connection immediately after sending the
            outgoing request
          default: true
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 512000
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events. You can also add headers dynamically
            on a per-event basis in the __headers field, as explained in [Cribl
            Docs](https://docs.cribl.io/stream/destinations-webhook/#internal-fields).
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          type: string
          title: Authentication type
          description: Authentication method to use for the HTTP request
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          x-speakeasy-enum-descriptions:
            - None
            - Basic
            - Basic (credentials secret)
            - Token
            - Token (text secret)
            - OAuth
          default: none
          x-speakeasy-unknown-values: allow
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        loadBalanced:
          type: boolean
          title: Load balancing
          description: Enable for optimal performance. Even if you have one hostname, it
            can expand to multiple IPs. If disabled, consider enabling
            round-robin DNS.
          default: false
        description:
          type: string
          title: Description
        customSourceExpression:
          type: string
          title: Source expression
          description: "Expression to evaluate on events to generate output. Example:
            `raw=${_raw}`. See [Cribl
            Docs](https://docs.cribl.io/stream/destinations-webhook#custom-form\
            at) for other examples. If empty, the full event is sent as
            stringified JSON."
          default: __httpOut
        customDropWhenNull:
          type: boolean
          title: Drop when null
          description: Whether to drop events when the source expression evaluates to null
          default: false
        customEventDelimiter:
          type: string
          title: Event delimiter
          description: Delimiter string to insert between individual events. Defaults to
            newline character.
          default: \n
        customContentType:
          type: string
          title: Content type
          description: Content type to use for request. Defaults to application/x-ndjson.
            Any content types set in Advanced Settings > Extra HTTP headers will
            override this entry.
          default: application/x-ndjson
        customPayloadExpression:
          type: string
          title: Batch expression
          description: 'Expression specifying how to format the payload for each batch. To
            reference the events to send, use the `${events}` variable. Example
            expression: `{ "items" : [${events}] }` would send the batch inside
            a JSON object.'
          default: "`${events}`"
        advancedContentType:
          type: string
          title: Content type
          description: HTTP content-type header value
          default: application/json
        formatEventCode:
          type: string
          title: Format inbound event
          description: "Custom JavaScript code to format incoming event data accessible
            through the __e variable. The formatted content is added to
            (__e['__eventOut']) if available. Otherwise, the original event is
            serialized as JSON. Caution: This function is evaluated in an
            unprotected context, allowing you to execute almost any JavaScript
            code."
        formatPayloadCode:
          type: string
          title: Format outbound payload
          description: "Optional JavaScript code to format the payload sent to the
            Destination. The payload, containing a batch of formatted events, is
            accessible through the __e['payload'] variable. The formatted
            payload is returned in the __e['__payloadOut'] variable. Caution:
            This function is evaluated in an unprotected context, allowing you
            to execute almost any JavaScript code."
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
        url:
          type: string
          title: Webhook URL
          description: URL of a webhook endpoint to send events to, such as
            http://localhost:10200
          pattern: ^https?://.*
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        urls:
          type: array
          title: Webhook URLs
          description: ""
          minItems: 1
          items:
            type: object
            required:
              - url
            properties:
              url:
                type: string
                title: Webhook LB URL
                description: URL of a webhook endpoint to send events to, such as
                  http://localhost:10200
                pattern: ^https?://.*
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
    OutputSentinel:
      type: object
      required:
        - type
        - endpointURLConfiguration
        - loginUrl
        - secret
        - client_id
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - sentinel
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        keepAlive:
          type: boolean
          title: Keep alive
          description: Disable to close the connection immediately after sending the
            outgoing request
          default: true
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size (KB) of the request body (defaults to the API's
            maximum limit of 1000 KB)
          default: 1000
          minimum: 100
          maximum: 1000
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events. You can also add headers dynamically
            on a per-event basis in the __headers field, as explained in [Cribl
            Docs](https://docs.cribl.io/stream/destinations-webhook/#internal-fields).
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          enum:
            - oauth
          x-speakeasy-unknown-values: allow
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        client_id:
          title: Client ID
          type: string
          description: JavaScript expression to compute the Client ID for the Azure
            application. Can be a constant.
        scope:
          title: Scope
          type: string
          description: Scope to pass in the OAuth request
          default: https://monitor.azure.com/.default
        endpointURLConfiguration:
          title: Endpoint configuration
          description: Enter the data collection endpoint URL or the individual ID
          type: string
          enum:
            - url
            - ID
          x-speakeasy-enum-descriptions:
            - URL
            - ID
          default: url
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        format:
          enum:
            - ndjson
            - json_array
            - custom
            - advanced
          x-speakeasy-unknown-values: allow
        customSourceExpression:
          type: string
          title: Source expression
          description: "Expression to evaluate on events to generate output. Example:
            `raw=${_raw}`. See [Cribl
            Docs](https://docs.cribl.io/stream/destinations-webhook#custom-form\
            at) for other examples. If empty, the full event is sent as
            stringified JSON."
          default: __httpOut
        customDropWhenNull:
          type: boolean
          title: Drop when null
          description: Whether to drop events when the source expression evaluates to null
          default: false
        customEventDelimiter:
          type: string
          title: Event delimiter
          description: Delimiter string to insert between individual events. Defaults to
            newline character.
          default: \n
        customContentType:
          type: string
          title: Content type
          description: Content type to use for request. Defaults to application/x-ndjson.
            Any content types set in Advanced Settings > Extra HTTP headers will
            override this entry.
          default: application/x-ndjson
        customPayloadExpression:
          type: string
          title: Batch expression
          description: 'Expression specifying how to format the payload for each batch. To
            reference the events to send, use the `${events}` variable. Example
            expression: `{ "items" : [${events}] }` would send the batch inside
            a JSON object.'
          default: "`${events}`"
        advancedContentType:
          type: string
          title: Content type
          description: HTTP content-type header value
          default: application/json
        formatEventCode:
          type: string
          title: Format inbound event
          description: "Custom JavaScript code to format incoming event data accessible
            through the __e variable. The formatted content is added to
            (__e['__eventOut']) if available. Otherwise, the original event is
            serialized as JSON. Caution: This function is evaluated in an
            unprotected context, allowing you to execute almost any JavaScript
            code."
        formatPayloadCode:
          type: string
          title: Format outbound payload
          description: "Optional JavaScript code to format the payload sent to the
            Destination. The payload, containing a batch of formatted events, is
            accessible through the __e['payload'] variable. The formatted
            payload is returned in the __e['__payloadOut'] variable. Caution:
            This function is evaluated in an unprotected context, allowing you
            to execute almost any JavaScript code."
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        url:
          title: URL
          type: string
          description: URL to send events to. Can be overwritten by an event's __url field.
          pattern: ^https?://.*
        dcrID:
          type: string
          title: Data collection rule ID
          description: Immutable ID for the Data Collection Rule (DCR)
        dceEndpoint:
          type: string
          title: Data collection endpoint
          description: "Data collection endpoint (DCE) URL. In the format:
            `https://<Endpoint-Name>-<Identifier>.<Region>.ingest.monitor.azure\
            .com`"
          pattern: ^https:\/\/([a-zA-Z0-9-_\.]+)\.ingest\.monitor\.azure\.com(\/?)$
        streamName:
          type: string
          title: Stream name
          description: The name of the stream (Sentinel table) in which to store the events
    OutputDevnull:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - devnull
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
      required:
        - type
    OutputSyslog:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - syslog
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        protocol:
          type: string
          title: Protocol
          description: The network protocol to use for sending out syslog messages
          default: tcp
          enum:
            - tcp
            - udp
          x-speakeasy-enum-descriptions:
            - TCP
            - UDP
          x-speakeasy-unknown-values: allow
        facility:
          type: integer
          title: Facility
          description: Default value for message facility. Will be overwritten by value of
            __facility if set. Defaults to user.
          default: 1
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 19
            - 20
            - 21
          x-speakeasy-unknown-values: allow
        severity:
          type: integer
          title: Severity
          description: Default value for message severity. Will be overwritten by value of
            __severity if set. Defaults to notice.
          default: 5
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
          x-speakeasy-enum-descriptions:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
            - debug
          x-speakeasy-unknown-values: allow
        appName:
          type: string
          title: App name
          description: Default name for device or application that originated the message.
            Defaults to Cribl, but will be overwritten by value of __appname if
            set.
          default: Cribl
        messageFormat:
          type: string
          default: rfc3164
          enum:
            - rfc3164
            - rfc5424
          title: Message format
          description: The syslog message format depending on the receiver's support
          x-speakeasy-enum-descriptions:
            - RFC3164
            - RFC5424
          x-speakeasy-unknown-values: allow
        timestampFormat:
          type: string
          default: syslog
          enum:
            - syslog
            - iso8601
          title: Timestamp format
          description: Timestamp format to use when serializing event's time field
          x-speakeasy-enum-descriptions:
            - Syslog
            - ISO8601
          x-speakeasy-unknown-values: allow
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        octetCountFraming:
          type: boolean
          title: Octet count framing
          description: Prefix messages with the byte count of the message. If disabled, no
            prefix will be set, and the message will be appended with a \n.
        logFailedRequests:
          type: boolean
          title: Log failed requests to disk
          description: Use to troubleshoot issues with sending data
          default: false
        description:
          type: string
          title: Description
        loadBalanced:
          type: boolean
          title: Load balancing
          description: For optimal performance, enable load balancing even if you have one
            hostname, as it can expand to multiple IPs.  If this setting is
            disabled, consider enabling round-robin DNS.
          default: true
        host:
          type: string
          title: Address
          description: The hostname of the receiver
        port:
          type: number
          title: Port
          maximum: 65535
          description: The port to connect to on the provided host
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        hosts:
          type: array
          title: Destinations
          description: Set of hosts to load-balance data to
          minItems: 1
          items:
            type: object
            required:
              - host
              - port
            properties:
              host:
                type: string
                title: Address
                description: The hostname of the receiver
              port:
                type: number
                title: Port
                maximum: 65535
                description: The port to connect to on the provided host
              tls:
                type: string
                title: TLS
                description: Whether to inherit TLS configs from group setting or disable TLS
                enum:
                  - inherit
                  - off
                default: inherit
                x-speakeasy-unknown-values: allow
              servername:
                type: string
                title: TLS Servername
                description: Servername to use if establishing a TLS connection. If not
                  specified, defaults to connection host (if not an IP);
                  otherwise, uses the global TLS settings.
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        maxConcurrentSenders:
          type: number
          default: 0
          minimum: 0
          title: Connection limit
          description: Maximum number of concurrent connections (per Worker Process). A
            random set of IPs will be picked on every DNS resolution period. Use
            0 for unlimited.
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        maxRecordSize:
          type: number
          title: Record size limit
          default: 1500
          minimum: 1
          maximum: 65535
          description: Maximum size of syslog messages. Make sure this value is less than
            or equal to the MTU to avoid UDP packet fragmentation.
        udpDnsResolvePeriodSec:
          type: number
          default: 0
          minimum: 0
          maximum: 86400
          title: DNS resolution period (sec)
          description: How often to resolve the destination hostname to an IP address.
            Ignored if the destination is an IP address. A value of 0 means
            every message sent will incur a DNS lookup.
        enableIpSpoofing:
          title: Enable Source IP spoofing
          description: Send Syslog traffic using the original event's Source IP and port.
            To enable this, you must install the external `udp-sender` helper
            binary at `/usr/bin/udp-sender` on all Worker Nodes and grant it the
            `CAP_NET_RAW` capability.
          type: boolean
          default: false
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
      required:
        - type
    OutputSplunk:
      type: object
      required:
        - type
        - host
        - port
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - splunk
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        host:
          type: string
          title: Address
          description: The hostname of the receiver
        port:
          type: number
          title: Port
          maximum: 65535
          description: The port to connect to on the provided host
          default: 9997
        nestedFields:
          type: string
          enum:
            - json
            - none
          x-speakeasy-enum-descriptions:
            - JSON
            - None
          title: Nested field serialization
          description: How to serialize nested fields into index-time fields
          default: none
          x-speakeasy-unknown-values: allow
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        enableMultiMetrics:
          type: boolean
          title: Output multiple metrics
          description: Output metrics in multiple-metric format in a single event.
            Supported in Splunk 8.0 and above.
          default: false
        enableACK:
          type: boolean
          title: Minimize in-flight data loss
          description: Check if indexer is shutting down and stop sending data. This helps
            minimize data loss during shutdown.
          default: true
        logFailedRequests:
          type: boolean
          title: Log failed requests to disk
          description: Use to troubleshoot issues with sending data
          default: false
        maxS2Sversion:
          type: string
          title: Max S2S version
          description: The highest S2S protocol version to advertise during handshake
          enum:
            - v3
            - v4
          default: v3
          x-speakeasy-unknown-values: allow
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        maxFailedHealthChecks:
          type: number
          title: Failed health check limit
          description: Maximum number of times healthcheck can fail before we close
            connection. If set to 0 (disabled), and the connection to Splunk is
            forcibly closed, some data loss might occur.
          default: 1
          minimum: 0
        compress:
          type: string
          title: Compression
          description: Controls whether the sender should send compressed data to the
            server. Select 'Disabled' to reject compressed connections or
            'Always' to ignore server's configuration and send compressed data.
          default: disabled
          enum:
            - disabled
            - auto
            - always
          x-speakeasy-enum-descriptions:
            - Disabled
            - Automatic
            - Always
          x-speakeasy-unknown-values: allow
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        authToken:
          type: string
          title: Auth token
          description: Shared secret token to use when establishing a connection to a
            Splunk indexer.
          default: ""
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
    OutputSplunkLb:
      type: object
      required:
        - type
        - hosts
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - splunk_lb
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        maxConcurrentSenders:
          type: number
          default: 0
          minimum: 0
          title: Connection limit
          description: Maximum number of concurrent connections (per Worker Process). A
            random set of IPs will be picked on every DNS resolution period. Use
            0 for unlimited.
        nestedFields:
          type: string
          enum:
            - json
            - none
          x-speakeasy-enum-descriptions:
            - JSON
            - None
          title: Nested field serialization
          description: How to serialize nested fields into index-time fields
          default: none
          x-speakeasy-unknown-values: allow
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        enableMultiMetrics:
          type: boolean
          title: Output multiple metrics
          description: Output metrics in multiple-metric format in a single event.
            Supported in Splunk 8.0 and above.
          default: false
        enableACK:
          type: boolean
          title: Minimize in-flight data loss
          description: Check if indexer is shutting down and stop sending data. This helps
            minimize data loss during shutdown.
          default: true
        logFailedRequests:
          type: boolean
          title: Log failed requests to disk
          description: Use to troubleshoot issues with sending data
          default: false
        maxS2Sversion:
          type: string
          title: Max S2S version
          description: The highest S2S protocol version to advertise during handshake
          enum:
            - v3
            - v4
          default: v3
          x-speakeasy-unknown-values: allow
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        indexerDiscovery:
          type: boolean
          default: false
          title: Indexer Discovery
          description: Automatically discover indexers in indexer clustering environment.
        senderUnhealthyTimeAllowance:
          type: number
          title: Endpoint health fluctuation time allowance (ms)
          description: How long (in milliseconds) each LB endpoint can report blocked
            before the Destination reports unhealthy, blocking the sender.
            (Grace period for fluctuations.) Use 0 to disable; max 1 minute.
          default: 100
          minimum: 0
          maximum: 60000
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        maxFailedHealthChecks:
          type: number
          title: Failed health check limit
          description: Maximum number of times healthcheck can fail before we close
            connection. If set to 0 (disabled), and the connection to Splunk is
            forcibly closed, some data loss might occur.
          default: 1
          minimum: 0
        compress:
          type: string
          title: Compression
          description: Controls whether the sender should send compressed data to the
            server. Select 'Disabled' to reject compressed connections or
            'Always' to ignore server's configuration and send compressed data.
          default: disabled
          enum:
            - disabled
            - auto
            - always
          x-speakeasy-enum-descriptions:
            - Disabled
            - Automatic
            - Always
          x-speakeasy-unknown-values: allow
        indexerDiscoveryConfigs:
          type: object
          description: List of configurations to set up indexer discovery in Splunk
            Indexer clustering environment.
          required:
            - masterUri
            - site
            - refreshIntervalSec
          properties:
            site:
              type: string
              pattern: "[0-9A-Za-z-._]+"
              title: Site
              description: Clustering site of the indexers from where indexers need to be
                discovered. In case of single site cluster, it defaults to
                'default' site.
              default: default
            masterUri:
              type: string
              pattern: ^https?://[a-zA-Z0-9-._]+:[0-9]+$
              title: Cluster manager URI
              description: "Full URI of Splunk cluster manager (scheme://host:port). Example:
                https://managerAddress:8089"
            refreshIntervalSec:
              type: number
              default: 300
              minimum: 60
              maximum: 86400
              title: Refresh period
              description: Time interval, in seconds, between two consecutive indexer list
                fetches from cluster manager
            rejectUnauthorized:
              type: boolean
              title: Validate cluster manager certificates
              default: false
              description: During indexer discovery, reject cluster manager certificates that
                are not authorized by the system's CA. Disable to allow
                untrusted (for example, self-signed) certificates.
            authTokens:
              type: array
              title: Authentication tokens
              description: Tokens required to authenticate to cluster manager for indexer
                discovery
              items:
                type: object
                properties:
                  authType:
                    title: Authentication method
                    type: string
                    enum:
                      - manual
                      - secret
                    default: manual
                    description: Select Manual to enter an auth token directly, or select Secret to
                      use a text secret to authenticate
                    x-speakeasy-unknown-values: allow
            authType:
              title: Authentication method
              type: string
              enum:
                - manual
                - secret
              default: manual
              description: Select Manual to enter an auth token directly, or select Secret to
                use a text secret to authenticate
              x-speakeasy-unknown-values: allow
            authToken:
              type: string
              title: Auth token
              description: Shared secret to be provided by any client (in authToken header
                field). If empty, unauthorized access is permitted.
              default: ""
            textSecret:
              type: string
              title: Auth token (text secret)
              description: Select or create a stored text secret
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        hosts:
          type: array
          title: Destinations
          description: Set of Splunk indexers to load-balance data to.
          minItems: 1
          items:
            type: object
            required:
              - host
              - port
            properties:
              host:
                type: string
                title: Address
                description: The hostname of the receiver
              port:
                type: number
                title: Port
                maximum: 65535
                description: The port to connect to on the provided host
                default: 9997
              tls:
                type: string
                title: TLS
                description: Whether to inherit TLS configs from group setting or disable TLS
                enum:
                  - inherit
                  - off
                default: inherit
                x-speakeasy-unknown-values: allow
              servername:
                type: string
                title: TLS Servername
                description: Servername to use if establishing a TLS connection. If not
                  specified, defaults to connection host (if not an IP);
                  otherwise, uses the global TLS settings.
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        authToken:
          type: string
          title: Auth token
          description: Shared secret token to use when establishing a connection to a
            Splunk indexer.
          default: ""
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
    OutputSplunkHec:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - splunk_hec
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        loadBalanced:
          type: boolean
          title: Load balancing
          description: Enable for optimal performance. Even if you have one hostname, it
            can expand to multiple IPs. If disabled, consider enabling
            round-robin DNS.
          default: true
        nextQueue:
          type: string
          title: Next Processing Queue
          description: In the Splunk app, define which Splunk processing queue to send the
            events after HEC processing.
          default: indexQueue
        tcpRouting:
          type: string
          title: Default _TCP_ROUTING
          description: In the Splunk app, set the value of _TCP_ROUTING for events that do
            not have _ctrl._TCP_ROUTING set.
          default: nowhere
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 2097152
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        enableMultiMetrics:
          type: boolean
          title: Output multi-metrics
          description: Output metrics in multiple-metric format, supported in Splunk 8.0
            and above to allow multiple metrics in a single event.
          default: false
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        url:
          type: string
          title: Splunk HEC Endpoint
          description: URL to a Splunk HEC endpoint to send events to, e.g.,
            http://localhost:8088/services/collector/event
          default: http://localhost:8088/services/collector/event
          pattern: ^https?://.*
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        urls:
          type: array
          title: Splunk HEC Endpoints
          description: ""
          minItems: 1
          items:
            type: object
            required:
              - url
            properties:
              url:
                type: string
                title: HEC Endpoint
                description: URL to a Splunk HEC endpoint to send events to, e.g.,
                  http://localhost:8088/services/collector/event
                default: http://localhost:8088/services/collector/event
                pattern: ^https?://.*
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        token:
          type: string
          title: HEC Auth token
          description: Splunk HEC authentication token
        textSecret:
          type: string
          title: HEC Auth token (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
      required:
        - type
    OutputTcpjson:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - tcpjson
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        loadBalanced:
          type: boolean
          title: Load balancing
          description: Use load-balanced destinations
          default: true
        compression:
          type: string
          default: gzip
          enum:
            - none
            - gzip
          title: Compression
          description: Codec to use to compress the data before sending
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          x-speakeasy-unknown-values: allow
        logFailedRequests:
          type: boolean
          title: Log failed requests to disk
          description: Use to troubleshoot issues with sending data
          default: false
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        tokenTTLMinutes:
          type: number
          title: Auth Token TTL minutes
          default: 60
          minimum: 1
          maximum: 60
          description: The number of minutes before the internally generated
            authentication token expires, valid values between 1 and 60
        sendHeader:
          type: boolean
          title: Send auth token in initial record
          description: Upon connection, send a header-like record containing the auth
            token and other metadata.This record will not contain an actual
            event – only subsequent records will.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        host:
          type: string
          title: Address
          description: The hostname of the receiver
        port:
          type: number
          title: Port
          maximum: 65535
          description: The port to connect to on the provided host
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        hosts:
          type: array
          title: Destinations
          description: Set of hosts to load-balance data to
          minItems: 1
          items:
            type: object
            required:
              - host
              - port
            properties:
              host:
                type: string
                title: Address
                description: The hostname of the receiver
              port:
                type: number
                title: Port
                maximum: 65535
                description: The port to connect to on the provided host
              tls:
                type: string
                title: TLS
                description: Whether to inherit TLS configs from group setting or disable TLS
                enum:
                  - inherit
                  - off
                default: inherit
                x-speakeasy-unknown-values: allow
              servername:
                type: string
                title: TLS Servername
                description: Servername to use if establishing a TLS connection. If not
                  specified, defaults to connection host (if not an IP);
                  otherwise, uses the global TLS settings.
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        maxConcurrentSenders:
          type: number
          default: 0
          minimum: 0
          title: Connection limit
          description: Maximum number of concurrent connections (per Worker Process). A
            random set of IPs will be picked on every DNS resolution period. Use
            0 for unlimited.
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        authToken:
          type: string
          title: Auth token
          description: Optional authentication token to include as part of the connection
            header
          default: ""
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
      required:
        - type
    OutputWavefront:
      type: object
      required:
        - type
        - domain
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - wavefront
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        domain:
          type: string
          title: Domain name
          description: WaveFront domain name, e.g. "longboard"
          default: longboard
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        token:
          type: string
          title: Auth token
          description: WaveFront API authentication token (see
            [here](https://docs.wavefront.com/wavefront_api.html#generating-an-api-token))
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputSignalfx:
      type: object
      required:
        - type
        - realm
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - signalfx
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        realm:
          type: string
          title: Realm
          description: SignalFx realm name, e.g. "us0". For a complete list of available
            SignalFx realm names, please check
            [here](https://docs.splunk.com/observability/en/get-started/service-description.html#sd-regions).
          default: us0
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        token:
          type: string
          title: Auth token
          description: SignalFx API access token (see
            [here](https://docs.signalfx.com/en/latest/admin-guide/tokens.html#working-with-access-tokens))
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputFilesystem:
      type: object
      required:
        - type
        - destPath
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - filesystem
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        destPath:
          type: string
          title: Output location
          description: Final destination for the output files
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files before compressing and
            moving to final destination. Use performant, stable storage.
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized. Default is date-based. If blank, Stream will fall back to
            the event's __partition field value – if present – otherwise to each
            location's root directory.
          default: "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 1800
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 1800
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        description:
          type: string
          title: Description
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    OutputS3:
      type: object
      required:
        - type
        - bucket
        - stagePath
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - s3
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        bucket:
          type: string
          title: S3 bucket name
          description: "Name of the destination S3 bucket. Must be a JavaScript expression
            (which can evaluate to a constant value), enclosed in quotes or
            backticks. Can be evaluated only at initialization time. Example
            referencing a Global Variable: `myBucket-${C.vars.myVar}`"
        region:
          type: string
          title: Region
          description: Region where the S3 bucket is located
        awsSecretKey:
          type: string
          title: Secret key
          description: "Secret key. This value can be a constant or a JavaScript
            expression. Example: `${C.env.SOME_SECRET}`)"
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        endpoint:
          type: string
          title: Endpoint
          description: S3 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to S3-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing S3 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for S3
          description: Use Assume Role credentials to access S3
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        destPath:
          type: string
          title: Key prefix
          description: "Prefix to prepend to files before uploading. Must be a JavaScript
            expression (which can evaluate to a constant value), enclosed in
            quotes or backticks. Can be evaluated only at init time. Example
            referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"
          default: ""
        objectACL:
          type: string
          title: Object ACL
          description: Object ACL to assign to uploaded objects
          default: private
          enum:
            - private
            - public-read
            - public-read-write
            - authenticated-read
            - aws-exec-read
            - bucket-owner-read
            - bucket-owner-full-control
          x-speakeasy-enum-descriptions:
            - Private
            - Public Read Only
            - Public Read/Write
            - Authenticated Read Only
            - AWS EC2 AMI Read Only
            - Bucket Owner Read Only
            - Bucket Owner Full Control
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - REDUCED_REDUNDANCY
            - STANDARD_IA
            - ONEZONE_IA
            - INTELLIGENT_TIERING
            - GLACIER
            - GLACIER_IR
            - DEEP_ARCHIVE
          x-speakeasy-enum-descriptions:
            - Standard
            - Reduced Redundancy Storage
            - Standard, Infrequent Access
            - One Zone, Infrequent Access
            - Intelligent Tiering
            - Glacier Flexible Retrieval
            - Glacier Instant Retrieval
            - Glacier Deep Archive
          x-speakeasy-unknown-values: allow
        serverSideEncryption:
          type: string
          title: Server-side encryption for uploaded objects
          enum:
            - AES256
            - aws:kms
          x-speakeasy-enum-descriptions:
            - Amazon S3 Managed Key
            - AWS KMS Managed Key
          x-speakeasy-unknown-values: allow
        kmsKeyId:
          type: string
          title: KMS key ID
          description: ID or ARN of the KMS customer-managed key to use for encryption
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized. Default is date-based. If blank, Stream will fall back to
            the event's __partition field value – if present – otherwise to each
            location's root directory.
          default: "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 86400
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 86400
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts upload limit
          description: Maximum number of parts to upload in parallel per file. Minimum
            part size is 5MB.
          default: 4
          minimum: 1
          maximum: 10
        verifyPermissions:
          type: boolean
          title: Verify if bucket exists
          description: Disable if you can access files within the bucket but not the
            bucket itself
          default: true
        maxClosingFilesToBackpressure:
          type: number
          title: Staging file limit
          description: Maximum number of files that can be waiting for upload before
            backpressure is applied
          default: 100
          minimum: 10
          maximum: 4200
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: This value can be a constant or a JavaScript expression
            (`${C.env.SOME_ACCESS_KEY}`)
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    OutputAzureBlob:
      type: object
      required:
        - type
        - containerName
        - stagePath
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - azure_blob
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        containerName:
          type: string
          title: Container name
          description: The Azure Blob Storage container name. Name can include only
            lowercase letters, numbers, and hyphens. For dynamic container
            names, enter a JavaScript expression within quotes or backticks, to
            be evaluated at initialization. The expression can evaluate to a
            constant value and can reference Global Variables, such as
            `myContainer-${C.env["CRIBL_WORKER_ID"]}`.
        createContainer:
          type: boolean
          title: Create container
          description: Create the configured container in Azure Blob Storage if it does
            not already exist
          default: false
        destPath:
          type: string
          title: Blob prefix
          description: Root directory prepended to path before uploading. Value can be a
            JavaScript expression enclosed in quotes or backticks, to be
            evaluated at initialization. The expression can evaluate to a
            constant value and can reference Global Variables, such as
            `myBlobPrefix-${C.env["CRIBL_WORKER_ID"]}`.
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files before compressing and
            moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts limit
          description: Maximum number of parts to upload in parallel per file
          default: 1
          minimum: 1
          maximum: 10
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized. Default is date-based. If blank, Stream will fall back to
            the event's __partition field value – if present – otherwise to each
            location's root directory.
          default: "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 1800
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 1800
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
            - clientSecret
            - clientCert
          default: manual
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Blob access tier
          enum:
            - Inferred
            - Hot
            - Cool
            - Cold
            - Archive
          x-speakeasy-enum-descriptions:
            - Default account access tier
            - Hot tier
            - Cool tier
            - Cold tier
            - Archive tier
          default: Inferred
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
        connectionString:
          type: string
          title: Connection string
          description: Enter your Azure Storage account connection string. If left blank,
            Stream will fall back to env.AZURE_STORAGE_CONNECTION_STRING.
        textSecret:
          type: string
          title: Connection string (text secret)
          description: Select or create a stored text secret
        storageAccountName:
          type: string
          title: Storage account name
          description: The name of your Azure storage account
        tenantId:
          type: string
          title: Tenant ID
          description: The service principal's tenant ID
        clientId:
          type: string
          title: Client ID
          description: The service principal's client ID
        azureCloud:
          type: string
          title: Azure Cloud
          description: The Azure cloud to use. Defaults to Azure Public Cloud.
        endpointSuffix:
          type: string
          title: Endpoint suffix
          description: Endpoint suffix for the service URL. Takes precedence over the
            Azure Cloud setting. Defaults to core.windows.net.
        clientTextSecret:
          type: string
          title: Client secret (text secret)
          description: Select or create a stored text secret
        certificate:
          type: object
          required:
            - certificateName
          properties:
            certificateName:
              type: string
              title: Certificate
              description: The certificate you registered as credentials for your app in the
                Azure portal
    OutputAzureDataExplorer:
      type: object
      required:
        - type
        - clusterUrl
        - database
        - table
        - compress
        - oauthEndpoint
        - tenantId
        - clientId
        - scope
        - oauthType
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - azure_data_explorer
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        clusterUrl:
          type: string
          title: Cluster base URI
          description: The base URI for your cluster. Typically,
            `https://<cluster>.<region>.kusto.windows.net`.
          pattern: ^https://
        database:
          type: string
          title: Database name
          description: Name of the database containing the table where data will be ingested
          pattern: ^[\w\s\-\.]+$
          maxLength: 260
        table:
          type: string
          title: Table name
          description: Name of the table to ingest data into
          pattern: ^[\w\-\.]+$
          maxLength: 1024
        validateDatabaseSettings:
          type: boolean
          title: Validate database settings
          description: When saving or starting the Destination, validate the database name
            and credentials; also validate table name, except when creating a
            new table. Disable if your Azure app does not have both the Database
            Viewer and the Table Viewer role.
          default: true
        ingestMode:
          type: string
          title: Ingestion mode
          enum:
            - batching
            - streaming
          x-speakeasy-enum-descriptions:
            - Batching
            - Streaming
          default: batching
          x-speakeasy-unknown-values: allow
        oauthEndpoint:
          type: string
          title: Microsoft Entra ID authentication endpoint
          default: https://login.microsoftonline.com
          enum:
            - https://login.microsoftonline.com
            - https://login.microsoftonline.us
            - https://login.partner.microsoftonline.cn
          description: Endpoint used to acquire authentication tokens from Azure
          x-speakeasy-unknown-values: allow
        tenantId:
          type: string
          title: Tenant ID
          description: Directory ID (tenant identifier) in Azure Active Directory
        clientId:
          type: string
          title: Client ID
          description: client_id to pass in the OAuth request parameter
        scope:
          type: string
          title: Scope
          description: Scope to pass in the OAuth request parameter
        oauthType:
          title: Authentication method
          type: string
          enum:
            - clientSecret
            - clientTextSecret
            - certificate
          x-speakeasy-enum-descriptions:
            - Client secret
            - Client secret (text secret)
            - Certificate
          default: clientSecret
          description: The type of OAuth 2.0 client credentials grant flow to use
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        clientSecret:
          type: string
          title: Client secret
          description: The client secret that you generated for your app in the Azure portal
        textSecret:
          type: string
          title: Client secret (text secret)
          description: Select or create a stored text secret
        certificate:
          type: object
          properties:
            certificateName:
              type: string
              title: Certificate
              description: The certificate you registered as credentials for your app in the
                Azure portal
        format:
          enum:
            - json
            - raw
            - parquet
          type: string
          title: Data format
          description: Format of the output data
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
        isMappingObj:
          type: boolean
          title: Add mapping object
          description: Send a JSON mapping object instead of specifying an existing named
            data mapping
          default: false
        mappingObj:
          type: string
          title: Data mapping
          description: Enter a JSON object that defines your desired data mapping
        mappingRef:
          type: string
          title: Data mapping
          description: Enter the name of a data mapping associated with your target table.
            Or, if incoming event and target table fields match exactly, you can
            leave the field empty.
          pattern: ^[\w\-\.]+$
        ingestUrl:
          type: string
          title: Ingestion service URI
          description: The ingestion service URI for your cluster. Typically,
            `https://ingest-<cluster>.<region>.kusto.windows.net`.
          pattern: ^https://
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files before compressing and
            moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 1800
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 1800
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts limit
          description: Maximum number of parts to upload in parallel per file
          default: 1
          minimum: 1
          maximum: 10
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushImmediately:
          type: boolean
          title: Flush immediately
          description: Bypass the data management service's aggregation mechanism
          default: false
        retainBlobOnSuccess:
          type: boolean
          title: Retain blob on success
          description: Prevent blob deletion after ingestion is complete
          default: false
        extentTags:
          type: array
          title: Extent tags
          description: Strings or tags associated with the extent (ingested data shard)
          items:
            type: object
            required:
              - value
            properties:
              prefix:
                type: string
                title: Prefix (optional)
                enum:
                  - dropBy
                  - ingestBy
                x-speakeasy-enum-descriptions:
                  - drop-by
                  - ingest-by
                x-speakeasy-unknown-values: allow
              value:
                type: string
                title: Value
        ingestIfNotExists:
          type: array
          title: Enforce uniqueness via tag values
          description: Prevents duplicate ingestion by verifying whether an extent with
            the specified ingest-by tag already exists
          items:
            type: object
            required:
              - value
            properties:
              value:
                type: string
                title: Value
        reportLevel:
          type: string
          title: Report level
          description: Level of ingestion status reporting. Defaults to FailuresOnly.
          enum:
            - failuresOnly
            - doNotReport
            - failuresAndSuccesses
          x-speakeasy-enum-descriptions:
            - FailuresOnly
            - DoNotReport
            - FailuresAndSuccesses
          default: failuresOnly
          x-speakeasy-unknown-values: allow
        reportMethod:
          type: string
          title: Report method
          description: Target of the ingestion status reporting. Defaults to Queue.
          enum:
            - queue
            - table
            - queueAndTable
          x-speakeasy-enum-descriptions:
            - Queue
            - Table
            - QueueAndTable
          default: queue
          x-speakeasy-unknown-values: allow
        additionalProperties:
          type: array
          title: Additional fields
          description: Optionally, enter additional configuration properties to send to
            the ingestion service
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                pattern: ^[\w\-\.]+$
              value:
                type: string
                title: Value
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default:
            - httpStatus: 429
              initialBackoff: 1000
              backoffRate: 2
              maxBackoff: 10000
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 4096
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        keepAlive:
          type: boolean
          title: Keep alive
          description: Disable to close the connection immediately after sending the
            outgoing request
          default: true
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputAzureLogs:
      type: object
      required:
        - type
        - logType
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - azure_logs
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        logType:
          type: string
          title: Log Type
          description: The Log Type of events sent to this LogAnalytics workspace.
            Defaults to `Cribl`. Use only letters, numbers, and `_` characters,
            and can't exceed 100 characters. Can be overwritten by event field
            __logType.
          default: Cribl
          maxLength: 100
        resourceId:
          type: string
          title: Resource ID
          description: Optional Resource ID of the Azure resource to associate the data
            with. Can be overridden by the __resourceId event field. This ID
            populates the _ResourceId property, allowing the data to be included
            in resource-centric queries. If the ID is neither specified nor
            overridden, resource-centric queries will omit the data.
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 1024
          minimum: 1
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        apiUrl:
          type: string
          title: DNS name of API endpoint
          description: "The DNS name of the Log API endpoint that sends log data to a Log
            Analytics workspace in Azure Monitor. Defaults to
            .ods.opinsights.azure.com. @{product} will add a prefix and suffix
            to construct a URI in this format:
            <https://<Workspace_ID><your_DNS_name>/api/logs?api-version=<API
            version>."
          pattern: ^\.[^\/]+$
          default: .ods.opinsights.azure.com
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter workspace ID and workspace key directly, or select a stored
            secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        workspaceId:
          type: string
          title: Workspace ID
          description: Azure Log Analytics Workspace ID. See Azure Dashboard Workspace >
            Advanced settings.
        workspaceKey:
          type: string
          title: Workspace key
          description: Azure Log Analytics Workspace Primary or Secondary Shared Key. See
            Azure Dashboard Workspace > Advanced settings.
        keypairSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
    OutputKinesis:
      type: object
      required:
        - type
        - streamName
        - region
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - kinesis
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        streamName:
          type: string
          title: Stream Name
          description: Kinesis stream name to send events to.
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the Kinesis stream is located
        endpoint:
          type: string
          title: Endpoint
          description: Kinesis stream service endpoint. If empty, defaults to the AWS
            Region-specific endpoint. Otherwise, it must point to Kinesis
            stream-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing Kinesis stream requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for Kinesis stream
          description: Use Assume Role credentials to access Kinesis stream
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        concurrency:
          type: number
          title: Put request concurrency
          description: Maximum number of ongoing put requests before blocking.
          default: 5
          minimum: 1
          maximum: 32
        maxRecordSizeKB:
          type: number
          title: Record size limit (KB, uncompressed)
          description: Maximum size (KB) of each individual record before compression. For
            uncompressed or non-compressible data 1MB is the max recommended
            size
          default: 1024
          minimum: 1
          maximum: 10240
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Max record size.
        compression:
          type: string
          default: gzip
          enum:
            - none
            - gzip
          title: Compression
          description: Compression type to use for records
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          x-speakeasy-unknown-values: allow
        useListShards:
          type: boolean
          title: ListShards API
          description: Provides higher stream rate limits, improving delivery speed and
            reliability by minimizing throttling. See the [ListShards
            API](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html)
            documentation for details.
          default: false
        asNdjson:
          type: boolean
          title: Send batched
          description: Batch events into a single record as NDJSON
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        maxEventsPerFlush:
          type: number
          title: Records-per-flush limit
          description: Maximum number of records to send in a single request
          default: 500
          minimum: 1
          maximum: 500
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputHoneycomb:
      type: object
      required:
        - type
        - dataset
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - honeycomb
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        dataset:
          type: string
          title: Dataset name
          description: Name of the dataset to send events to – e.g., observability
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter API key directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        team:
          type: string
          title: API key
          description: Team API key where the dataset belongs
        textSecret:
          type: string
          title: API key (text secret)
          description: Select or create a stored text secret
    OutputAzureEventhub:
      type: object
      required:
        - type
        - brokers
        - topic
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - azure_eventhub
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        brokers:
          type: array
          title: Brokers
          description: List of Event Hubs Kafka brokers to connect to, eg.
            yourdomain.servicebus.windows.net:9093. The hostname can be found in
            the host portion of the primary or secondary connection string in
            Shared Access Policies.
          minItems: 1
          items:
            type: string
            minLength: 1
        topic:
          type: string
          title: Event Hub name
          description: The name of the Event Hub (Kafka Topic) to publish events. Can be
            overwritten using field __topicOut.
        ack:
          type: integer
          default: 1
          title: Acknowledgments
          description: Control the number of required acknowledgments
          enum:
            - 1
            - 0
            - -1
          x-speakeasy-enum-descriptions:
            - Leader
            - None
            - All
          x-speakeasy-unknown-values: allow
        format:
          type: string
          default: json
          enum:
            - json
            - raw
          title: Record data format
          description: Format to use to serialize events before writing to the Event Hubs
            Kafka brokers
          x-speakeasy-enum-descriptions:
            - JSON
            - Field _raw
          x-speakeasy-unknown-values: allow
        maxRecordSizeKB:
          type: number
          default: 768
          minimum: 1
          title: Record size limit (KB, uncompressed)
          description: Maximum size of each record batch before compression. Setting
            should be < message.max.bytes settings in Event Hubs brokers.
        flushEventCount:
          type: number
          default: 1000
          minimum: 1
          maximum: 10000
          title: Events-per-batch limit
          description: Maximum number of events in a batch before forcing a flush
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Max record size.
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        sasl:
          type: object
          title: Authentication
          description: Authentication parameters to use when connecting to brokers. Using
            TLS is highly recommended.
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            authType:
              enum:
                - manual
                - secret
              title: Authentication method
              type: string
              default: manual
              description: Enter password directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            password:
              type: string
              title: Password
              description: Connection-string primary key, or connection-string secondary key,
                from the Event Hubs workspace
            textSecret:
              type: string
              title: Password (text secret)
              description: Select or create a stored text secret
            mechanism:
              enum:
                - plain
                - oauthbearer
              type: string
              x-speakeasy-enum-descriptions:
                - PLAIN
                - OAUTHBEARER
              title: SASL mechanism
              default: plain
              x-speakeasy-unknown-values: allow
            username:
              type: string
              title: Username
              default: $ConnectionString
              description: The username for authentication. For Event Hubs, this should always
                be $ConnectionString.
            clientSecretAuthType:
              enum:
                - manual
                - secret
                - certificate
              title: Authentication method
              type: string
              default: manual
              x-speakeasy-unknown-values: allow
            clientSecret:
              type: string
              title: Client secret
              description: client_secret to pass in the OAuth request parameter
            clientTextSecret:
              type: string
              title: Client secret (text secret)
              description: Select or create a stored text secret
            certificateName:
              type: string
              title: Certificate
              description: Select or create a stored certificate
            certPath:
              type: string
            privKeyPath:
              type: string
            passphrase:
              type: string
            oauthEndpoint:
              type: string
              title: Microsoft Entra ID authentication endpoint
              default: https://login.microsoftonline.com
              enum:
                - https://login.microsoftonline.com
                - https://login.microsoftonline.us
                - https://login.partner.microsoftonline.cn
              description: Endpoint used to acquire authentication tokens from Azure
              x-speakeasy-unknown-values: allow
            clientId:
              type: string
              title: Client ID
              description: client_id to pass in the OAuth request parameter
            tenantId:
              type: string
              title: Tenant identifier
              description: Directory ID (tenant identifier) in Azure Active Directory
            scope:
              type: string
              title: Scope
              description: Scope to pass in the OAuth request parameter
        tls:
          type: object
          title: TLS settings (client side)
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another trusted CA (such as the
                system's)
              default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputGoogleChronicle:
      type: object
      required:
        - type
        - logFormatType
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - google_chronicle
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        apiVersion:
          type: string
          title: API version
          default: v1
          enum:
            - v1
            - v2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          x-speakeasy-unknown-values: allow
        authenticationMethod:
          type: string
          title: Authentication method
          default: serviceAccount
          enum:
            - manual
            - secret
            - serviceAccount
            - serviceAccountSecret
          x-speakeasy-enum-descriptions:
            - API key
            - API key secret
            - Service account credentials
            - Service account credentials secret
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default:
            - httpStatus: 429
              initialBackoff: 30000
              backoffRate: 1
              maxBackoff: 30000
            - httpStatus: 500
              initialBackoff: 30000
              backoffRate: 1
              maxBackoff: 30000
            - httpStatus: 503
              initialBackoff: 30000
              backoffRate: 1
              maxBackoff: 30000
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        logFormatType:
          type: string
          title: Send events as
          description: ""
          default: unstructured
          enum:
            - unstructured
            - udm
          x-speakeasy-enum-descriptions:
            - Unstructured
            - UDM
          x-speakeasy-unknown-values: allow
        region:
          type: string
          title: Region
          description: Regional endpoint to send events to
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 1024
          minimum: 1
          maximum: 1024
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 90
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        extraLogTypes:
          type: array
          title: Custom log types
          description: Custom log types. If the value "Custom" is selected in the setting
            "Default log type" above, the first custom log type in this table
            will be automatically selected as default log type.
          items:
            type: object
            required:
              - logType
            properties:
              logType:
                type: string
                title: Log Type
                pattern: ^[A-Z0-9_]+$
              description:
                type: string
                title: Description
        logType:
          type: string
          title: Default log type
          description: Default log type value to send to SecOps. Can be overwritten by
            event field __logType.
        logTextField:
          type: string
          title: Log text field
          description: Name of the event field that contains the log text to send. If not
            specified, Stream sends a JSON representation of the whole event.
        customerId:
          type: string
          title: Customer ID
          description: A unique identifier (UUID) for your Google SecOps instance. This is
            provided by your Google representative and is required for API V2
            authentication.
        namespace:
          type: string
          title: Namespace
          description: User-configured environment namespace to identify the data domain
            the logs originated from. Use namespace as a tag to identify the
            appropriate data domain for indexing and enrichment functionality.
            Can be overwritten by event field __namespace.
        customLabels:
          type: array
          title: Custom labels
          description: "Custom labels to be added to every batch "
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
              value:
                type: string
                title: Value
        udmType:
          type: string
          title: UDM type
          description: Defines the specific format for UDM events sent to Google SecOps.
            This must match the type of UDM data being sent.
          default: logs
          enum:
            - entities
            - logs
          x-speakeasy-unknown-values: allow
        apiKey:
          type: string
          title: API key
          description: Organization's API key in Google SecOps
        apiKeySecret:
          type: string
          title: API key (text secret)
          description: Select or create a stored text secret
        serviceAccountCredentials:
          type: string
          title: Service account credentials
          description: Contents of service account credentials (JSON keys) file downloaded
            from Google Cloud. To upload a file, click the upload button at this
            field's upper right.
        serviceAccountCredentialsSecret:
          type: string
          title: Service account credentials (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputGoogleCloudStorage:
      type: object
      required:
        - type
        - bucket
        - endpoint
        - region
        - stagePath
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - google_cloud_storage
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        bucket:
          type: string
          title: Bucket name
          description: "Name of the destination bucket. This value can be a constant or a
            JavaScript expression that can only be evaluated at init time.
            Example of referencing a Global Variable:
            `myBucket-${C.vars.myVar}`."
        region:
          type: string
          title: Region
          description: Region where the bucket is located
        endpoint:
          type: string
          title: Endpoint
          default: https://storage.googleapis.com
          description: Google Cloud Storage service endpoint
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing Google Cloud Storage requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          default: manual
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - auto
            - manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        destPath:
          type: string
          title: Key prefix
          description: "Prefix to prepend to files before uploading. Must be a JavaScript
            expression (which can evaluate to a constant value), enclosed in
            quotes or backticks. Can be evaluated only at init time. Example
            referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"
          default: ""
        verifyPermissions:
          type: boolean
          title: Verify if bucket exists
          description: Disable if you can access files within the bucket but not the
            bucket itself
          default: true
        objectACL:
          type: string
          title: Object ACL
          description: Object ACL to assign to uploaded objects
          default: private
          enum:
            - private
            - bucket-owner-read
            - bucket-owner-full-control
            - project-private
            - authenticated-read
            - public-read
          x-speakeasy-enum-descriptions:
            - private
            - bucket-owner-read
            - bucket-owner-full-control
            - project-private
            - authenticated-read
            - public-read
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - NEARLINE
            - COLDLINE
            - ARCHIVE
          x-speakeasy-enum-descriptions:
            - Standard Storage
            - Nearline Storage
            - Coldline Storage
            - Archive Storage
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized. Default is date-based. If blank, Stream will fall back to
            the event's __partition field value – if present – otherwise to each
            location's root directory.
          default: "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 1800
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 1800
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        description:
          type: string
          title: Description
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
        awsApiKey:
          type: string
          title: Access key
          description: HMAC access key. This value can be a constant or a JavaScript
            expression, such as `${C.env.GCS_ACCESS_KEY}`.
        awsSecretKey:
          type: string
          title: Secret
          description: HMAC secret. This value can be a constant or a JavaScript
            expression, such as `${C.env.GCS_SECRET}`.
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
    OutputGoogleCloudLogging:
      type: object
      required:
        - type
        - logLocationType
        - logLocationExpression
        - logNameExpression
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - google_cloud_logging
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        logLocationType:
          type: string
          title: Log location type
          x-speakeasy-enum-descriptions:
            - Project
            - Organization
            - Billing Account
            - Folder
          enum:
            - project
            - organization
            - billingAccount
            - folder
          x-speakeasy-unknown-values: allow
        logNameExpression:
          type: string
          title: Log name expression
          description: JavaScript expression to compute the value of the log name. If
            Validate and correct log name is enabled, invalid characters
            (characters other than alphanumerics, forward-slashes, underscores,
            hyphens, and periods) will be replaced with an underscore.
        sanitizeLogNames:
          type: boolean
          title: Validate and correct log name
          default: false
        payloadFormat:
          type: string
          title: Payload format
          description: Format to use when sending payload. Defaults to Text.
          enum:
            - text
            - json
          x-speakeasy-enum-descriptions:
            - Text
            - JSON
          default: text
          x-speakeasy-unknown-values: allow
        logLabels:
          type: array
          title: Log labels
          description: Labels to apply to the log entry
          items:
            type: object
            required:
              - label
              - valueExpression
            properties:
              label:
                type: string
                title: Label
                description: Label name
              valueExpression:
                type: string
                title: Value
                description: JavaScript expression to compute the label's value.
        resourceTypeExpression:
          type: string
          title: Resource type expression
          description: JavaScript expression to compute the value of the managed resource
            type field. Must evaluate to one of the valid values
            [here](https://cloud.google.com/logging/docs/api/v2/resource-list#resource-types).
            Defaults to "global".
        resourceTypeLabels:
          type: array
          title: Resource labels
          description: Labels to apply to the managed resource. These must correspond to
            the valid labels for the specified resource type (see
            [here](https://cloud.google.com/logging/docs/api/v2/resource-list#resource-types)).
            Otherwise, they will be dropped by Google Cloud Logging.
          items:
            type: object
            required:
              - label
              - valueExpression
            properties:
              label:
                type: string
                title: Label
                description: Label name
              valueExpression:
                type: string
                title: Value
                description: JavaScript expression to compute the label's value.
        severityExpression:
          type: string
          title: Severity expression
          description: JavaScript expression to compute the value of the severity field.
            Must evaluate to one of the severity values supported by Google
            Cloud Logging
            [here](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity)
            (case insensitive). Defaults to "DEFAULT".
        insertIdExpression:
          type: string
          title: Insert ID expression
          description: JavaScript expression to compute the value of the insert ID field.
        googleAuthMethod:
          type: string
          title: Google authentication method
          description: Choose Auto to use Google Application Default Credentials (ADC),
            Manual to enter Google service account credentials directly, or
            Secret to select or create a stored secret that references Google
            service account credentials.
          default: manual
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret
          x-speakeasy-unknown-values: allow
        serviceAccountCredentials:
          type: string
          title: Service account credentials
          description: Contents of service account credentials (JSON keys) file downloaded
            from Google Cloud. To upload a file, click the upload button at this
            field's upper right.
        secret:
          type: string
          title: Service account credentials (text secret)
          description: Select or create a stored text secret
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body.
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Max number of events to include in the request body. Default is 0
            (unlimited).
          default: 0
          minimum: 0
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Max record size.
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking.
          default: 5
          minimum: 1
          maximum: 32
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it.
        throttleRateReqPerSec:
          type: integer
          title: Throttle request rate
          description: Maximum number of requests to limit to per second.
          maximum: 2000
        requestMethodExpression:
          type: string
          title: Request method expression
          description: A JavaScript expression that evaluates to the HTTP request method
            as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        requestUrlExpression:
          type: string
          title: Request URL expression
          description: A JavaScript expression that evaluates to the HTTP request URL as a
            string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        requestSizeExpression:
          type: string
          title: Request size expression
          description: A JavaScript expression that evaluates to the HTTP request size as
            a string, in int64 format. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        statusExpression:
          type: string
          title: Request status expression
          description: A JavaScript expression that evaluates to the HTTP request method
            as a number. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        responseSizeExpression:
          type: string
          title: Response size expression
          description: A JavaScript expression that evaluates to the HTTP response size as
            a string, in int64 format. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        userAgentExpression:
          type: string
          title: Request user agent expression
          description: A JavaScript expression that evaluates to the HTTP request user
            agent as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        remoteIpExpression:
          type: string
          title: Remote IP expression
          description: A JavaScript expression that evaluates to the HTTP request remote
            IP as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        serverIpExpression:
          type: string
          title: Server IP expression
          description: A JavaScript expression that evaluates to the HTTP request server
            IP as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        refererExpression:
          type: string
          title: Referer expression
          description: A JavaScript expression that evaluates to the HTTP request referer
            as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        latencyExpression:
          type: string
          title: Latency expression
          description: A JavaScript expression that evaluates to the HTTP request latency,
            formatted as <seconds>.<nanoseconds>s (for example, 1.23s). See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        cacheLookupExpression:
          type: string
          title: Cache lookup expression
          description: A JavaScript expression that evaluates to the HTTP request cache
            lookup as a boolean. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        cacheHitExpression:
          type: string
          title: Cache hit expression
          description: A JavaScript expression that evaluates to the HTTP request cache
            hit as a boolean. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        cacheValidatedExpression:
          type: string
          title: Cache validated with origin server expression
          description: A JavaScript expression that evaluates to the HTTP request cache
            validated with origin server as a boolean. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        cacheFillBytesExpression:
          type: string
          title: Cache fill bytes expression
          description: A JavaScript expression that evaluates to the HTTP request cache
            fill bytes as a string, in int64 format. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        protocolExpression:
          type: string
          title: Protocol expression
          description: A JavaScript expression that evaluates to the HTTP request protocol
            as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest)
            for details.
        idExpression:
          type: string
          title: ID expression
          description: A JavaScript expression that evaluates to the log entry operation
            ID as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logentryoperation)
            for details.
        producerExpression:
          type: string
          title: Producer expression
          description: A JavaScript expression that evaluates to the log entry operation
            producer as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logentryoperation)
            for details.
        firstExpression:
          type: string
          title: First expression
          description: A JavaScript expression that evaluates to the log entry operation
            first flag as a boolean. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logentryoperation)
            for details.
        lastExpression:
          type: string
          title: Last expression
          description: A JavaScript expression that evaluates to the log entry operation
            last flag as a boolean. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logentryoperation)
            for details.
        fileExpression:
          type: string
          title: File expression
          description: A JavaScript expression that evaluates to the log entry source
            location file as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logentrysourcelocation)
            for details.
        lineExpression:
          type: string
          title: Line expression
          description: A JavaScript expression that evaluates to the log entry source
            location line as a string, in int64 format. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logentrysourcelocation)
            for details.
        functionExpression:
          type: string
          title: Function expression
          description: A JavaScript expression that evaluates to the log entry source
            location function as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logentrysourcelocation)
            for details.
        uidExpression:
          type: string
          title: UID expression
          description: A JavaScript expression that evaluates to the log entry log split
            UID as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logsplit)
            for details.
        indexExpression:
          type: string
          title: Index expression
          description: A JavaScript expression that evaluates to the log entry log split
            index as a number. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logsplit)
            for details.
        totalSplitsExpression:
          type: string
          title: Total splits expression
          description: A JavaScript expression that evaluates to the log entry log split
            total splits as a number. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logsplit)
            for details.
        traceExpression:
          type: string
          title: Trace expression
          description: A JavaScript expression that evaluates to the REST resource name of
            the trace being written as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)
            for details.
        spanIdExpression:
          type: string
          title: Span ID expression
          description: A JavaScript expression that evaluates to the ID of the cloud trace
            span associated with the current operation in which the log is being
            written as a string. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)
            for details.
        traceSampledExpression:
          type: string
          title: Trace sampled expression
          description: A JavaScript expression that evaluates to the the sampling decision
            of the span associated with the log entry. See the
            [documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)
            for details.
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        logLocationExpression:
          title: Folder ID expression
          description: JavaScript expression to compute the value of the folder ID with
            which log entries should be associated. If Validate and correct log
            name is enabled, invalid characters (characters other than
            alphanumerics, forward-slashes, underscores, hyphens, and periods)
            will be replaced with an underscore.
          type: string
        payloadExpression:
          title: Payload object expression
          description: JavaScript expression to compute the value of the payload. Must
            evaluate to a JavaScript object value. If an invalid value is
            encountered it will result in the default value instead. Defaults to
            the entire event.
          type: string
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputGooglePubsub:
      type: object
      required:
        - type
        - topicName
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - google_pubsub
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        topicName:
          type: string
          title: Topic ID
          description: ID of the topic to send events to.
        createTopic:
          type: boolean
          title: Create topic
          description: If enabled, create topic if it does not exist.
          default: false
        orderedDelivery:
          type: boolean
          title: Ordered delivery
          description: If enabled, send events in the order they were added to the queue.
            For this to work correctly, the process receiving events must have
            ordering enabled.
          default: false
        region:
          type: string
          title: Region
          description: Region to publish messages to. Select 'default' to allow Google to
            auto-select the nearest region. When using ordered delivery, the
            selected region must be allowed by message storage policy.
        googleAuthMethod:
          type: string
          title: Google authentication method
          description: Choose Auto to use Google Application Default Credentials (ADC),
            Manual to enter Google service account credentials directly, or
            Secret to select or create a stored secret that references Google
            service account credentials.
          default: manual
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret
          x-speakeasy-unknown-values: allow
        serviceAccountCredentials:
          type: string
          title: Service account credentials
          description: Contents of service account credentials (JSON keys) file downloaded
            from Google Cloud. To upload a file, click the upload button at this
            field's upper right.
        secret:
          type: string
          title: Service account credentials (text secret)
          description: Select or create a stored text secret
        batchSize:
          type: number
          title: Batch size
          minimum: 1
          maximum: 10000
          default: 1000
          description: The maximum number of items the Google API should batch before it
            sends them to the topic.
        batchTimeout:
          type: number
          title: Batch timeout (ms)
          minimum: 1
          maximum: 100000
          default: 100
          description: The maximum amount of time, in milliseconds, that the Google API
            should wait to send a batch (if the Batch size is not reached).
        maxQueueSize:
          type: number
          title: Queue size limit
          description: Maximum number of queued batches before blocking.
          default: 100
          minimum: 1
        maxRecordSizeKB:
          type: number
          title: Batch size limit (KB)
          description: Maximum size (KB) of batches to send.
          default: 256
          minimum: 1
          maximum: 256
        flushPeriod:
          title: Flush period (sec)
          description: Maximum time to wait before sending a batch (when batch size limit
            is not reached)
          type: number
          default: 1
        maxInProgress:
          type: number
          title: Concurrent request limit
          description: The maximum number of in-progress API requests before backpressure
            is applied.
          default: 10
          minimum: 1
          maximum: 100
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputExabeam:
      type: object
      required:
        - type
        - bucket
        - region
        - endpoint
        - stagePath
        - collectorInstanceId
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - exabeam
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        bucket:
          type: string
          title: Bucket name
          description: "Name of the destination bucket. A constant or a JavaScript
            expression that can only be evaluated at init time. Example of
            referencing a JavaScript Global Variable:
            `myBucket-${C.vars.myVar}`."
        region:
          type: string
          title: Region
          description: Region where the bucket is located
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        endpoint:
          type: string
          title: Endpoint
          default: https://storage.googleapis.com
          description: Google Cloud Storage service endpoint
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing Google Cloud Storage requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        objectACL:
          type: string
          title: Object ACL
          description: Object ACL to assign to uploaded objects
          default: private
          enum:
            - private
            - bucket-owner-read
            - bucket-owner-full-control
            - project-private
            - authenticated-read
            - public-read
          x-speakeasy-enum-descriptions:
            - private
            - bucket-owner-read
            - bucket-owner-full-control
            - project-private
            - authenticated-read
            - public-read
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - NEARLINE
            - COLDLINE
            - ARCHIVE
          x-speakeasy-enum-descriptions:
            - Standard Storage
            - Nearline Storage
            - Coldline Storage
            - Archive Storage
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 1800
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 1800
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 10
          maximum: 1024
          minimum: 5
        encodedConfiguration:
          type: string
          title: Exabeam connection string
          description: Enter an encoded string containing Exabeam configurations
        collectorInstanceId:
          type: string
          title: Collector instance ID
          description: >
            ID of the Exabeam Collector where data should be sent. Example:
            11112222-3333-4444-5555-666677778888
        siteName:
          type: string
          title: Site name
          description: Constant or JavaScript expression to create an Exabeam site name.
            Values that aren't successfully evaluated will be treated as string
            constants.
        siteId:
          type: string
          title: Site ID
          description: Exabeam site ID. If left blank, @{product} will use the value of
            the Exabeam site name.
        timezoneOffset:
          type: string
          title: Timezone offset
        awsApiKey:
          type: string
          title: Access key
          description: HMAC access key. Can be a constant or a JavaScript expression, such
            as `${C.env.GCS_ACCESS_KEY}`.
        awsSecretKey:
          type: string
          title: Secret
          description: HMAC secret. Can be a constant or a JavaScript expression, such as
            `${C.env.GCS_SECRET}`.
        description:
          type: string
          title: Description
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    OutputKafka:
      type: object
      required:
        - type
        - brokers
        - topic
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - kafka
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        brokers:
          type: array
          title: Bootstrap servers
          description: Enter each Kafka bootstrap server you want to use. Specify hostname
            and port, e.g., mykafkabroker:9092, or just hostname, in which case
            @{product} will assign port 9092.
          minItems: 1
          items:
            type: string
            minLength: 1
        topic:
          type: string
          title: Topic
          description: The topic to publish events to. Can be overridden using the
            __topicOut field.
        ack:
          type: integer
          default: 1
          title: Acknowledgments
          description: Control the number of required acknowledgments.
          enum:
            - 1
            - 0
            - -1
          x-speakeasy-enum-descriptions:
            - Leader
            - None
            - All
          x-speakeasy-unknown-values: allow
        format:
          type: string
          default: json
          enum:
            - json
            - raw
            - protobuf
          title: Record data format
          description: Format to use to serialize events before writing to Kafka.
          x-speakeasy-enum-descriptions:
            - JSON
            - Field _raw
            - Protobuf
          x-speakeasy-unknown-values: allow
        compression:
          type: string
          default: gzip
          enum:
            - none
            - gzip
            - snappy
            - lz4
            - zstd
          title: Compression
          description: Codec to use to compress the data before sending to Kafka
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
            - Snappy
            - LZ4
            - ZSTD
          x-speakeasy-unknown-values: allow
        maxRecordSizeKB:
          type: number
          default: 768
          minimum: 1
          title: Record size limit (KB, uncompressed)
          description: Maximum size of each record batch before compression. The value
            must not exceed the Kafka brokers' message.max.bytes setting.
        flushEventCount:
          type: number
          default: 1000
          minimum: 1
          maximum: 10000
          title: Events-per-batch limit
          description: The maximum number of events you want the Destination to allow in a
            batch before forcing a flush
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: The maximum amount of time you want the Destination to wait before
            forcing a flush. Shorter intervals tend to result in smaller batches
            being sent.
        kafkaSchemaRegistry:
          type: object
          title: Kafka Schema Registry Authentication
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            schemaRegistryURL:
              type: string
              title: Schema Registry URL
              description: "URL for accessing the Confluent Schema Registry. Example:
                http://localhost:8081. To connect over TLS, use https instead of
                http."
              default: http://localhost:8081
            connectionTimeout:
              type: number
              title: Connection timeout (ms)
              description: Maximum time to wait for a Schema Registry connection to complete
                successfully
              default: 30000
              minimum: 1000
              maximum: 60000
            requestTimeout:
              type: number
              title: Request timeout (ms)
              description: Maximum time to wait for the Schema Registry to respond to a
                request
              default: 30000
              minimum: 1000
              maximum: 60000
            maxRetries:
              type: number
              title: Retry limit
              description: Maximum number of times to try fetching schemas from the Schema
                Registry
              default: 1
              minimum: 0
              maximum: 100
            auth:
              type: object
              description: Credentials to use when authenticating with the schema registry
                using basic HTTP authentication
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                credentialsSecret:
                  type: string
                  title: Credentials secret
                  description: Select or create a secret that references your credentials
            tls:
              type: object
              title: TLS settings (client side)
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                rejectUnauthorized:
                  type: boolean
                  title: Validate server certs
                  description: >-
                    Reject certificates that are not authorized by a CA in the
                    CA certificate path, or by another 
                                        trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
                  default: true
                servername:
                  type: string
                  title: Server name (SNI)
                  description: Server name for the SNI (Server Name Indication) TLS extension. It
                    must be a host name, and not an IP address.
                certificateName:
                  type: string
                  title: Certificate
                  description: The name of the predefined certificate
                caPath:
                  type: string
                  title: CA certificate path
                  description: Path on client in which to find CA certificates to verify the
                    server's cert. PEM format. Can reference $ENV_VARS.
                privKeyPath:
                  type: string
                  title: Private key path (mutual auth)
                  description: Path on client in which to find the private key to use. PEM format.
                    Can reference $ENV_VARS.
                certPath:
                  type: string
                  title: Certificate path (mutual auth)
                  description: Path on client in which to find certificates to use. PEM format.
                    Can reference $ENV_VARS.
                passphrase:
                  type: string
                  title: Passphrase
                  description: Passphrase to use to decrypt private key
                minVersion:
                  type: string
                  title: Minimum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
                maxVersion:
                  type: string
                  title: Maximum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
            defaultKeySchemaId:
              type: number
              title: Default key schema ID
              description: Used when __keySchemaIdOut is not present, to transform key values,
                leave blank if key transformation is not required by default.
            defaultValueSchemaId:
              type: number
              title: Default value schema ID
              description: Used when __valueSchemaIdOut is not present, to transform _raw,
                leave blank if value transformation is not required by default.
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        sasl:
          type: object
          title: Authentication
          description: Authentication parameters to use when connecting to brokers. Using
            TLS is highly recommended.
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            authType:
              enum:
                - manual
                - secret
              title: Authentication method
              type: string
              default: manual
              description: Enter credentials directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            mechanism:
              enum:
                - plain
                - scram-sha-256
                - scram-sha-512
                - kerberos
              type: string
              default: plain
              x-speakeasy-enum-descriptions:
                - PLAIN
                - SCRAM-SHA-256
                - SCRAM-SHA-512
                - GSSAPI/Kerberos
              title: SASL mechanism
              x-speakeasy-unknown-values: allow
            keytabLocation:
              type: string
              title: Keytab Location
              description: Location of keytab file for authentication principal
            principal:
              type: string
              title: Principal
              description: Authentication principal, such as `kafka_user@example.com`
            brokerServiceClass:
              type: string
              title: Broker service class
              description: Kerberos service class for Kafka brokers, such as `kafka`
            oauthEnabled:
              type: boolean
              title: Enable OAuth
              description: Enable OAuth authentication
              default: false
            tokenUrl:
              type: string
              title: Token URL
              description: URL of the token endpoint to use for OAuth authentication
            clientId:
              type: string
              title: Client ID
              description: Client ID to use for OAuth authentication
            oauthSecretType:
              type: string
              default: secret
            clientTextSecret:
              type: string
              title: Client secret (text secret)
              description: Select or create a stored text secret
            oauthParams:
              type: array
              title: Add OAuth Parameters
              description: Additional fields to send to the token endpoint, such as scope or
                audience
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Parameter Name
                  value:
                    type: string
                    title: Parameter Value
            saslExtensions:
              type: array
              title: Add SASL Extension Fields
              description: Additional SASL extension fields, such as Confluent's
                logicalCluster or identityPoolId
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Field Name
                  value:
                    type: string
                    title: Field Value
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        protobufLibraryId:
          type: string
          title: Definition set
          description: Select a set of Protobuf definitions for the events you want to send
        protobufEncodingId:
          type: string
          title: Object type
          description: Select the type of object you want the Protobuf definitions to use
            for event encoding
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputConfluentCloud:
      type: object
      required:
        - type
        - brokers
        - topic
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - confluent_cloud
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        brokers:
          type: array
          title: Bootstrap servers
          description: List of Confluent Cloud bootstrap servers to use, such as
            yourAccount.confluent.cloud:9092.
          minItems: 1
          items:
            type: string
            minLength: 1
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        topic:
          type: string
          title: Topic
          description: The topic to publish events to. Can be overridden using the
            __topicOut field.
        ack:
          type: integer
          default: 1
          title: Acknowledgments
          description: Control the number of required acknowledgments.
          enum:
            - 1
            - 0
            - -1
          x-speakeasy-enum-descriptions:
            - Leader
            - None
            - All
          x-speakeasy-unknown-values: allow
        format:
          type: string
          default: json
          enum:
            - json
            - raw
            - protobuf
          title: Record data format
          description: Format to use to serialize events before writing to Kafka.
          x-speakeasy-enum-descriptions:
            - JSON
            - Field _raw
            - Protobuf
          x-speakeasy-unknown-values: allow
        compression:
          type: string
          default: gzip
          enum:
            - none
            - gzip
            - snappy
            - lz4
            - zstd
          title: Compression
          description: Codec to use to compress the data before sending to Kafka
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
            - Snappy
            - LZ4
            - ZSTD
          x-speakeasy-unknown-values: allow
        maxRecordSizeKB:
          type: number
          default: 768
          minimum: 1
          title: Record size limit (KB, uncompressed)
          description: Maximum size of each record batch before compression. The value
            must not exceed the Kafka brokers' message.max.bytes setting.
        flushEventCount:
          type: number
          default: 1000
          minimum: 1
          maximum: 10000
          title: Events-per-batch limit
          description: The maximum number of events you want the Destination to allow in a
            batch before forcing a flush
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: The maximum amount of time you want the Destination to wait before
            forcing a flush. Shorter intervals tend to result in smaller batches
            being sent.
        kafkaSchemaRegistry:
          type: object
          title: Kafka Schema Registry Authentication
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            schemaRegistryURL:
              type: string
              title: Schema Registry URL
              description: "URL for accessing the Confluent Schema Registry. Example:
                http://localhost:8081. To connect over TLS, use https instead of
                http."
              default: http://localhost:8081
            connectionTimeout:
              type: number
              title: Connection timeout (ms)
              description: Maximum time to wait for a Schema Registry connection to complete
                successfully
              default: 30000
              minimum: 1000
              maximum: 60000
            requestTimeout:
              type: number
              title: Request timeout (ms)
              description: Maximum time to wait for the Schema Registry to respond to a
                request
              default: 30000
              minimum: 1000
              maximum: 60000
            maxRetries:
              type: number
              title: Retry limit
              description: Maximum number of times to try fetching schemas from the Schema
                Registry
              default: 1
              minimum: 0
              maximum: 100
            auth:
              type: object
              description: Credentials to use when authenticating with the schema registry
                using basic HTTP authentication
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                credentialsSecret:
                  type: string
                  title: Credentials secret
                  description: Select or create a secret that references your credentials
            tls:
              type: object
              title: TLS settings (client side)
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                rejectUnauthorized:
                  type: boolean
                  title: Validate server certs
                  description: >-
                    Reject certificates that are not authorized by a CA in the
                    CA certificate path, or by another 
                                        trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
                  default: true
                servername:
                  type: string
                  title: Server name (SNI)
                  description: Server name for the SNI (Server Name Indication) TLS extension. It
                    must be a host name, and not an IP address.
                certificateName:
                  type: string
                  title: Certificate
                  description: The name of the predefined certificate
                caPath:
                  type: string
                  title: CA certificate path
                  description: Path on client in which to find CA certificates to verify the
                    server's cert. PEM format. Can reference $ENV_VARS.
                privKeyPath:
                  type: string
                  title: Private key path (mutual auth)
                  description: Path on client in which to find the private key to use. PEM format.
                    Can reference $ENV_VARS.
                certPath:
                  type: string
                  title: Certificate path (mutual auth)
                  description: Path on client in which to find certificates to use. PEM format.
                    Can reference $ENV_VARS.
                passphrase:
                  type: string
                  title: Passphrase
                  description: Passphrase to use to decrypt private key
                minVersion:
                  type: string
                  title: Minimum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
                maxVersion:
                  type: string
                  title: Maximum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
            defaultKeySchemaId:
              type: number
              title: Default key schema ID
              description: Used when __keySchemaIdOut is not present, to transform key values,
                leave blank if key transformation is not required by default.
            defaultValueSchemaId:
              type: number
              title: Default value schema ID
              description: Used when __valueSchemaIdOut is not present, to transform _raw,
                leave blank if value transformation is not required by default.
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        sasl:
          type: object
          title: Authentication
          description: Authentication parameters to use when connecting to brokers. Using
            TLS is highly recommended.
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            authType:
              enum:
                - manual
                - secret
              title: Authentication method
              type: string
              default: manual
              description: Enter credentials directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            mechanism:
              enum:
                - plain
                - scram-sha-256
                - scram-sha-512
                - kerberos
              type: string
              default: plain
              x-speakeasy-enum-descriptions:
                - PLAIN
                - SCRAM-SHA-256
                - SCRAM-SHA-512
                - GSSAPI/Kerberos
              title: SASL mechanism
              x-speakeasy-unknown-values: allow
            keytabLocation:
              type: string
              title: Keytab Location
              description: Location of keytab file for authentication principal
            principal:
              type: string
              title: Principal
              description: Authentication principal, such as `kafka_user@example.com`
            brokerServiceClass:
              type: string
              title: Broker service class
              description: Kerberos service class for Kafka brokers, such as `kafka`
            oauthEnabled:
              type: boolean
              title: Enable OAuth
              description: Enable OAuth authentication
              default: false
            tokenUrl:
              type: string
              title: Token URL
              description: URL of the token endpoint to use for OAuth authentication
            clientId:
              type: string
              title: Client ID
              description: Client ID to use for OAuth authentication
            oauthSecretType:
              type: string
              default: secret
            clientTextSecret:
              type: string
              title: Client secret (text secret)
              description: Select or create a stored text secret
            oauthParams:
              type: array
              title: Add OAuth Parameters
              description: Additional fields to send to the token endpoint, such as scope or
                audience
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Parameter Name
                  value:
                    type: string
                    title: Parameter Value
            saslExtensions:
              type: array
              title: Add SASL Extension Fields
              description: Additional SASL extension fields, such as Confluent's
                logicalCluster or identityPoolId
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Field Name
                  value:
                    type: string
                    title: Field Value
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        protobufLibraryId:
          type: string
          title: Definition set
          description: Select a set of Protobuf definitions for the events you want to send
        protobufEncodingId:
          type: string
          title: Object type
          description: Select the type of object you want the Protobuf definitions to use
            for event encoding
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputMsk:
      type: object
      required:
        - type
        - brokers
        - topic
        - region
        - awsAuthenticationMethod
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - msk
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        brokers:
          type: array
          title: Bootstrap servers
          description: Enter each Kafka bootstrap server you want to use. Specify hostname
            and port, e.g., mykafkabroker:9092, or just hostname, in which case
            @{product} will assign port 9092.
          minItems: 1
          items:
            type: string
            minLength: 1
        topic:
          type: string
          title: Topic
          description: The topic to publish events to. Can be overridden using the
            __topicOut field.
        ack:
          type: integer
          default: 1
          title: Acknowledgments
          description: Control the number of required acknowledgments.
          enum:
            - 1
            - 0
            - -1
          x-speakeasy-enum-descriptions:
            - Leader
            - None
            - All
          x-speakeasy-unknown-values: allow
        format:
          type: string
          default: json
          enum:
            - json
            - raw
            - protobuf
          title: Record data format
          description: Format to use to serialize events before writing to Kafka.
          x-speakeasy-enum-descriptions:
            - JSON
            - Field _raw
            - Protobuf
          x-speakeasy-unknown-values: allow
        compression:
          type: string
          default: gzip
          enum:
            - none
            - gzip
            - snappy
            - lz4
            - zstd
          title: Compression
          description: Codec to use to compress the data before sending to Kafka
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
            - Snappy
            - LZ4
            - ZSTD
          x-speakeasy-unknown-values: allow
        maxRecordSizeKB:
          type: number
          default: 768
          minimum: 1
          title: Record size limit (KB, uncompressed)
          description: Maximum size of each record batch before compression. The value
            must not exceed the Kafka brokers' message.max.bytes setting.
        flushEventCount:
          type: number
          default: 1000
          minimum: 1
          maximum: 10000
          title: Events-per-batch limit
          description: The maximum number of events you want the Destination to allow in a
            batch before forcing a flush
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: The maximum amount of time you want the Destination to wait before
            forcing a flush. Shorter intervals tend to result in smaller batches
            being sent.
        kafkaSchemaRegistry:
          type: object
          title: Kafka Schema Registry Authentication
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            schemaRegistryURL:
              type: string
              title: Schema Registry URL
              description: "URL for accessing the Confluent Schema Registry. Example:
                http://localhost:8081. To connect over TLS, use https instead of
                http."
              default: http://localhost:8081
            connectionTimeout:
              type: number
              title: Connection timeout (ms)
              description: Maximum time to wait for a Schema Registry connection to complete
                successfully
              default: 30000
              minimum: 1000
              maximum: 60000
            requestTimeout:
              type: number
              title: Request timeout (ms)
              description: Maximum time to wait for the Schema Registry to respond to a
                request
              default: 30000
              minimum: 1000
              maximum: 60000
            maxRetries:
              type: number
              title: Retry limit
              description: Maximum number of times to try fetching schemas from the Schema
                Registry
              default: 1
              minimum: 0
              maximum: 100
            auth:
              type: object
              description: Credentials to use when authenticating with the schema registry
                using basic HTTP authentication
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                credentialsSecret:
                  type: string
                  title: Credentials secret
                  description: Select or create a secret that references your credentials
            tls:
              type: object
              title: TLS settings (client side)
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                rejectUnauthorized:
                  type: boolean
                  title: Validate server certs
                  description: >-
                    Reject certificates that are not authorized by a CA in the
                    CA certificate path, or by another 
                                        trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
                  default: true
                servername:
                  type: string
                  title: Server name (SNI)
                  description: Server name for the SNI (Server Name Indication) TLS extension. It
                    must be a host name, and not an IP address.
                certificateName:
                  type: string
                  title: Certificate
                  description: The name of the predefined certificate
                caPath:
                  type: string
                  title: CA certificate path
                  description: Path on client in which to find CA certificates to verify the
                    server's cert. PEM format. Can reference $ENV_VARS.
                privKeyPath:
                  type: string
                  title: Private key path (mutual auth)
                  description: Path on client in which to find the private key to use. PEM format.
                    Can reference $ENV_VARS.
                certPath:
                  type: string
                  title: Certificate path (mutual auth)
                  description: Path on client in which to find certificates to use. PEM format.
                    Can reference $ENV_VARS.
                passphrase:
                  type: string
                  title: Passphrase
                  description: Passphrase to use to decrypt private key
                minVersion:
                  type: string
                  title: Minimum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
                maxVersion:
                  type: string
                  title: Maximum TLS version
                  enum:
                    - TLSv1
                    - TLSv1.1
                    - TLSv1.2
                    - TLSv1.3
                  x-speakeasy-unknown-values: allow
            defaultKeySchemaId:
              type: number
              title: Default key schema ID
              description: Used when __keySchemaIdOut is not present, to transform key values,
                leave blank if key transformation is not required by default.
            defaultValueSchemaId:
              type: number
              title: Default value schema ID
              description: Used when __valueSchemaIdOut is not present, to transform _raw,
                leave blank if value transformation is not required by default.
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the MSK cluster is located
        endpoint:
          type: string
          title: Endpoint
          description: MSK cluster service endpoint. If empty, defaults to the AWS
            Region-specific endpoint. Otherwise, it must point to MSK
            cluster-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing MSK cluster requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for MSK
          description: Use Assume Role credentials to access MSK
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        protobufLibraryId:
          type: string
          title: Definition set
          description: Select a set of Protobuf definitions for the events you want to send
        protobufEncodingId:
          type: string
          title: Object type
          description: Select the type of object you want the Protobuf definitions to use
            for event encoding
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputElastic:
      type: object
      required:
        - type
        - index
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - elastic
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        loadBalanced:
          type: boolean
          title: Load balancing
          description: Enable for optimal performance. Even if you have one hostname, it
            can expand to multiple IPs. If disabled, consider enabling
            round-robin DNS.
          default: true
        index:
          type: string
          title: Index or data stream
          description: Index or data stream to send events to. Must be a JavaScript
            expression (which can evaluate to a constant value), enclosed in
            quotes or backticks. Can be overwritten by an event's __index field.
        docType:
          type: string
          title: Type
          description: Document type to use for events. Can be overwritten by an event's
            __type field.
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 102400
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        extraParams:
          type: array
          title: Extra parameters
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
          default:
            - name: filter_path
              value: errors,items.*.error,items.*._index,items.*.status
        auth:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Authentication Disabled
              default: true
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            authType:
              enum:
                - manual
                - secret
                - manualAPIKey
                - textSecret
              title: Authentication method
              type: string
              default: manual
              description: Enter credentials directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            manualAPIKey:
              type: string
              title: API key
              description: Enter API key directly
            textSecret:
              type: string
              title: API key (text secret)
              description: Select or create a stored text secret
        elasticVersion:
          type: string
          title: Elastic version
          description: Optional Elasticsearch version, used to format events. If not
            specified, will auto-discover version.
          enum:
            - auto
            - "6"
            - "7"
          x-speakeasy-enum-descriptions:
            - Auto
            - 6.x
            - 7.x
          default: auto
          x-speakeasy-unknown-values: allow
        elasticPipeline:
          type: string
          title: Elastic pipeline
          description: Optional Elasticsearch destination pipeline
        includeDocId:
          type: boolean
          title: Include document _id
          description: Include the `document_id` field when sending events to an Elastic
            TSDS (time series data stream)
          default: false
        writeAction:
          type: string
          title: Write action
          description: Action to use when writing events. Must be set to `Create` when
            writing to a data stream.
          enum:
            - index
            - create
          x-speakeasy-enum-descriptions:
            - Index
            - Create
          default: create
          x-speakeasy-unknown-values: allow
        retryPartialErrors:
          type: boolean
          default: false
          title: Retry partial errors
          description: Retry failed events when a bulk request to Elastic is successful,
            but the response body returns an error for one or more events in the
            batch
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        url:
          type: string
          title: Bulk API URL or Cloud ID
          description: "The Cloud ID or URL to an Elastic cluster to send events to.
            Example: http://elastic:9200/_bulk"
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        urls:
          type: array
          title: Bulk API URLs
          description: ""
          minItems: 1
          items:
            type: object
            required:
              - url
            properties:
              url:
                type: string
                title: URL
                description: "The URL to an Elastic node to send events to. Example:
                  http://elastic:9200/_bulk"
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputElasticCloud:
      type: object
      required:
        - type
        - url
        - index
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - elastic_cloud
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: Cloud ID
          description: Enter Cloud ID of the Elastic Cloud environment to send events to
        index:
          type: string
          title: Data stream or index
          description: Data stream or index to send events to. Must be a JavaScript
            expression (which can evaluate to a constant value), enclosed in
            quotes or backticks. Can be overwritten by an event's __index field.
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 102400
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        extraParams:
          type: array
          title: Extra parameters
          description: Extra parameters to use in HTTP requests
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
          default:
            - name: filter_path
              value: errors,items.*.error,items.*._index,items.*.status
        auth:
          type: object
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Authentication Disabled
              default: false
            username:
              type: string
              title: Username
            password:
              type: string
              title: Password
            authType:
              enum:
                - manual
                - secret
                - manualAPIKey
                - textSecret
              title: Authentication method
              type: string
              default: manual
              description: Enter credentials directly, or select a stored secret
              x-speakeasy-unknown-values: allow
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
            manualAPIKey:
              type: string
              title: API key
              description: Enter API key directly
            textSecret:
              type: string
              title: API key (text secret)
              description: Select or create a stored text secret
        elasticPipeline:
          type: string
          title: Elastic pipeline
          description: Optional Elastic Cloud Destination pipeline
        includeDocId:
          type: boolean
          title: Include document _id
          description: Include the `document_id` field when sending events to an Elastic
            TSDS (time series data stream)
          default: true
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputNewrelic:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - newrelic
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        region:
          type: string
          title: Region
          description: Which New Relic region endpoint to use.
          enum:
            - US
            - EU
            - Custom
          x-speakeasy-enum-descriptions:
            - US
            - Europe
            - Custom
          default: US
          x-speakeasy-unknown-values: allow
        logType:
          type: string
          title: Log type
          description: "Name of the logtype to send with events, e.g.: observability,
            access_log. The event's 'sourcetype' field (if set) will override
            this value."
          default: ""
        messageField:
          type: string
          title: Log message field
          description: Name of field to send as log message value. If not present, event
            will be serialized and sent as JSON.
          default: ""
        metadata:
          type: array
          title: Fields
          description: Fields to add to events from this input
          maxItems: 4
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Field Name
                enum:
                  - service
                  - hostname
                  - timestamp
                  - auditId
                x-speakeasy-unknown-values: allow
              value:
                type: string
                title: Value
                description: JavaScript expression to compute field's value, enclosed in quotes
                  or backticks. (Can evaluate to a constant.)
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 1024
          minimum: 1
          maximum: 1024
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter API key directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        customUrl:
          type: string
          pattern: ^https?://.*
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        apiKey:
          type: string
          title: API key
          description: New Relic API key. Can be overridden using __newRelic_apiKey field.
        textSecret:
          type: string
          title: API key (text secret)
          description: Select or create a stored text secret
      required:
        - type
    OutputNewrelicEvents:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - newrelic_events
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        region:
          type: string
          title: Region
          description: Which New Relic region endpoint to use.
          enum:
            - US
            - EU
            - Custom
          x-speakeasy-enum-descriptions:
            - US
            - Europe
            - Custom
          default: US
          x-speakeasy-unknown-values: allow
        accountId:
          type: string
          title: Account ID
          description: New Relic account ID
        eventType:
          type: string
          title: Event type
          description: Default eventType to use when not present in an event. For more
            information, see
            [here](https://docs.newrelic.com/docs/telemetry-data-platform/custom-data/custom-events/data-requirements-limits-custom-event-data/#reserved-words).
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 1024
          minimum: 1
          maximum: 1024
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter API key directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        customUrl:
          type: string
          pattern: ^https?://.*
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        apiKey:
          type: string
          title: API key
          description: New Relic API key. Can be overridden using __newRelic_apiKey field.
        textSecret:
          type: string
          title: API key (text secret)
          description: Select or create a stored text secret
      required:
        - type
        - accountId
        - eventType
    OutputInfluxdb:
      type: object
      required:
        - type
        - url
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - influxdb
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: Write API URL
          description: URL of an InfluxDB cluster to send events to, e.g.,
            http://localhost:8086/write
          pattern: ^https?://.*
        useV2API:
          type: boolean
          title: Use v2 API
          description: The v2 API can be enabled with InfluxDB versions 1.8 and later.
          default: false
        timestampPrecision:
          type: string
          title: Timestamp precision
          description: Sets the precision for the supplied Unix time values. Defaults to
            milliseconds.
          enum:
            - ns
            - u
            - ms
            - s
            - m
            - h
          x-speakeasy-enum-descriptions:
            - Nanoseconds
            - Microseconds
            - Milliseconds
            - Seconds
            - Minutes
            - Hours
          default: ms
          x-speakeasy-unknown-values: allow
        dynamicValueFieldName:
          type: boolean
          title: Dynamic value fields
          description: Enabling this will pull the value field from the metric name. E,g,
            'db.query.user' will use 'db.query' as the measurement and 'user' as
            the value field.
          default: true
        valueFieldName:
          type: string
          title: Value field name
          description: Name of the field in which to store the metric when sending to
            InfluxDB. If dynamic generation is enabled and fails, this will be
            used as a fallback.
          default: value
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 51200
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          type: string
          title: Authentication type
          description: InfluxDB authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          default: none
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        database:
          type: string
          title: Database
          description: Database to write to.
        bucket:
          type: string
          title: Bucket
          description: Bucket to write to.
        org:
          type: string
          title: Organization
          description: Organization ID for this bucket.
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
    OutputCloudwatch:
      type: object
      required:
        - type
        - logGroupName
        - logStreamName
        - region
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - cloudwatch
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        logGroupName:
          type: string
          title: Log group name
          description: CloudWatch log group to associate events with
        logStreamName:
          type: string
          title: Log stream prefix
          description: "Prefix for CloudWatch log stream name. This prefix will be used to
            generate a unique log stream name per cribl instance, for example:
            myStream_myHost_myOutputId"
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the CloudWatchLogs is located
        endpoint:
          type: string
          title: Endpoint
          description: CloudWatchLogs service endpoint. If empty, defaults to the AWS
            Region-specific endpoint. Otherwise, it must point to
            CloudWatchLogs-compatible endpoint.
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for CloudWatchLogs
          description: Use Assume Role credentials to access CloudWatchLogs
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        maxQueueSize:
          type: number
          title: Queue size limit
          description: Maximum number of queued batches before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxRecordSizeKB:
          type: number
          title: Record size limit (KB, uncompressed)
          description: Maximum size (KB) of each individual record before compression. For
            non compressible data 1MB is the max recommended size
          default: 1024
          minimum: 1
          maximum: 10240
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Max record size.
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputMinio:
      type: object
      required:
        - type
        - bucket
        - stagePath
        - endpoint
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - minio
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        endpoint:
          type: string
          title: MinIO endpoint
          description: MinIO service url (e.g. http://minioHost:9000)
          pattern: ^https?://.*
        bucket:
          type: string
          title: MinIO bucket name
          description: "Name of the destination MinIO bucket. This value can be a constant
            or a JavaScript expression that can only be evaluated at init time.
            Example referencing a Global Variable: `myBucket-${C.vars.myVar}`"
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
          description: Secret key. This value can be a constant or a JavaScript
            expression, such as `${C.env.SOME_SECRET}`).
        region:
          type: string
          title: Region
          description: Region where the MinIO service/cluster is located
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        destPath:
          type: string
          title: Key prefix
          description: Root directory to prepend to path before uploading. Enter a
            constant, or a JavaScript expression enclosed in quotes or
            backticks.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing MinIO requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        objectACL:
          type: string
          title: Object ACL
          description: Object ACL to assign to uploaded objects
          default: private
          enum:
            - private
            - public-read
            - public-read-write
            - authenticated-read
            - aws-exec-read
            - bucket-owner-read
            - bucket-owner-full-control
          x-speakeasy-enum-descriptions:
            - Private
            - Public Read Only
            - Public Read/Write
            - Authenticated Read Only
            - AWS EC2 AMI Read Only
            - Bucket Owner Read Only
            - Bucket Owner Full Control
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - REDUCED_REDUNDANCY
          x-speakeasy-enum-descriptions:
            - Standard
            - Reduced Redundancy Storage
          x-speakeasy-unknown-values: allow
        serverSideEncryption:
          type: string
          title: Server-side encryption
          description: Server-side encryption for uploaded objects
          enum:
            - AES256
          x-speakeasy-enum-descriptions:
            - Amazon S3 Managed Key
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates)
          default: true
        verifyPermissions:
          type: boolean
          title: Verify if bucket exists
          description: Disable if you can access files within the bucket but not the
            bucket itself
          default: true
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized. Default is date-based. If blank, Stream will fall back to
            the event's __partition field value – if present – otherwise to each
            location's root directory.
          default: "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 86400
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 86400
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts limit
          description: Maximum number of parts to upload in parallel per file. Minimum
            part size is 5MB.
          default: 4
          minimum: 1
          maximum: 10
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: This value can be a constant or a JavaScript expression
            (`${C.env.SOME_ACCESS_KEY}`)
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    OutputStatsd:
      type: object
      required:
        - type
        - protocol
        - host
        - port
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - statsd
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        protocol:
          type: string
          default: udp
          enum:
            - udp
            - tcp
          title: Destination protocol
          description: Protocol to use when communicating with the destination.
          x-speakeasy-enum-descriptions:
            - UDP
            - TCP
          x-speakeasy-unknown-values: allow
        host:
          type: string
          title: Host
          description: The hostname of the destination.
        port:
          type: number
          title: Port
          minimum: 1
          maximum: 65535
          default: 8125
          description: Destination port.
        mtu:
          type: number
          default: 512
          minimum: 1
          maximum: 65535
          title: Record size limit (bytes)
          description: When protocol is UDP, specifies the maximum size of packets sent to
            the destination. Also known as the MTU for the network path to the
            destination system.
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: When protocol is TCP, specifies how often buffers should be
            flushed, resulting in records sent to the destination.
        dnsResolvePeriodSec:
          type: number
          default: 0
          minimum: 0
          maximum: 86400
          title: DNS resolution period (sec)
          description: How often to resolve the destination hostname to an IP address.
            Ignored if the destination is an IP address. A value of 0 means
            every batch sent will incur a DNS lookup.
        description:
          type: string
          title: Description
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputStatsdExt:
      type: object
      required:
        - type
        - protocol
        - host
        - port
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - statsd_ext
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        protocol:
          type: string
          default: udp
          enum:
            - udp
            - tcp
          title: Destination protocol
          description: Protocol to use when communicating with the destination.
          x-speakeasy-enum-descriptions:
            - UDP
            - TCP
          x-speakeasy-unknown-values: allow
        host:
          type: string
          title: Host
          description: The hostname of the destination.
        port:
          type: number
          title: Port
          minimum: 1
          maximum: 65535
          default: 8125
          description: Destination port.
        mtu:
          type: number
          default: 512
          minimum: 1
          maximum: 65535
          title: Record size limit (bytes)
          description: When protocol is UDP, specifies the maximum size of packets sent to
            the destination. Also known as the MTU for the network path to the
            destination system.
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: When protocol is TCP, specifies how often buffers should be
            flushed, resulting in records sent to the destination.
        dnsResolvePeriodSec:
          type: number
          default: 0
          minimum: 0
          maximum: 86400
          title: DNS resolution period (sec)
          description: How often to resolve the destination hostname to an IP address.
            Ignored if the destination is an IP address. A value of 0 means
            every batch sent will incur a DNS lookup.
        description:
          type: string
          title: Description
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputGraphite:
      type: object
      required:
        - type
        - protocol
        - host
        - port
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - graphite
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        protocol:
          type: string
          default: udp
          enum:
            - udp
            - tcp
          title: Destination protocol
          description: Protocol to use when communicating with the destination.
          x-speakeasy-enum-descriptions:
            - UDP
            - TCP
          x-speakeasy-unknown-values: allow
        host:
          type: string
          title: Host
          description: The hostname of the destination.
        port:
          type: number
          title: Port
          minimum: 1
          maximum: 65535
          default: 8125
          description: Destination port.
        mtu:
          type: number
          default: 512
          minimum: 1
          maximum: 65535
          title: Record size limit (bytes)
          description: When protocol is UDP, specifies the maximum size of packets sent to
            the destination. Also known as the MTU for the network path to the
            destination system.
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: When protocol is TCP, specifies how often buffers should be
            flushed, resulting in records sent to the destination.
        dnsResolvePeriodSec:
          type: number
          default: 0
          minimum: 0
          maximum: 86400
          title: DNS resolution period (sec)
          description: How often to resolve the destination hostname to an IP address.
            Ignored if the destination is an IP address. A value of 0 means
            every batch sent will incur a DNS lookup.
        description:
          type: string
          title: Description
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputRouter:
      type: object
      required:
        - type
        - rules
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - router
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        rules:
          type: array
          title: Rules
          description: Event routing rules
          minItems: 1
          items:
            type: object
            required:
              - filter
              - output
            properties:
              filter:
                type: string
                title: Filter Expression
                description: JavaScript expression to select events to send to output
              output:
                type: string
                title: Output
                description: Output to send matching events to
              description:
                type: string
                title: Description
                description: Description of this rule's purpose
              final:
                type: boolean
                title: Final
                description: Flag to control whether to stop the event from being checked
                  against other rules
                default: true
        description:
          type: string
          title: Description
    OutputSns:
      type: object
      required:
        - type
        - topicArn
        - messageGroupId
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - sns
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        topicArn:
          type: string
          title: Topic ARN
          description: "The ARN of the SNS topic to send events to. When a non-AWS URL is
            specified, format must be: '{url}/myQueueName'. E.g.,
            'https://host:port/myQueueName'. Must be a JavaScript expression
            (which can evaluate to a constant value), enclosed in quotes or
            backticks. Can be evaluated only at initialization time. Example
            referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`"
        messageGroupId:
          type: string
          title: Message Group ID
          description: "Messages in the same group are processed in a FIFO manner. Must be
            a JavaScript expression (which can evaluate to a constant value),
            enclosed in quotes or backticks. Can be evaluated only at init time.
            Example referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`."
        maxRetries:
          type: number
          title: Maximum number of retries
          description: Maximum number of retries before the output returns an error. Note
            that not all errors are retryable. The retries use an exponential
            backoff policy.
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: Region where the SNS is located
        endpoint:
          type: string
          title: Endpoint
          description: SNS service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to SNS-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing SNS requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for SNS
          description: Use Assume Role credentials to access SNS
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputSqs:
      type: object
      required:
        - type
        - queueName
        - queueType
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - sqs
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        queueName:
          type: string
          title: Queue Name
          description: "The name, URL, or ARN of the SQS queue to send events to. When a
            non-AWS URL is specified, format must be: '{url}/myQueueName'.
            Example: 'https://host:port/myQueueName'. Must be a JavaScript
            expression (which can evaluate to a constant value), enclosed in
            quotes or backticks. Can be evaluated only at init time. Example
            referencing a Global Variable:
            `https://host:port/myQueue-${C.vars.myVar}`."
        queueType:
          title: Queue Type
          type: string
          description: The queue type used (or created). Defaults to Standard.
          enum:
            - standard
            - fifo
          x-speakeasy-enum-descriptions:
            - Standard
            - FIFO
          x-speakeasy-unknown-values: allow
        awsAccountId:
          title: AWS account ID
          description: SQS queue owner's AWS account ID. Leave empty if SQS queue is in
            same AWS account.
          type: string
        messageGroupId:
          type: string
          title: Message Group ID
          description: This parameter applies only to FIFO queues. The tag that specifies
            that a message belongs to a specific message group. Messages that
            belong to the same message group are processed in a FIFO manner. Use
            event field __messageGroupId to override this value.
          default: cribl
        createQueue:
          type: boolean
          title: Create Queue
          description: Create queue if it does not exist.
          default: true
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
        region:
          type: string
          title: Region
          description: AWS Region where the SQS queue is located. Required, unless the
            Queue entry is a URL or ARN that includes a Region.
        endpoint:
          type: string
          title: Endpoint
          description: SQS service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to SQS-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing SQS requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for SQS
          description: Use Assume Role credentials to access SQS
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        maxQueueSize:
          type: number
          title: Queue size limit
          description: Maximum number of queued batches before blocking.
          default: 100
          minimum: 1
        maxRecordSizeKB:
          type: number
          title: Record size limit (KB)
          description: Maximum size (KB) of batches to send. Per the SQS spec, the max
            allowed value is 256 KB.
          default: 256
          minimum: 1
          maximum: 256
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Max record size.
        maxInProgress:
          type: number
          title: Concurrent request limit
          description: The maximum number of in-progress API requests before backpressure
            is applied.
          default: 10
          minimum: 1
          maximum: 100
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: ""
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputSnmp:
      type: object
      required:
        - type
        - hosts
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - snmp
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        hosts:
          type: array
          title: SNMP Trap Destinations
          description: One or more SNMP destinations to forward traps to
          minItems: 1
          items:
            type: object
            required:
              - host
              - port
            properties:
              host:
                type: string
                title: Address
                description: Destination host
              port:
                type: number
                title: Port
                maximum: 65535
                description: Destination port, default is 162
                default: 162
        dnsResolvePeriodSec:
          type: number
          default: 0
          minimum: 0
          maximum: 86400
          title: DNS resolution period (sec)
          description: How often to resolve the destination hostname to an IP address.
            Ignored if all destinations are IP addresses. A value of 0 means
            every trap sent will incur a DNS lookup.
        description:
          type: string
          title: Description
    OutputSumoLogic:
      type: object
      required:
        - type
        - url
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - sumo_logic
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: API URL
          description: Sumo Logic HTTP collector URL to which events should be sent
          pattern: ^https?://.*
        customSource:
          type: string
          title: Custom source name
          description: Override the source name configured on the Sumo Logic HTTP
            collector. This can also be overridden at the event level with the
            __sourceName field.
        customCategory:
          type: string
          title: Custom source category
          description: Override the source category configured on the Sumo Logic HTTP
            collector. This can also be overridden at the event level with the
            __sourceCategory field.
        format:
          type: string
          title: Data format
          description: Preserve the raw event format instead of JSONifying it
          enum:
            - json
            - raw
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
          default: json
          x-speakeasy-unknown-values: allow
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 1024
          minimum: 1
          maximum: 1024
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputDatadog:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - datadog
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        contentType:
          type: string
          title: Send logs as
          description: The content type to use when sending logs
          enum:
            - text
            - json
          x-speakeasy-enum-descriptions:
            - text/plain
            - application/json
          default: json
          x-speakeasy-unknown-values: allow
        message:
          type: string
          title: Message field
          description: Name of the event field that contains the message to send. If not
            specified, Stream sends a JSON representation of the whole event.
        source:
          type: string
          title: Source
          description: Name of the source to send with logs. When you send logs as JSON
            objects, the event's 'source' field (if set) will override this
            value.
        host:
          type: string
          title: Host
          description: Name of the host to send with logs. When you send logs as JSON
            objects, the event's 'host' field (if set) will override this value.
        service:
          type: string
          title: Service
          description: Name of the service to send with logs. When you send logs as JSON
            objects, the event's '__service' field (if set) will override this
            value.
        tags:
          type: array
          title: Datadog tags
          description: List of tags to send with logs, such as 'env:prod' and
            'env_staging:east'
          default: []
          items:
            type: string
        batchByTags:
          type: boolean
          title: Batch by tags
          description: Batch events by API key and the ddtags field on the event. When
            disabled, batches events only by API key. If incoming events have
            high cardinality in the ddtags field, disabling this setting may
            improve Destination performance.
          default: true
        allowApiKeyFromEvents:
          type: boolean
          title: Allow API key from events
          description: Allow API key to be set from the event's '__agent_api_key' field
          default: false
        severity:
          type: string
          title: Severity
          description: Default value for message severity. When you send logs as JSON
            objects, the event's '__severity' field (if set) will override this
            value.
          enum:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
            - debug
          x-speakeasy-enum-descriptions:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
            - debug
          x-speakeasy-unknown-values: allow
        site:
          type: string
          title: Datadog site
          description: Datadog site to which events should be sent
          default: us
          enum:
            - us
            - us3
            - us5
            - eu
            - fed1
            - ap1
            - custom
          x-speakeasy-enum-descriptions:
            - US
            - US3
            - US5
            - Europe
            - US1-FED
            - AP1
            - Custom
          x-speakeasy-unknown-values: allow
        sendCountersAsCount:
          type: boolean
          title: Send counter metrics as 'count'
          description: If not enabled, Datadog will transform 'counter' metrics to
            'gauge'. [Learn more about Datadog metrics
            types.](https://docs.datadoghq.com/metrics/types/?tab=count)
          default: false
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter API key directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        customUrl:
          type: string
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        apiKey:
          type: string
          title: API key
          description: Organization's API key in Datadog
        textSecret:
          type: string
          title: API key (text secret)
          description: Select or create a stored text secret
      required:
        - type
    OutputGrafanaCloud:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - grafana_cloud
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards. These fields are added as dimensions and labels to
            generated metrics and logs, respectively.
          default:
            - cribl_host
            - cribl_wp
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        lokiUrl:
          type: string
          title: Loki URL
          description: The endpoint to send logs to, such as
            https://logs-prod-us-central1.grafana.net
          pattern: ^https?://
        prometheusUrl:
          type: string
          title: Prometheus URL
          description: The remote_write endpoint to send Prometheus metrics to, such as
            https://prometheus-blocks-prod-us-central1.grafana.net/api/prom/push
          pattern: ^https?://
        message:
          type: string
          title: Logs message field
          description: Name of the event field that contains the message to send. If not
            specified, Stream sends a JSON representation of the whole event.
        messageFormat:
          type: string
          title: Message format
          description: Format to use when sending logs to Loki (Protobuf or JSON)
          enum:
            - protobuf
            - json
          x-speakeasy-enum-descriptions:
            - Protobuf
            - JSON
          default: protobuf
          x-speakeasy-unknown-values: allow
        labels:
          type: array
          title: Logs labels
          description: "List of labels to send with logs. Labels define Loki streams, so
            use static labels to avoid proliferating label value combinations
            and streams. Can be merged and/or overridden by the event's __labels
            field. Example: '__labels: {host: \"cribl.io\", level: \"error\"}'"
          minItems: 0
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                default: ""
              value:
                type: string
                title: Value
        metricRenameExpr:
          type: string
          title: Metrics renaming expression
          description: JavaScript expression that can be used to rename metrics. For
            example, name.replace(/\./g, '_') will replace all '.' characters in
            a metric's name with the supported '_' character. Use the 'name'
            global variable to access the metric's name. You can access event
            fields' values via __e.<fieldName>.
          default: name.replace(/[^a-zA-Z0-9_]/g, '_')
        prometheusAuth:
          type: object
          properties:
            authType:
              type: string
              title: Authentication type
              enum:
                - none
                - token
                - textSecret
                - basic
                - credentialsSecret
              x-speakeasy-enum-descriptions:
                - None
                - Auth token
                - Auth token (text secret)
                - Basic
                - Basic (credentials secret)
              default: basic
              x-speakeasy-unknown-values: allow
            token:
              type: string
              title: Auth token
              description: "Bearer token to include in the authorization header. In Grafana
                Cloud, this is generally built by concatenating the username and
                the API key, separated by a colon. Example:
                <your-username>:<your-api-key>"
            textSecret:
              type: string
              title: Auth token (text secret)
              description: Select or create a stored text secret
            username:
              type: string
              title: Username
              description: Username for authentication
            password:
              type: string
              title: Password
              description: Password (API key in Grafana Cloud domain) for authentication
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
        lokiAuth:
          type: object
          properties:
            authType:
              type: string
              title: Authentication type
              enum:
                - none
                - token
                - textSecret
                - basic
                - credentialsSecret
              x-speakeasy-enum-descriptions:
                - None
                - Auth token
                - Auth token (text secret)
                - Basic
                - Basic (credentials secret)
              default: basic
              x-speakeasy-unknown-values: allow
            token:
              type: string
              title: Auth token
              description: "Bearer token to include in the authorization header. In Grafana
                Cloud, this is generally built by concatenating the username and
                the API key, separated by a colon. Example:
                <your-username>:<your-api-key>"
            textSecret:
              type: string
              title: Auth token (text secret)
              description: Select or create a stored text secret
            username:
              type: string
              title: Username
              description: Username for authentication
            password:
              type: string
              title: Password
              description: Password (API key in Grafana Cloud domain) for authentication
            credentialsSecret:
              type: string
              title: Credentials secret
              description: Select or create a secret that references your credentials
        concurrency:
          type: number
          title: Request concurrency
          description: "Maximum number of ongoing requests before blocking. Warning:
            Setting this value > 1 can cause Loki and Prometheus to complain
            about entries being delivered out of order."
          default: 1
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: "Maximum size, in KB, of the request body. Warning: Setting this
            too low can increase the number of ongoing requests (depending on
            the value of 'Request concurrency'); this can cause Loki and
            Prometheus to complain about entries being delivered out of order."
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: "Maximum number of events to include in the request body. Default
            is 0 (unlimited). Warning: Setting this too low can increase the
            number of ongoing requests (depending on the value of 'Request
            concurrency'); this can cause Loki and Prometheus to complain about
            entries being delivered out of order."
          default: 0
          minimum: 0
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 15
          title: Flush period (sec)
          description: "Maximum time between requests. Small values could cause the
            payload size to be smaller than the configured Maximum time between
            requests. Small values can reduce the payload size below the
            configured 'Max record size' and 'Max events per request'. Warning:
            Setting this too low can increase the number of ongoing requests
            (depending on the value of 'Request concurrency'); this can cause
            Loki and Prometheus to complain about entries being delivered out of
            order."
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending. Applies only to JSON
            payloads; the Protobuf variant for both Prometheus and Loki are
            snappy-compressed by default.
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
      anyOf:
        - required:
            - lokiUrl
        - required:
            - prometheusUrl
      required:
        - type
    OutputLoki:
      type: object
      required:
        - type
        - url
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - loki
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards. These fields are added as labels to generated logs.
          default:
            - cribl_host
            - cribl_wp
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: Loki URL
          description: The endpoint to send logs to
          pattern: ^https?://.*
        message:
          type: string
          title: Logs message field
          description: Name of the event field that contains the message to send. If not
            specified, Stream sends a JSON representation of the whole event.
        messageFormat:
          type: string
          title: Message format
          description: Format to use when sending logs to Loki (Protobuf or JSON)
          enum:
            - protobuf
            - json
          x-speakeasy-enum-descriptions:
            - Protobuf
            - JSON
          default: protobuf
          x-speakeasy-unknown-values: allow
        labels:
          type: array
          title: Logs labels
          description: "List of labels to send with logs. Labels define Loki streams, so
            use static labels to avoid proliferating label value combinations
            and streams. Can be merged and/or overridden by the event's __labels
            field. Example: '__labels: {host: \"cribl.io\", level: \"error\"}'"
          minItems: 0
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                default: ""
              value:
                type: string
                title: Value
        authType:
          type: string
          title: Authentication type
          enum:
            - none
            - token
            - textSecret
            - basic
            - credentialsSecret
          x-speakeasy-enum-descriptions:
            - None
            - Auth token
            - Auth token (text secret)
            - Basic
            - Basic (credentials secret)
          default: none
          x-speakeasy-unknown-values: allow
        concurrency:
          type: number
          title: Request concurrency
          description: "Maximum number of ongoing requests before blocking. Warning:
            Setting this value > 1 can cause Loki to complain about entries
            being delivered out of order."
          default: 1
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: "Maximum size, in KB, of the request body. Warning: Setting this
            too low can increase the number of ongoing requests (depending on
            the value of 'Request concurrency'); this can cause Loki to complain
            about entries being delivered out of order."
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: "Maximum number of events to include in the request body. Defaults
            to 0 (unlimited). Warning: Setting this too low can increase the
            number of ongoing requests (depending on the value of 'Request
            concurrency'); this can cause Loki to complain about entries being
            delivered out of order."
          default: 0
          minimum: 0
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 15
          title: Flush period (sec)
          description: "Maximum time between requests. Small values could cause the
            payload size to be smaller than the configured Maximum time between
            requests. Small values can reduce the payload size below the
            configured 'Max record size' and 'Max events per request'. Warning:
            Setting this too low can increase the number of ongoing requests
            (depending on the value of 'Request concurrency'); this can cause
            Loki to complain about entries being delivered out of order."
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        enableDynamicHeaders:
          type: boolean
          title: Enable dynamic headers
          description: Add per-event HTTP headers from the __headers field to outgoing
            requests. Events with different headers are batched and sent
            separately.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        token:
          type: string
          title: Auth token
          description: "Bearer token to include in the authorization header. In Grafana
            Cloud, this is generally built by concatenating the username and the
            API key, separated by a colon. Example:
            <your-username>:<your-api-key>"
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
        username:
          type: string
          title: Username
          description: Username for authentication
        password:
          type: string
          title: Password
          description: Password (API key in Grafana Cloud domain) for authentication
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputPrometheus:
      type: object
      required:
        - type
        - url
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - prometheus
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards. These fields are added as dimensions to generated
            metrics.
          default:
            - cribl_host
            - cribl_wp
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: Remote Write URL
          description: The endpoint to send metrics to
          pattern: ^https?://.*
        metricRenameExpr:
          type: string
          title: Metric renaming expression
          description: JavaScript expression that can be used to rename metrics. For
            example, name.replace(/\./g, '_') will replace all '.' characters in
            a metric's name with the supported '_' character. Use the 'name'
            global variable to access the metric's name. You can access event
            fields' values via __e.<fieldName>.
          default: name.replace(/[^a-zA-Z0-9_]/g, '_')
        sendMetadata:
          type: boolean
          title: Send metadata
          description: Generate and send metadata (`type` and `metricFamilyName`) requests
          default: true
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          type: string
          title: Authentication type
          description: Remote Write authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          default: none
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        metricsFlushPeriodSec:
          type: number
          default: 60
          title: Metadata flush period (sec)
          description: How frequently metrics metadata is sent out. Value cannot be
            smaller than the base Flush period set above.
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
    OutputRing:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - ring
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        format:
          type: string
          title: Data format
          description: Format of the output data.
          enum:
            - json
            - raw
          default: json
          x-speakeasy-unknown-values: allow
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JS expression to define how files are partitioned and organized. If
            left blank, Cribl Stream will fallback on event.__partition.
        maxDataSize:
          type: string
          title: Data size limit
          description: "Maximum disk space allowed to be consumed (examples: 420MB, 4GB).
            When limit is reached, older data will be deleted."
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1GB
        maxDataTime:
          title: Data age limit
          type: string
          description: "Maximum amount of time to retain data (examples: 2h, 4d). When
            limit is reached, older data will be deleted."
          pattern: \d+[smhd]$
          default: 24h
        compress:
          type: string
          title: Data compression format
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        destPath:
          type: string
          title: Path location
          description: Path to use to write metrics. Defaults to $CRIBL_HOME/state/<id>
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
      required:
        - type
    OutputOpenTelemetry:
      type: object
      required:
        - type
        - endpoint
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - open_telemetry
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        protocol:
          type: string
          title: Protocol
          description: Select a transport option for OpenTelemetry
          enum:
            - grpc
            - http
          x-speakeasy-enum-descriptions:
            - gRPC
            - HTTP
          default: grpc
          x-speakeasy-unknown-values: allow
        endpoint:
          type: string
          title: Endpoint
          description: The endpoint where OTel events will be sent. Enter any valid URL or
            an IP address (IPv4 or IPv6; enclose IPv6 addresses in square
            brackets). Unspecified ports will default to 4317, unless the
            endpoint is an HTTPS-based URL or TLS is enabled, in which case 443
            will be used.
        otlpVersion:
          type: string
          title: OTLP version
          description: The version of OTLP Protobuf definitions to use when structuring
            data to send
          enum:
            - 0.10.0
            - 1.3.1
          x-speakeasy-enum-descriptions:
            - 0.10.0
            - 1.3.1
          default: 0.10.0
          x-speakeasy-unknown-values: allow
        compress:
          type: string
          title: Compression
          description: Type of compression to apply to messages sent to the OpenTelemetry
            endpoint
          enum:
            - none
            - deflate
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Deflate
            - Gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        httpCompress:
          type: string
          title: Compression
          description: Type of compression to apply to messages sent to the OpenTelemetry
            endpoint
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        authType:
          type: string
          title: Authentication type
          description: OpenTelemetry authentication type
          enum:
            - none
            - basic
            - credentialsSecret
            - token
            - textSecret
            - oauth
          default: none
          x-speakeasy-unknown-values: allow
        httpTracesEndpointOverride:
          type: string
          title: Traces endpoint override
          description: If you want to send traces to the default `{endpoint}/v1/traces`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        httpMetricsEndpointOverride:
          type: string
          title: Metrics endpoint override
          description: If you want to send metrics to the default `{endpoint}/v1/metrics`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        httpLogsEndpointOverride:
          type: string
          title: Logs endpoint override
          description: If you want to send logs to the default `{endpoint}/v1/logs`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        metadata:
          type: array
          title: Metadata
          description: List of key-value pairs to send with each gRPC request. Value
            supports JavaScript expressions that are evaluated just once, when
            the destination gets started. To pass credentials as metadata, use
            'C.Secret'.
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often the sender should ping the peer to keep the connection open
          minimum: 1
          default: 30
        keepAlive:
          type: boolean
          title: Keep alive
          description: Disable to close the connection immediately after sending the
            outgoing request
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputServiceNow:
      type: object
      required:
        - type
        - endpoint
        - protocol
        - otlpVersion
        - tokenSecret
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - service_now
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        endpoint:
          type: string
          title: Endpoint
          description: The endpoint where ServiceNow events will be sent. Enter any valid
            URL or an IP address (IPv4 or IPv6; enclose IPv6 addresses in square
            brackets)
          default: ingest.lightstep.com:443
        tokenSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
        authTokenName:
          type: string
          title: Auth token name
          default: lightstep-access-token
        otlpVersion:
          type: string
          title: OTLP version
          description: The version of OTLP Protobuf definitions to use when structuring
            data to send
          enum:
            - 1.3.1
          x-speakeasy-enum-descriptions:
            - 1.3.1
          default: 1.3.1
          x-speakeasy-unknown-values: allow
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 2048
          minimum: 1024
          maximum: 10240
        protocol:
          type: string
          title: Protocol
          description: Select a transport option for OpenTelemetry
          enum:
            - grpc
            - http
          x-speakeasy-enum-descriptions:
            - gRPC
            - HTTP
          default: grpc
          x-speakeasy-unknown-values: allow
        compress:
          type: string
          title: Compression
          description: Type of compression to apply to messages sent to the OpenTelemetry
            endpoint
          enum:
            - none
            - deflate
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Deflate
            - Gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        httpCompress:
          type: string
          title: Compression
          description: Type of compression to apply to messages sent to the OpenTelemetry
            endpoint
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        httpTracesEndpointOverride:
          type: string
          title: Traces endpoint override
          description: If you want to send traces to the default `{endpoint}/v1/traces`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        httpMetricsEndpointOverride:
          type: string
          title: Metrics endpoint override
          description: If you want to send metrics to the default `{endpoint}/v1/metrics`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        httpLogsEndpointOverride:
          type: string
          title: Logs endpoint override
          description: If you want to send logs to the default `{endpoint}/v1/logs`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        metadata:
          type: array
          title: Metadata
          description: List of key-value pairs to send with each gRPC request. Value
            supports JavaScript expressions that are evaluated just once, when
            the destination gets started. To pass credentials as metadata, use
            'C.Secret'.
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often the sender should ping the peer to keep the connection open
          minimum: 1
          default: 30
        keepAlive:
          type: boolean
          title: Keep alive
          description: Disable to close the connection immediately after sending the
            outgoing request
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputDataset:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - dataset
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        messageField:
          type: string
          title: Message field
          description: Name of the event field that contains the message or attributes to
            send. If not specified, all of the event's non-internal fields will
            be sent as attributes.
        excludeFields:
          type: array
          title: Exclude fields
          description: Fields to exclude from the event if the Message field is either
            unspecified or refers to an object. Ignored if the Message field is
            a string. If empty, we send all non-internal fields.
          default:
            - sev
            - _time
            - ts
            - thread
          items:
            type: string
        serverHostField:
          type: string
          title: Server/host field
          description: Name of the event field that contains the `serverHost` identifier.
            If not specified, defaults to `cribl_<outputId>`.
        timestampField:
          type: string
          title: Timestamp field
          description: Name of the event field that contains the timestamp. If not
            specified, defaults to `ts`, `_time`, or `Date.now()`, in that
            order.
        defaultSeverity:
          type: string
          title: Severity
          description: Default value for event severity. If the `sev` or `__severity`
            fields are set on an event, the first one matching will override
            this value.
          default: info
          enum:
            - finest
            - finer
            - fine
            - info
            - warning
            - error
            - fatal
          x-speakeasy-enum-descriptions:
            - 0 - finest
            - 1 - finer
            - 2 - fine
            - 3 - info
            - 4 - warning
            - 5 - error
            - 6 - fatal
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default:
            - httpStatus: 429
              initialBackoff: 1000
              backoffRate: 2
              maxBackoff: 10000
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: false
        site:
          type: string
          title: DataSet site
          description: DataSet site to which events should be sent
          default: us
          enum:
            - us
            - eu
            - custom
          x-speakeasy-enum-descriptions:
            - US
            - Europe
            - Custom
          x-speakeasy-unknown-values: allow
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 6144
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Enter API key directly, or select a stored secret
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        customUrl:
          type: string
          pattern: ^https?://.*
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        apiKey:
          type: string
          title: API key
          description: A 'Log Write Access' API key for the DataSet account
        textSecret:
          type: string
          title: API key (text secret)
          description: Select or create a stored text secret
      required:
        - type
    OutputCriblTcp:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - cribl_tcp
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        loadBalanced:
          type: boolean
          title: Load balancing
          description: Use load-balanced destinations
          default: true
        compression:
          type: string
          default: gzip
          enum:
            - none
            - gzip
          title: Compression
          description: Codec to use to compress the data before sending
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          x-speakeasy-unknown-values: allow
        logFailedRequests:
          type: boolean
          title: Log failed requests to disk
          description: Use to troubleshoot issues with sending data
          default: false
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        writeTimeout:
          type: number
          title: Write timeout
          description: Amount of time (milliseconds) to wait for a write to complete
            before assuming connection is dead
          default: 60000
        tokenTTLMinutes:
          type: number
          title: Auth Token TTL minutes
          default: 60
          minimum: 1
          maximum: 60
          description: The number of minutes before the internally generated
            authentication token expires, valid values between 1 and 60
        authTokens:
          type: array
          title: Connected environment tokens
          description: Shared secrets to be used by connected environments to authorize
            connections. These tokens should also be installed in Cribl TCP
            Source in Cribl.Cloud.
          items:
            type: object
            required:
              - tokenSecret
            properties:
              tokenSecret:
                type: string
                title: Token secret (text secret)
                description: Select or create a stored text secret
              enabled:
                type: boolean
                title: Enable token
                default: true
              description:
                type: string
                title: Description
                description: Optional token description
        excludeFields:
          type: array
          title: Exclude fields
          description: "Fields to exclude from the event. By default, all internal fields
            except `__output` are sent. Example: `cribl_pipe`, `c*`. Wildcards
            supported."
          default:
            - __kube_*
            - __metadata
            - __winEvent
          items:
            type: string
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        host:
          type: string
          title: Address
          description: The hostname of the receiver
        port:
          type: number
          title: Port
          maximum: 65535
          description: The port to connect to on the provided host
          default: 10300
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        hosts:
          type: array
          title: Destinations
          description: Set of hosts to load-balance data to
          minItems: 1
          items:
            type: object
            required:
              - host
              - port
            properties:
              host:
                type: string
                title: Address
                description: The hostname of the receiver
              port:
                type: number
                title: Port
                maximum: 65535
                description: The port to connect to on the provided host
                default: 10300
              tls:
                type: string
                title: TLS
                description: Whether to inherit TLS configs from group setting or disable TLS
                enum:
                  - inherit
                  - off
                default: inherit
                x-speakeasy-unknown-values: allow
              servername:
                type: string
                title: TLS Servername
                description: Servername to use if establishing a TLS connection. If not
                  specified, defaults to connection host (if not an IP);
                  otherwise, uses the global TLS settings.
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        maxConcurrentSenders:
          type: number
          default: 0
          minimum: 0
          title: Connection limit
          description: Maximum number of concurrent connections (per Worker Process). A
            random set of IPs will be picked on every DNS resolution period. Use
            0 for unlimited.
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
      required:
        - type
    OutputCriblHttp:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - cribl_http
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        loadBalanced:
          type: boolean
          title: Load balancing
          description: For optimal performance, enable load balancing even if you have one
            hostname, as it can expand to multiple IPs. If this setting is
            disabled, consider enabling round-robin DNS.
          default: true
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: >-
                Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another 
                                    trusted CA (such as the system's). Defaults to Enabled. Overrides the toggle from Advanced Settings, when also present.
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        tokenTTLMinutes:
          type: number
          title: Auth Token TTL minutes
          default: 60
          minimum: 1
          maximum: 60
          description: The number of minutes before the internally generated
            authentication token expires. Valid values are between 1 and 60.
        excludeFields:
          type: array
          title: Exclude fields
          description: "Fields to exclude from the event. By default, all internal fields
            except `__output` are sent. Example: `cribl_pipe`, `c*`. Wildcards
            supported."
          default:
            - __kube_*
            - __metadata
            - __winEvent
          items:
            type: string
        compression:
          type: string
          default: gzip
          enum:
            - none
            - gzip
          title: Compression
          description: Codec to use to compress the data before sending
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          x-speakeasy-unknown-values: allow
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        throttleRatePerSec:
          type: string
          title: Throttling
          description: "Rate (in bytes per second) to throttle while writing to an output.
            Accepts values with multiple-byte units, such as KB, MB, and GB.
            (Example: 42 MB) Default value of 0 specifies no throttling."
          pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
          default: "0"
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default:
            - httpStatus: 401
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
            - httpStatus: 408
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
            - httpStatus: 429
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
            - httpStatus: 500
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
            - httpStatus: 502
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
            - httpStatus: 503
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
            - httpStatus: 504
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
            - httpStatus: 509
              initialBackoff: 30000
              backoffRate: 2
              maxBackoff: 180000
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: true
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        authTokens:
          type: array
          title: Connected environment tokens
          description: Shared secrets to be used by connected environments to authorize
            connections. These tokens should also be installed in Cribl HTTP
            Source in Cribl.Cloud.
          items:
            type: object
            required:
              - tokenSecret
            properties:
              tokenSecret:
                type: string
                title: Token secret (text secret)
                description: Select or create a stored text secret
              enabled:
                type: boolean
                title: Enable token
                default: true
              description:
                type: string
                title: Description
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        url:
          type: string
          title: Cribl endpoint
          description: URL of a Cribl Worker to send events to, such as
            http://localhost:10200
          pattern: ^https?://.*
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        urls:
          type: array
          title: Cribl Worker endpoints
          description: ""
          minItems: 1
          items:
            type: object
            required:
              - url
            properties:
              url:
                type: string
                title: Cribl Endpoint
                description: URL of a Cribl Worker to send events to, such as
                  http://localhost:10200
                pattern: ^https?://.*
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
      required:
        - type
    OutputHumioHec:
      type: object
      required:
        - type
        - format
        - url
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - humio_hec
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: LogScale endpoint
          description: "URL to a CrowdStrike Falcon LogScale endpoint to send events to.
            Examples: https://cloud.us.humio.com/api/v1/ingest/hec for JSON and
            https://cloud.us.humio.com/api/v1/ingest/hec/raw for raw"
          default: https://cloud.us.humio.com/api/v1/ingest/hec
          pattern: ^https?://.*
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 32768
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: true
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        format:
          title: Request format
          type: string
          enum:
            - JSON
            - raw
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
          default: JSON
          description: When set to JSON, the event is automatically formatted with
            required fields before sending. When set to Raw, only the event's
            `_raw` value is sent.
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        token:
          type: string
          title: LogScale auth token
          description: CrowdStrike Falcon LogScale authentication token
        textSecret:
          type: string
          title: LogScale auth token (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputCrowdstrikeNextGenSiem:
      type: object
      required:
        - type
        - format
        - url
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - crowdstrike_next_gen_siem
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: Next-Gen SIEM endpoint
          description: |-
            URL provided from a CrowdStrike data connector. 
            Example: https://ingest.<region>.crowdstrike.com/api/ingest/hec/<connection-id>/v1/services/collector
          pattern: ^https?://.*
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 32768
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: true
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        format:
          title: Request format
          type: string
          enum:
            - JSON
            - raw
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
          default: JSON
          description: When set to JSON, the event is automatically formatted with
            required fields before sending. When set to Raw, only the event's
            `_raw` value is sent.
          x-speakeasy-unknown-values: allow
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        token:
          type: string
          title: Next-Gen SIEM authentication token
        textSecret:
          type: string
          title: Next-Gen SIEM authentication token (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputDlS3:
      type: object
      required:
        - type
        - bucket
        - stagePath
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - dl_s3
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        bucket:
          type: string
          title: S3 bucket name
          description: "Name of the destination S3 bucket. Must be a JavaScript expression
            (which can evaluate to a constant value), enclosed in quotes or
            backticks. Can be evaluated only at initialization time. Example
            referencing a Global Variable: `myBucket-${C.vars.myVar}`"
        region:
          type: string
          title: Region
          description: Region where the S3 bucket is located
        awsSecretKey:
          type: string
          title: Secret key
          description: "Secret key. This value can be a constant or a JavaScript
            expression. Example: `${C.env.SOME_SECRET}`)"
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        endpoint:
          type: string
          title: Endpoint
          description: S3 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to S3-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing S3 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for S3
          description: Use Assume Role credentials to access S3
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        destPath:
          type: string
          title: Key prefix
          description: "Prefix to prepend to files before uploading. Must be a JavaScript
            expression (which can evaluate to a constant value), enclosed in
            quotes or backticks. Can be evaluated only at init time. Example
            referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"
          default: ""
        objectACL:
          type: string
          title: Object ACL
          description: Object ACL to assign to uploaded objects
          default: private
          enum:
            - private
            - public-read
            - public-read-write
            - authenticated-read
            - aws-exec-read
            - bucket-owner-read
            - bucket-owner-full-control
          x-speakeasy-enum-descriptions:
            - Private
            - Public Read Only
            - Public Read/Write
            - Authenticated Read Only
            - AWS EC2 AMI Read Only
            - Bucket Owner Read Only
            - Bucket Owner Full Control
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - REDUCED_REDUNDANCY
            - STANDARD_IA
            - ONEZONE_IA
            - INTELLIGENT_TIERING
            - GLACIER
            - GLACIER_IR
            - DEEP_ARCHIVE
          x-speakeasy-enum-descriptions:
            - Standard
            - Reduced Redundancy Storage
            - Standard, Infrequent Access
            - One Zone, Infrequent Access
            - Intelligent Tiering
            - Glacier Flexible Retrieval
            - Glacier Instant Retrieval
            - Glacier Deep Archive
          x-speakeasy-unknown-values: allow
        serverSideEncryption:
          type: string
          title: Server-side encryption for uploaded objects
          enum:
            - AES256
            - aws:kms
          x-speakeasy-enum-descriptions:
            - Amazon S3 Managed Key
            - AWS KMS Managed Key
          x-speakeasy-unknown-values: allow
        kmsKeyId:
          type: string
          title: KMS key ID
          description: ID or ARN of the KMS customer-managed key to use for encryption
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 86400
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 86400
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts upload limit
          description: Maximum number of parts to upload in parallel per file. Minimum
            part size is 5MB.
          default: 4
          minimum: 1
          maximum: 10
        verifyPermissions:
          type: boolean
          title: Verify if bucket exists
          description: Disable if you can access files within the bucket but not the
            bucket itself
          default: true
        maxClosingFilesToBackpressure:
          type: number
          title: Staging file limit
          description: Maximum number of files that can be waiting for upload before
            backpressure is applied
          default: 100
          minimum: 10
          maximum: 4200
        partitioningFields:
          type: array
          title: Partition by fields
          description: List of fields to partition the path by, in addition to time, which
            is included automatically. The effective partition will be
            YYYY/MM/DD/HH/<list/of/fields>.
          default: []
          items:
            type: string
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: This value can be a constant or a JavaScript expression
            (`${C.env.SOME_ACCESS_KEY}`)
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    OutputSecurityLake:
      type: object
      required:
        - type
        - bucket
        - stagePath
        - region
        - accountId
        - customSource
        - assumeRoleArn
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - security_lake
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards. These fields are added as dimensions and labels to
            generated metrics and logs, respectively.
          default: []
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        bucket:
          type: string
          title: S3 bucket name
          description: "Name of the destination S3 bucket. Must be a JavaScript expression
            (which can evaluate to a constant value), enclosed in quotes or
            backticks. Can be evaluated only at initialization time. Example
            referencing a Global Variable: `myBucket-${C.vars.myVar}`"
        region:
          type: string
          title: Region
          description: Region where the Amazon Security Lake is located.
        awsSecretKey:
          type: string
          title: Secret key
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - manual
            - secret
          x-speakeasy-enum-descriptions:
            - Auto
            - Manual
            - Secret Key pair
          x-speakeasy-unknown-values: allow
        endpoint:
          type: string
          title: Endpoint
          description: Amazon Security Lake service endpoint. If empty, defaults to the
            AWS Region-specific endpoint. Otherwise, it must point to Amazon
            Security Lake-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing Amazon Security Lake requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for S3
          description: Use Assume Role credentials to access S3
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        objectACL:
          type: string
          title: Object ACL
          description: Object ACL to assign to uploaded objects
          default: private
          enum:
            - private
            - public-read
            - public-read-write
            - authenticated-read
            - aws-exec-read
            - bucket-owner-read
            - bucket-owner-full-control
          x-speakeasy-enum-descriptions:
            - Private
            - Public Read Only
            - Public Read/Write
            - Authenticated Read Only
            - AWS EC2 AMI Read Only
            - Bucket Owner Read Only
            - Bucket Owner Full Control
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - REDUCED_REDUNDANCY
            - STANDARD_IA
            - ONEZONE_IA
            - INTELLIGENT_TIERING
            - GLACIER
            - GLACIER_IR
            - DEEP_ARCHIVE
          x-speakeasy-enum-descriptions:
            - Standard
            - Reduced Redundancy Storage
            - Standard, Infrequent Access
            - One Zone, Infrequent Access
            - Intelligent Tiering
            - Glacier Flexible Retrieval
            - Glacier Instant Retrieval
            - Glacier Deep Archive
          x-speakeasy-unknown-values: allow
        serverSideEncryption:
          type: string
          title: Server-side encryption for uploaded objects
          enum:
            - AES256
            - aws:kms
          x-speakeasy-enum-descriptions:
            - Amazon S3 Managed Key
            - AWS KMS Managed Key
          x-speakeasy-unknown-values: allow
        kmsKeyId:
          type: string
          title: KMS key ID
          description: ID or ARN of the KMS customer-managed key to use for encryption
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 86400
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 86400
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts upload limit
          description: Maximum number of parts to upload in parallel per file. Minimum
            part size is 5MB.
          default: 4
          minimum: 1
          maximum: 10
        verifyPermissions:
          type: boolean
          title: Verify if bucket exists
          description: Disable if you can access files within the bucket but not the
            bucket itself
          default: true
        maxClosingFilesToBackpressure:
          type: number
          title: Staging file limit
          description: Maximum number of files that can be waiting for upload before
            backpressure is applied
          default: 100
          minimum: 10
          maximum: 4200
        accountId:
          type: string
          title: Account ID
          description: ID of the AWS account whose data the Destination will write to
            Security Lake. This should have been configured when creating the
            Amazon Security Lake custom source.
        customSource:
          type: string
          title: Custom source name
          description: Name of the custom source configured in Amazon Security Lake
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: This value can be a constant or a JavaScript expression
            (`${C.env.SOME_ACCESS_KEY}`)
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    OutputCriblLake:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - cribl_lake
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        bucket:
          type: string
          title: S3 bucket name
          description: "Name of the destination S3 bucket. Must be a JavaScript expression
            (which can evaluate to a constant value), enclosed in quotes or
            backticks. Can be evaluated only at initialization time. Example
            referencing a Global Variable: `myBucket-${C.vars.myVar}`"
        region:
          type: string
          title: Region
          description: Region where the S3 bucket is located
        awsSecretKey:
          type: string
          title: Secret key
          description: "Secret key. This value can be a constant or a JavaScript
            expression. Example: `${C.env.SOME_SECRET}`)"
        endpoint:
          type: string
          title: Endpoint
          description: S3 service endpoint. If empty, defaults to the AWS Region-specific
            endpoint. Otherwise, it must point to S3-compatible endpoint.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing S3 requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates
          default: true
        enableAssumeRole:
          type: boolean
          title: Enable for S3
          description: Use Assume Role credentials to access S3
          default: false
        assumeRoleArn:
          type: string
          title: AssumeRole ARN
          description: Amazon Resource Name (ARN) of the role to assume
          pattern: "^arn:"
          minLength: 20
        assumeRoleExternalId:
          type: string
          title: External ID
          description: External ID to use when assuming role
        durationSeconds:
          type: number
          title: Duration (seconds)
          description: Duration of the assumed role's session, in seconds. Minimum is 900
            (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12
            hours).
          minimum: 900
          maximum: 43200
          default: 3600
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant and stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        destPath:
          type: string
          title: Lake dataset
          description: Lake dataset to send the data to.
        objectACL:
          type: string
          title: Object ACL
          description: Object ACL to assign to uploaded objects
          default: private
          enum:
            - private
            - public-read
            - public-read-write
            - authenticated-read
            - aws-exec-read
            - bucket-owner-read
            - bucket-owner-full-control
          x-speakeasy-enum-descriptions:
            - Private
            - Public Read Only
            - Public Read/Write
            - Authenticated Read Only
            - AWS EC2 AMI Read Only
            - Bucket Owner Read Only
            - Bucket Owner Full Control
          x-speakeasy-unknown-values: allow
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - REDUCED_REDUNDANCY
            - STANDARD_IA
            - ONEZONE_IA
            - INTELLIGENT_TIERING
            - GLACIER
            - GLACIER_IR
            - DEEP_ARCHIVE
          x-speakeasy-enum-descriptions:
            - Standard
            - Reduced Redundancy Storage
            - Standard, Infrequent Access
            - One Zone, Infrequent Access
            - Intelligent Tiering
            - Glacier Flexible Retrieval
            - Glacier Instant Retrieval
            - Glacier Deep Archive
          x-speakeasy-unknown-values: allow
        serverSideEncryption:
          type: string
          title: Server-side encryption for uploaded objects
          enum:
            - AES256
            - aws:kms
          x-speakeasy-enum-descriptions:
            - Amazon S3 Managed Key
            - AWS KMS Managed Key
          x-speakeasy-unknown-values: allow
        kmsKeyId:
          type: string
          title: KMS key ID
          description: ID or ARN of the KMS customer-managed key to use for encryption
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 64
          maximum: 1024
          minimum: 5
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 86400
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 300
          minimum: 5
          maximum: 86400
        verifyPermissions:
          type: boolean
          title: Verify if bucket exists
          description: Disable if you can access files within the bucket but not the
            bucket itself
          default: true
        maxClosingFilesToBackpressure:
          type: number
          title: Staging file limit
          description: Maximum number of files that can be waiting for upload before
            backpressure is applied
          default: 100
          minimum: 10
          maximum: 4200
        awsAuthenticationMethod:
          type: string
          default: auto
          enum:
            - auto
            - auto_rpc
            - manual
          x-speakeasy-unknown-values: allow
        format:
          type: string
          enum:
            - json
            - parquet
            - ddss
          x-speakeasy-unknown-values: allow
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts limit
          description: Maximum number of parts to upload in parallel per file. Minimum
            part size is 5MB.
          default: 1
          minimum: 1
          maximum: 10
        description:
          type: string
          title: Description
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
      required:
        - type
    OutputDiskSpool:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - disk_spool
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        timeWindow:
          type: string
          title: Bucket time span
          description: Time period for grouping spooled events. Default is 10m.
          default: 10m
        maxDataSize:
          type: string
          title: Data size limit
          description: "Maximum disk space that can be consumed before older buckets are
            deleted. Examples: 420MB, 4GB. Default is 1GB."
          pattern: ^\d+(\.\d+)?\s*(?:[kmgKMG](b|B))?$
          default: 1GB
        maxDataTime:
          title: Data age limit
          type: string
          description: "Maximum amount of time to retain data before older buckets are
            deleted. Examples: 2h, 4d. Default is 24h."
          pattern: \d+[smhd]$
          default: 24h
        compress:
          type: string
          title: Compression
          description: Data compression format. Default is gzip.
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized within the time-buckets. If blank, the event's __partition
            property is used and otherwise, events go directly into the
            time-bucket directory.
        description:
          type: string
          title: Description
      required:
        - type
    OutputClickHouse:
      type: object
      required:
        - type
        - database
        - tableName
        - url
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - click_house
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        url:
          type: string
          title: URL
          description: "URL of the ClickHouse instance. Example: http://localhost:8123/"
        authType:
          type: string
          title: Authentication type
          description: ""
          enum:
            - none
            - basic
            - credentialsSecret
            - sslUserCertificate
            - token
            - textSecret
            - oauth
          default: none
          x-speakeasy-unknown-values: allow
        database:
          type: string
          title: ClickHouse database
        tableName:
          type: string
          title: ClickHouse table
          description: Name of the ClickHouse table where data will be inserted. Name can
            contain letters (A-Z, a-z), numbers (0-9), and the character "_",
            and must start with either a letter or the character "_".
          pattern: ^[a-zA-Z_][0-9a-zA-Z_]*$
        format:
          type: string
          title: Format
          description: Data format to use when sending data to ClickHouse. Defaults to
            JSON Compact.
          enum:
            - json-compact-each-row-with-names
            - json-each-row
          x-speakeasy-enum-descriptions:
            - JSONCompactEachRowWithNames
            - JSONEachRow
          default: json-compact-each-row-with-names
          x-speakeasy-unknown-values: allow
        mappingType:
          type: string
          title: Mapping type
          description: How event fields are mapped to ClickHouse columns.
          enum:
            - automatic
            - custom
          x-speakeasy-enum-descriptions:
            - Automatic
            - Custom
          default: automatic
          x-speakeasy-unknown-values: allow
        asyncInserts:
          type: boolean
          title: Async inserts
          description: Collect data into batches for later processing. Disable to write to
            a ClickHouse table immediately.
          default: false
        tls:
          type: object
          title: TLS settings (client side)
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: true
            servername:
              type: string
              title: Server name (SNI)
              description: Server name for the SNI (Server Name Indication) TLS extension. It
                must be a host name, and not an IP address.
            certificateName:
              type: string
              title: Certificate
              description: The name of the predefined certificate
            caPath:
              type: string
              title: CA certificate path
              description: Path on client in which to find CA certificates to verify the
                server's cert. PEM format. Can reference $ENV_VARS.
            privKeyPath:
              type: string
              title: Private key path (mutual auth)
              description: Path on client in which to find the private key to use. PEM format.
                Can reference $ENV_VARS.
            certPath:
              type: string
              title: Certificate path (mutual auth)
              description: Path on client in which to find certificates to use. PEM format.
                Can reference $ENV_VARS.
            passphrase:
              type: string
              title: Passphrase
              description: Passphrase to use to decrypt private key
            minVersion:
              type: string
              title: Minimum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
            maxVersion:
              type: string
              title: Maximum TLS version
              enum:
                - TLSv1
                - TLSv1.1
                - TLSv1.2
                - TLSv1.3
              x-speakeasy-unknown-values: allow
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 10240
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        dumpFormatErrorsToDisk:
          type: boolean
          title: Log last schema mismatch
          description: Log the most recent event that fails to match the table schema
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        credentialsSecret:
          type: string
          title: Credentials secret
          description: Select or create a secret that references your credentials
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        loginUrl:
          type: string
          title: Login URL
          description: URL for OAuth
          pattern: ^https?://.*
        secretParamName:
          type: string
          title: OAuth Secret parameter name
          description: Secret parameter name to pass in request body
        secret:
          type: string
          title: OAuth secret
          description: Secret parameter value to pass in request body
        tokenAttributeName:
          type: string
          title: Token attribute name
          description: Name of the auth token attribute in the OAuth response. Can be
            top-level (e.g., 'token'); or nested, using a period (e.g.,
            'data.token').
        authHeaderExpr:
          type: string
          title: Authorize expression
          description: "JavaScript expression to compute the Authorization header value to
            pass in requests. The value `${token}` is used to reference the
            token obtained from authentication, e.g.: `Bearer ${token}`."
          default: "`Bearer ${token}`"
        tokenTimeoutSecs:
          type: number
          title: Refresh interval (secs.)
          description: How often the OAuth token should be refreshed.
          minimum: 1
          maximum: 300000
          default: 3600
        oauthParams:
          type: array
          title: OAuth parameters
          description: Additional parameters to send in the OAuth login request.
            @{product} will combine the secret with these parameters, and will
            send the URL-encoded result in a POST request to the endpoint
            specified in the 'Login URL'. We'll automatically add the
            content-type header 'application/x-www-form-urlencoded' when sending
            this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth parameter name
              value:
                type: string
                title: Value
                description: OAuth parameter value
        oauthHeaders:
          type: array
          title: OAuth headers
          description: Additional headers to send in the OAuth login request. @{product}
            will automatically add the content-type header
            'application/x-www-form-urlencoded' when sending this request.
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                title: Name
                description: OAuth header name
              value:
                type: string
                title: Value
                description: OAuth header value
        sqlUsername:
          type: string
          title: Username
          description: Username for certificate authentication
        waitForAsyncInserts:
          type: boolean
          title: Wait for async inserts
          description: Cribl will wait for confirmation that data has been fully inserted
            into the ClickHouse database before proceeding. Disabling this
            option can increase throughput, but Cribl won’t be able to verify
            data has been completely inserted.
          default: true
        excludeMappingFields:
          type: array
          title: Exclude fields
          description: Fields to exclude from sending to ClickHouse
          minItems: 0
          default: []
          items:
            type: string
            minLength: 0
        describeTable:
          type: string
          title: Retrieve table columns
          description: Retrieves the table schema from ClickHouse and populates the Column
            Mapping table
        columnMappings:
          type: array
          title: Column Mapping
          description: ""
          items:
            type: object
            required:
              - columnName
              - columnValueExpression
            properties:
              columnName:
                type: string
                title: Column name
                description: Name of the column in ClickHouse that will store field value
              columnType:
                type: string
                title: Column type
                description: Type of the column in the ClickHouse database
              columnValueExpression:
                type: string
                title: Column value
                description: JavaScript expression to compute value to be inserted into
                  ClickHouse table
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputXsiam:
      type: object
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - xsiam
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        loadBalanced:
          type: boolean
          title: Load balancing
          description: Enable for optimal performance. Even if you have one hostname, it
            can expand to multiple IPs. If disabled, consider enabling
            round-robin DNS.
          default: false
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 10000
          minimum: 100
          maximum: 10000
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        authType:
          title: Authentication method
          type: string
          enum:
            - token
            - secret
          default: token
          description: Enter a token directly, or provide a secret referencing a token
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        throttleRateReqPerSec:
          type: integer
          title: Throttle request rate limit
          description: Maximum number of requests to limit to per second
          maximum: 2000
          default: 400
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        url:
          type: string
          title: XSIAM endpoint
          description: XSIAM endpoint URL to send events to, such as https://api-{tenant
            external URL}/logs/v1/event
          default: http://localhost:8088/logs/v1/event
          pattern: ^https?://.*
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        excludeSelf:
          type: boolean
          default: false
          title: Exclude current host IPs
          description: Exclude all IPs of the current host from the list of any resolved
            hostnames
        urls:
          type: array
          title: XSIAM Endpoints
          description: ""
          minItems: 1
          items:
            type: object
            required:
              - url
            properties:
              url: {}
              weight:
                type: number
                title: Load Weight
                description: Assign a weight (>0) to each endpoint to indicate its
                  traffic-handling capability
                minimum: 0
                default: 1
        dnsResolvePeriodSec:
          type: number
          default: 600
          minimum: 0
          maximum: 86400
          title: DNS resolution period (seconds)
          description: The interval in which to re-resolve any hostnames and pick up
            destinations from A records
        loadBalanceStatsPeriodSec:
          type: number
          default: 300
          minimum: 10
          title: Load balance stats period (seconds)
          description: How far back in time to keep traffic stats for load balancing
            purposes
        token:
          type: string
          title: Auth token
          description: XSIAM authentication token
        textSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
      required:
        - type
    OutputNetflow:
      type: object
      required:
        - type
        - hosts
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - netflow
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        hosts:
          type: array
          title: NetFlow Destinations
          description: One or more NetFlow destinations to forward events to
          minItems: 1
          items:
            type: object
            required:
              - host
              - port
            properties:
              host:
                type: string
                title: Address
                description: Destination host
              port:
                type: number
                title: Port
                maximum: 65535
                description: Destination port, default is 2055
                default: 2055
        dnsResolvePeriodSec:
          type: number
          default: 0
          minimum: 0
          maximum: 86400
          title: DNS resolution period (sec)
          description: How often to resolve the destination hostname to an IP address.
            Ignored if all destinations are IP addresses. A value of 0 means
            every datagram sent will incur a DNS lookup.
        description:
          type: string
          title: Description
    OutputDynatraceHttp:
      type: object
      required:
        - type
        - format
        - endpoint
        - telemetryType
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - dynatrace_http
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        method:
          type: string
          title: Method
          description: The method to use when sending events
          enum:
            - POST
            - PUT
            - PATCH
          default: POST
          x-speakeasy-unknown-values: allow
        keepAlive:
          type: boolean
          title: Keep alive
          description: Disable to close the connection immediately after sending the
            outgoing request
          default: true
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 4096
          minimum: 1024
          maximum: 5000
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
          maximum: 50000
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events. You can also add headers dynamically
            on a per-event basis in the __headers field, as explained in [Cribl
            Docs](https://docs.cribl.io/stream/destinations-webhook/#internal-fields).
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        authType:
          type: string
          title: Authentication type
          enum:
            - token
            - textSecret
          x-speakeasy-enum-descriptions:
            - Auth token
            - Token (text secret)
          default: token
          x-speakeasy-unknown-values: allow
        format:
          type: string
          title: Format
          description: How to format events before sending. Defaults to JSON. Plaintext is
            not currently supported.
          enum:
            - json_array
            - plaintext
          x-speakeasy-enum-descriptions:
            - JSON
            - Plaintext
          default: json_array
          x-speakeasy-unknown-values: allow
        endpoint:
          type: string
          title: Endpoint
          enum:
            - cloud
            - activeGate
            - manual
          x-speakeasy-enum-descriptions:
            - Cloud
            - ActiveGate
            - Manual
          default: cloud
          x-speakeasy-unknown-values: allow
        telemetryType:
          type: string
          title: Telemetry type
          enum:
            - logs
            - metrics
          x-speakeasy-enum-descriptions:
            - Logs
            - Metrics
          default: logs
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
        token:
          type: string
          title: Token
          description: Bearer token to include in the authorization header
        textSecret:
          type: string
          title: Token (text secret)
          description: Select or create a stored text secret
        environmentId:
          type: string
          title: Environment ID
          description: ID of the environment to send to
        activeGateDomain:
          type: string
          description: ActiveGate domain with Log analytics collector module enabled. For
            example
            https://{activeGate-domain}:9999/e/{environment-id}/api/v2/logs/ingest.
          title: ActiveGate domain
        url:
          title: URL
          type: string
          description: URL to send events to. Can be overwritten by an event's __url field.
          pattern: ^https?://.*
    OutputDynatraceOtlp:
      type: object
      required:
        - type
        - endpoint
        - endpointType
        - protocol
        - otlpVersion
        - tokenSecret
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - dynatrace_otlp
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        protocol:
          type: string
          title: Protocol
          description: Select a transport option for Dynatrace
          enum:
            - http
          x-speakeasy-enum-descriptions:
            - HTTP
          default: http
          x-speakeasy-unknown-values: allow
        endpoint:
          type: string
          title: Endpoint
          description: The endpoint where Dynatrace events will be sent. Enter any valid
            URL or an IP address (IPv4 or IPv6; enclose IPv6 addresses in square
            brackets)
          default: https://{your-environment-id}.live.dynatrace.com/api/v2/otlp
        otlpVersion:
          type: string
          title: OTLP version
          description: The version of OTLP Protobuf definitions to use when structuring
            data to send
          enum:
            - 1.3.1
          x-speakeasy-enum-descriptions:
            - 1.3.1
          default: 1.3.1
          x-speakeasy-unknown-values: allow
        compress:
          type: string
          title: Compression
          description: Type of compression to apply to messages sent to the OpenTelemetry
            endpoint
          enum:
            - none
            - deflate
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Deflate
            - Gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        httpCompress:
          type: string
          title: Compression
          description: Type of compression to apply to messages sent to the OpenTelemetry
            endpoint
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        httpTracesEndpointOverride:
          type: string
          title: Traces endpoint override
          description: If you want to send traces to the default `{endpoint}/v1/traces`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        httpMetricsEndpointOverride:
          type: string
          title: Metrics endpoint override
          description: If you want to send metrics to the default `{endpoint}/v1/metrics`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        httpLogsEndpointOverride:
          type: string
          title: Logs endpoint override
          description: If you want to send logs to the default `{endpoint}/v1/logs`
            endpoint, leave this field empty; otherwise, specify the desired
            endpoint
        metadata:
          type: array
          title: Metadata
          description: List of key-value pairs to send with each gRPC request. Value
            supports JavaScript expressions that are evaluated just once, when
            the destination gets started. To pass credentials as metadata, use
            'C.Secret'.
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit
          description: Maximum size (in KB) of the request body. The maximum payload size
            is 4 MB. If this limit is exceeded, the entire OTLP message is
            dropped
          default: 2048
          minimum: 1024
          maximum: 4096
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        connectionTimeout:
          type: number
          title: Connection timeout
          description: Amount of time (milliseconds) to wait for the connection to
            establish before retrying
          default: 10000
        keepAliveTime:
          type: number
          title: Keep alive time (seconds)
          description: How often the sender should ping the peer to keep the connection open
          minimum: 1
          default: 30
        keepAlive:
          type: boolean
          title: Keep alive
          description: Disable to close the connection immediately after sending the
            outgoing request
          default: true
        endpointType:
          type: string
          title: Endpoint type
          description: Select the type of Dynatrace endpoint configured
          enum:
            - saas
            - ag
          x-speakeasy-enum-descriptions:
            - SaaS
            - ActiveGate
          default: saas
          x-speakeasy-unknown-values: allow
        tokenSecret:
          type: string
          title: Auth token (text secret)
          description: Select or create a stored text secret
        authTokenName:
          type: string
          title: Api-Token name
          default: Authorization
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
            For optimal performance, consider enabling this setting for non-load
            balanced destinations.
          default: false
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputSentinelOneAiSiem:
      type: object
      required:
        - type
        - region
        - endpoint
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - sentinel_one_ai_siem
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        region:
          type: string
          title: Region
          description: The SentinelOne region to send events to. In most cases you can
            find the region by either looking at your SentinelOne URL or knowing
            what geographic region your SentinelOne instance is contained in.
          default: US
          enum:
            - US
            - CA
            - EMEA
            - AP
            - APS
            - AU
            - Custom
          x-speakeasy-unknown-values: allow
        endpoint:
          title: AI SIEM endpoint path
          type: string
          default: /services/collector/event
          enum:
            - /services/collector/event
            - /services/collector/raw
          description: Endpoint to send events to. Use /services/collector/event for
            structured JSON payloads with standard HEC top-level fields. Use
            /services/collector/raw for unstructured log lines (plain text).
          x-speakeasy-unknown-values: allow
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 5120
          minimum: 1024
          maximum: 2097152
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 30
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 5
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        authType:
          title: Authentication method
          type: string
          enum:
            - manual
            - secret
          default: manual
          description: Select Manual to enter an auth token directly, or select Secret to
            use a text secret to authenticate
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default: []
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        description:
          type: string
          title: Description
        token:
          type: string
          title: AI SIEM API Key
          description: In the SentinelOne Console select Policy & Settings then select the
            Singularity AI SIEM section, API Keys will be at the bottom. Under
            Log Access Keys select a Write token and copy it here
        textSecret:
          type: string
          title: AI SIEM API Key (text secret)
          description: Select or create a stored text secret
        baseUrl:
          title: Base AI SIEM endpoint URL
          type: string
          default: https://<Your-S1-Tenant>.sentinelone.net
          pattern: ^https?://[a-zA-Z0-9.-]+(:[0-9]+)?$
          description: "Base URL of the endpoint used to send events to, such as
            https://<Your-S1-Tenant>.sentinelone.net. Must begin with http:// or
            https://, can include a port number, and no trailing slashes.
            Matches pattern: ^https?://[a-zA-Z0-9.-]+(:[0-9]+)?$."
        hostExpression:
          type: string
          title: serverHost expression
          description: Define serverHost for events using a JavaScript expression. You
            must enclose text constants in quotes (such as, 'myServer').
          default: __e.host || C.os.hostname()
        sourceExpression:
          type: string
          title: logFile expression
          description: Define logFile for events using a JavaScript expression. You must
            enclose text constants in quotes (such as, 'myLogFile.txt').
          default: "__e.source || (__e.__criblMetrics ? 'metrics' : 'cribl')"
        sourceTypeExpression:
          type: string
          title: parser expression
          description: Define the parser for events using a JavaScript expression. This
            value helps parse data into AI SIEM. You must enclose text constants
            in quotes (such as, 'dottedJson'). For custom parsers, substitute
            'dottedJson' with your parser's name.
          default: __e.sourcetype || 'dottedJson'
        dataSourceCategoryExpression:
          type: string
          title: dataSource.category expression
          description: Define the dataSource.category for events using a JavaScript
            expression. This value helps categorize data and helps enable extra
            features in SentinelOne AI SIEM. You must enclose text constants in
            quotes. The default value is 'security'.
          default: "'security'"
        dataSourceNameExpression:
          type: string
          title: dataSource.name expression
          description: Define the dataSource.name for events using a JavaScript
            expression. This value should reflect the type of data being
            inserted into AI SIEM. You must enclose text constants in quotes
            (such as, 'networkActivity' or 'authLogs').
          default: __e.__dataSourceName || 'cribl'
        dataSourceVendorExpression:
          type: string
          title: dataSource.vendor expression
          description: Define the dataSource.vendor for events using a JavaScript
            expression. This value should reflect the vendor of the data being
            inserted into AI SIEM. You must enclose text constants in quotes
            (such as, 'Cisco' or 'Microsoft').
          default: __e.__dataSourceVendor || 'cribl'
        eventTypeExpression:
          type: string
          title: event.type expression
          description: Optionally, define the event.type for events using a JavaScript
            expression. This value acts as a label, grouping events into
            meaningful categories. You must enclose text constants in quotes
            (such as, 'Process Creation' or 'Network Connection').
          default: ""
        host:
          type: string
          title: serverHost expression
          description: Define the serverHost for events using a JavaScript expression.
            This value will be passed to AI SIEM. You must enclose text
            constants in quotes (such as, 'myServerName').
          default: C.os.hostname()
        source:
          type: string
          title: logFile
          description: Specify the logFile value to pass as a parameter to SentinelOne AI
            SIEM. Don't quote this value. The default is cribl.
          default: cribl
        sourceType:
          type: string
          title: parser
          description: Specify the sourcetype parameter for SentinelOne AI SIEM, which
            determines the parser. Don't quote this value. For custom parsers,
            substitute hecRawParser with your parser's name. The default is
            hecRawParser.
          default: hecRawParser
        dataSourceCategory:
          type: string
          title: dataSource.category
          description: Specify the dataSource.category value to pass as a parameter to
            SentinelOne AI SIEM. This value helps categorize data and enables
            additional features. Don't quote this value. The default is
            security.
          default: security
        dataSourceName:
          type: string
          title: dataSource.name
          description: Specify the dataSource.name value to pass as a parameter to AI
            SIEM. This value should reflect the type of data being inserted.
            Don't quote this value. The default is cribl.
          default: cribl
        dataSourceVendor:
          type: string
          title: dataSource.vendor
          description: Specify the dataSource.vendorvalue to pass as a parameter to AI
            SIEM. This value should reflect the vendor of the data being
            inserted. Don't quote this value. The default is cribl.
          default: cribl
        eventType:
          type: string
          title: event.type
          description: Specify the event.type value to pass as an optional parameter to AI
            SIEM. This value acts as a label, grouping events into meaningful
            categories like Process Creation, File Modification, or Network
            Connection. Don't quote this value. By default, this field is empty.
          default: ""
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputChronicle:
      type: object
      required:
        - type
        - gcpProjectId
        - gcpInstance
        - region
        - logType
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - chronicle
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        apiVersion:
          type: string
          title: API version
          default: v1alpha
        authenticationMethod:
          type: string
          title: Authentication method
          default: serviceAccount
          enum:
            - serviceAccount
            - serviceAccountSecret
          x-speakeasy-unknown-values: allow
        responseRetrySettings:
          type: array
          title: Settings for failed HTTP requests
          description: Automatically retry after unsuccessful response status codes, such
            as 429 (Too Many Requests) or 503 (Service Unavailable)
          minItems: 0
          default:
            - httpStatus: 429
              initialBackoff: 30000
              backoffRate: 1
              maxBackoff: 30000
            - httpStatus: 500
              initialBackoff: 30000
              backoffRate: 1
              maxBackoff: 30000
            - httpStatus: 503
              initialBackoff: 30000
              backoffRate: 1
              maxBackoff: 30000
          items:
            type: object
            required:
              - httpStatus
            properties:
              httpStatus:
                type: number
                title: HTTP status code
                description: The HTTP response status code that will trigger retries
                minimum: 100
                maximum: 599
              initialBackoff:
                type: number
                title: Pre-backoff interval (ms)
                description: How long, in milliseconds, Cribl Stream should wait before
                  initiating backoff. Maximum interval is 600,000 ms (10
                  minutes).
                minimum: 0
                maximum: 600000
                default: 1000
              backoffRate:
                type: number
                title: Backoff multiplier
                description: Base for exponential backoff. A value of 2 (default) means Cribl
                  Stream will retry after 2 seconds, then 4 seconds, then 8
                  seconds, etc.
                minimum: 1
                maximum: 20
                default: 2
              maxBackoff:
                type: number
                title: Backoff limit (ms)
                description: The maximum backoff interval, in milliseconds, Cribl Stream should
                  apply. Default (and minimum) is 10,000 ms (10 seconds);
                  maximum is 180,000 ms (180 seconds).
                minimum: 10000
                maximum: 180000
                default: 10000
        timeoutRetrySettings:
          type: object
          required:
            - timeoutRetry
          properties:
            timeoutRetry:
              type: boolean
              title: Retry timed-out HTTP requests
              default: false
            initialBackoff:
              type: number
              title: Pre-backoff interval (ms)
              description: How long, in milliseconds, Cribl Stream should wait before
                initiating backoff. Maximum interval is 600,000 ms (10 minutes).
              minimum: 0
              maximum: 600000
              default: 1000
            backoffRate:
              type: number
              title: Backoff multiplier
              description: Base for exponential backoff. A value of 2 (default) means Cribl
                Stream will retry after 2 seconds, then 4 seconds, then 8
                seconds, etc.
              minimum: 1
              maximum: 20
              default: 2
            maxBackoff:
              type: number
              title: Backoff limit (ms)
              description: The maximum backoff interval, in milliseconds, Cribl Stream should
                apply. Default (and minimum) is 10,000 ms (10 seconds); maximum
                is 180,000 ms (180 seconds).
              minimum: 10000
              maximum: 180000
              default: 10000
        responseHonorRetryAfterHeader:
          type: boolean
          title: Honor Retry-After header
          description: Honor any Retry-After header that specifies a delay (in seconds) no
            longer than 180 seconds after the retry request. @{product} limits
            the delay to 180 seconds, even if the Retry-After header specifies a
            longer delay. When enabled, takes precedence over user-configured
            retry options. When disabled, all Retry-After headers are ignored.
          default: true
        region:
          type: string
          title: Region
          description: Regional endpoint to send events to
        concurrency:
          type: number
          title: Request concurrency
          description: Maximum number of ongoing requests before blocking
          default: 5
          minimum: 1
          maximum: 32
        maxPayloadSizeKB:
          type: number
          title: Body size limit (KB)
          description: Maximum size, in KB, of the request body
          default: 1024
          minimum: 1
          maximum: 4096
        maxPayloadEvents:
          type: number
          title: Events-per-request limit
          description: Maximum number of events to include in the request body. Default is
            0 (unlimited).
          default: 0
          minimum: 0
        compress:
          type: boolean
          default: true
          title: Compress
          description: Compress the payload body before sending
        rejectUnauthorized:
          type: boolean
          default: true
          title: Validate server certs
          description: >-
            Reject certificates not authorized by a CA in the CA certificate
            path or by another trusted CA (such as the system's). 
                    Enabled by default. When this setting is also present in TLS Settings (Client Side), 
                    that value will take precedence.
        timeoutSec:
          type: number
          default: 90
          minimum: 1
          maximum: 9007199254740991
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Body size limit.
        extraHttpHeaders:
          type: array
          title: Extra HTTP headers
          description: Headers to add to all events
          items:
            type: object
            required:
              - value
            properties:
              name:
                type: string
                title: Field Name
              value:
                type: string
                title: Field Value
        failedRequestLoggingMode:
          type: string
          title: Failed request logging mode
          description: Data to log when a request fails. All headers are redacted by
            default, unless listed as safe headers below.
          enum:
            - payload
            - payloadAndHeaders
            - none
          x-speakeasy-enum-descriptions:
            - Payload
            - Payload + Headers
            - None
          default: none
          x-speakeasy-unknown-values: allow
        safeHeaders:
          type: array
          title: Safe headers
          description: List of headers that are safe to log in plain text
          default: []
          items:
            type: string
        useRoundRobinDns:
          type: boolean
          title: Round-robin DNS
          description: Enable round-robin DNS lookup. When a DNS server returns multiple
            addresses, @{product} will cycle through them in the order returned.
          default: false
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        totalMemoryLimitKB:
          type: number
          title: Buffer memory limit (KB)
          description: Maximum total size of the batches waiting to be sent. If left
            blank, defaults to 5 times the max body size (if set). If 0, no
            limit is enforced.
          minimum: 0
        ingestionMethod:
          type: string
          title: Chronicle API ingestion method
          default: ImportLogs
        namespace:
          type: string
          title: Namespace
          description: User-configured environment namespace to identify the data domain
            the logs originated from. This namespace is used as a tag to
            identify the appropriate data domain for indexing and enrichment
            functionality. Can be overwritten by event field __namespace.
        logType:
          type: string
          title: Default log type
          description: Default log type value to send to SecOps. Can be overwritten by
            event field __logType.
        logTextField:
          type: string
          title: Log text field
          description: Name of the event field that contains the log text to send. If not
            specified, Stream sends a JSON representation of the whole event.
        gcpProjectId:
          type: string
          title: GCP project ID
          description: The Google Cloud Platform (GCP) project ID to send events to
        gcpInstance:
          type: string
          title: GCP instance
          description: The Google Cloud Platform (GCP) instance to send events to. This is
            the Chronicle customer uuid.
        customLabels:
          type: array
          title: Custom labels
          description: Custom labels to be added to every event
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
              value:
                type: string
                title: Value
              rbacEnabled:
                type: boolean
                title: Enable RBAC
                description: Designate this label for role-based access control and filtering
                default: false
        description:
          type: string
          title: Description
        serviceAccountCredentials:
          type: string
          title: Service account credentials
          description: Contents of service account credentials (JSON keys) file downloaded
            from Google Cloud. To upload a file, click the upload button at this
            field's upper right.
        serviceAccountCredentialsSecret:
          type: string
          title: Service account credentials (text secret)
          description: Select or create a stored text secret
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputDatabricks:
      type: object
      required:
        - type
        - workspaceId
        - scope
        - clientId
        - clientTextSecret
        - catalog
        - schema
        - eventsVolumeName
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - databricks
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        destPath:
          type: string
          title: Upload path
          description: Optional path to prepend to files before uploading.
          default: ""
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files before compressing and
            moving to final destination. Use performant, stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized. Default is date-based. If blank, Stream will fall back to
            the event's __partition field value – if present – otherwise to each
            location's root directory.
          default: "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 1800
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 1800
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        workspaceId:
          type: string
          title: Workspace ID
          description: Databricks workspace ID
        scope:
          type: string
          title: OAuth scope
          description: OAuth scope for Unity Catalog authentication
          default: all-apis
        clientId:
          type: string
          title: Client ID
          description: OAuth client ID for Unity Catalog authentication
        catalog:
          type: string
          title: Catalog
          description: Name of the catalog to use for the output
          default: main
        schema:
          type: string
          title: Schema
          description: Name of the catalog schema to use for the output
          default: external
        eventsVolumeName:
          type: string
          title: Events volume name
          description: Name of the events volume in Databricks
          default: events
        clientTextSecret:
          type: string
          title: Client Secret
          description: OAuth client secret for Unity Catalog authentication
        timeoutSec:
          type: number
          title: Request timeout
          description: Amount of time, in seconds, to wait for a request to complete
            before canceling it
          default: 60
          minimum: 30
        description:
          type: string
          title: Description
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    OutputMicrosoftFabric:
      type: object
      required:
        - type
        - bootstrap_server
        - topic
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - microsoft_fabric
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        topic:
          type: string
          title: Topic name
          description: Topic name from Fabric Eventstream's endpoint
        ack:
          type: integer
          default: 1
          title: Acknowledgments
          description: Control the number of required acknowledgments
          enum:
            - 1
            - 0
            - -1
          x-speakeasy-enum-descriptions:
            - Leader
            - None
            - All
          x-speakeasy-unknown-values: allow
        format:
          type: string
          default: json
          enum:
            - json
            - raw
          title: Record data format
          description: Format to use to serialize events before writing to the Event Hubs
            Kafka brokers
          x-speakeasy-enum-descriptions:
            - JSON
            - Field _raw
          x-speakeasy-unknown-values: allow
        maxRecordSizeKB:
          type: number
          default: 768
          minimum: 1
          title: Record size limit (KB, uncompressed)
          description: Maximum size of each record batch before compression. Setting
            should be < message.max.bytes settings in Event Hubs brokers.
        flushEventCount:
          type: number
          default: 1000
          minimum: 1
          maximum: 10000
          title: Events-per-batch limit
          description: Maximum number of events in a batch before forcing a flush
        flushPeriodSec:
          type: number
          default: 1
          title: Flush period (sec)
          description: Maximum time between requests. Small values could cause the payload
            size to be smaller than the configured Max record size.
        connectionTimeout:
          type: number
          title: Connection timeout (ms)
          description: Maximum time to wait for a connection to complete successfully
          default: 10000
          minimum: 1000
          maximum: 3600000
        requestTimeout:
          type: number
          title: Request timeout (ms)
          description: Maximum time to wait for Kafka to respond to a request
          default: 60000
          minimum: 1000
          maximum: 3600000
        maxRetries:
          type: number
          title: Retry limit
          description: If messages are failing, you can set the maximum number of retries
            as high as 100 to prevent loss of data
          default: 5
          minimum: 0
          maximum: 100
        maxBackOff:
          type: number
          title: Backoff limit (ms)
          description: The maximum wait time for a retry, in milliseconds. Default (and
            minimum) is 30,000 ms (30 seconds); maximum is 180,000 ms (180
            seconds).
          default: 30000
          minimum: 30000
          maximum: 180000
        initialBackoff:
          type: number
          title: Initial retry interval (ms)
          description: Initial value used to calculate the retry, in milliseconds. Maximum
            is 600,000 ms (10 minutes).
          default: 300
          minimum: 300
          maximum: 600000
        backoffRate:
          type: number
          title: Backoff multiplier
          description: Set the backoff multiplier (2-20) to control the retry frequency
            for failed messages. For faster retries, use a lower multiplier. For
            slower retries with more delay between attempts, use a higher
            multiplier. The multiplier is used in an exponential backoff
            formula; see the Kafka
            [documentation](https://kafka.js.org/docs/retry-detailed) for
            details.
          default: 2
          minimum: 2
          maximum: 20
        authenticationTimeout:
          type: number
          title: Authentication timeout (ms)
          description: Maximum time to wait for Kafka to respond to an authentication
            request
          default: 10000
          minimum: 1000
          maximum: 3600000
        reauthenticationThreshold:
          type: number
          title: Reauthentication threshold (ms)
          description: Specifies a time window during which @{product} can reauthenticate
            if needed. Creates the window measuring backward from the moment
            when credentials are set to expire.
          default: 10000
          minimum: 1000
          maximum: 1800000
        sasl:
          type: object
          title: Authentication
          description: Authentication parameters to use when connecting to bootstrap
            server. Using TLS is highly recommended.
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            mechanism:
              enum:
                - plain
                - oauthbearer
              type: string
              x-speakeasy-enum-descriptions:
                - PLAIN
                - OAUTHBEARER
              title: SASL mechanism
              default: plain
              x-speakeasy-unknown-values: allow
            username:
              type: string
              title: SASL JASS username
              default: $ConnectionString
              description: The username for authentication. This should always be
                $ConnectionString.
            textSecret:
              type: string
              title: SASL JASS password
              description: Select or create a stored text secret corresponding to the SASL
                JASS Password Primary or Password Secondary
            clientSecretAuthType:
              enum:
                - secret
                - certificate
              title: Authentication method
              type: string
              default: secret
              x-speakeasy-unknown-values: allow
            clientTextSecret:
              type: string
              title: Client secret (text secret)
              description: Select or create a stored text secret
            certificateName:
              type: string
              title: Certificate
              description: Select or create a stored certificate
            certPath:
              type: string
            privKeyPath:
              type: string
            passphrase:
              type: string
            oauthEndpoint:
              type: string
              title: Microsoft Entra ID authentication endpoint
              default: https://login.microsoftonline.com
              enum:
                - https://login.microsoftonline.com
                - https://login.microsoftonline.us
                - https://login.partner.microsoftonline.cn
              description: Endpoint used to acquire authentication tokens from Azure
              x-speakeasy-unknown-values: allow
            clientId:
              type: string
              title: Client ID
              description: client_id to pass in the OAuth request parameter
            tenantId:
              type: string
              title: Tenant identifier
              description: Directory ID (tenant identifier) in Azure Active Directory
            scope:
              type: string
              title: Scope
              description: Scope to pass in the OAuth request parameter
        tls:
          type: object
          title: TLS settings (client side)
          required:
            - disabled
          properties:
            disabled:
              type: boolean
              title: Disabled
              default: false
            rejectUnauthorized:
              type: boolean
              title: Validate server certs
              description: Reject certificates that are not authorized by a CA in the CA
                certificate path, or by another trusted CA (such as the
                system's)
              default: true
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
            - queue
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
            - Persistent Queue
          default: block
          x-speakeasy-unknown-values: allow
        bootstrap_server:
          type: string
          title: Bootstrap server
          description: Bootstrap server from Fabric Eventstream's endpoint
        description:
          type: string
          title: Description
        pqStrictOrdering:
          title: Strict ordering
          description: Use FIFO (first in, first out) processing. Disable to forward new
            events to receivers before queue is flushed.
          type: boolean
          default: true
        pqRatePerSec:
          type: number
          title: Drain rate limit (EPS)
          description: Throttling rate (in events per second) to impose while writing to
            Destinations from PQ. Defaults to 0, which disables throttling.
          minimum: 0
          default: 0
        pqMode:
          enum:
            - error
            - always
            - backpressure
          title: Mode
          description: In Error mode, PQ writes events to the filesystem if the
            Destination is unavailable. In Backpressure mode, PQ writes events
            to the filesystem when it detects backpressure from the Destination.
            In Always On mode, PQ always writes events to the filesystem.
          type: string
          default: error
          x-speakeasy-enum-descriptions:
            - Error
            - Backpressure
            - Always On
          x-speakeasy-unknown-values: allow
        pqMaxBufferSize:
          type: number
          title: Buffer size limit
          description: The maximum number of events to hold in memory before writing the
            events to disk
          default: 42
          minimum: 42
          maximum: 1000
        pqMaxBackpressureSec:
          type: number
          title: Backpressure duration limit
          description: How long (in seconds) to wait for backpressure to resolve before
            engaging the queue
          minimum: 0
          default: 30
        pqMaxFileSize:
          type: string
          title: File size limit
          description: The maximum size to store in each queue file before closing and
            optionally compressing (KB, MB, etc.)
          pattern: ^\d+\s*(?:\w{2})?$
          default: 1 MB
        pqMaxSize:
          type: string
          title: Queue size limit
          description: The maximum disk space that the queue can consume (as an average
            per Worker Process) before queueing stops. Enter a numeral with
            units of KB, MB, etc.
          pattern: ^\d+\s*(?:\w{2})?$
          default: 5GB
        pqPath:
          type: string
          default: $CRIBL_HOME/state/queues
          title: Queue file path
          description: "The location for the persistent queue files. To this field's
            value, the system will append: /<worker-id>/<output-id>."
        pqCompress:
          type: string
          default: none
          enum:
            - none
            - gzip
          x-speakeasy-enum-descriptions:
            - None
            - Gzip
          title: Compression
          description: Codec to use to compress the persisted data
          x-speakeasy-unknown-values: allow
        pqOnBackpressure:
          type: string
          default: block
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop new data
          title: Queue-full behavior
          description: How to handle events when the queue is exerting backpressure (full
            capacity or low disk). 'Block' is the same behavior as non-PQ
            blocking. 'Drop new data' throws away incoming data, while leaving
            the contents of the PQ unchanged.
          x-speakeasy-unknown-values: allow
        pqControls:
          type: object
          title: ""
    OutputCloudflareR2:
      type: object
      required:
        - type
        - bucket
        - stagePath
        - endpoint
      properties:
        id:
          type: string
          title: Output ID
          description: Unique ID for this output
        type:
          type: string
          enum:
            - cloudflare_r2
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to process data before sending out to this output
        systemFields:
          type: array
          title: System fields
          description: Fields to automatically add to events, such as cribl_pipe. Supports
            wildcards.
          default:
            - cribl_pipe
          items:
            type: string
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        endpoint:
          type: string
          title: R2 endpoint
          description: "Cloudflare R2 service URL (example:
            https://<ACCOUNT_ID>.r2.cloudflarestorage.com)"
          pattern: ^https?://.*
        bucket:
          type: string
          title: R2 bucket name
          description: "Name of the destination R2 bucket. This value can be a constant or
            a JavaScript expression that can only be evaluated at init time.
            Example referencing a Global Variable: `myBucket-${C.vars.myVar}`"
        awsAuthenticationMethod:
          type: string
          title: Authentication method
          description: AWS authentication method. Choose Auto to use IAM roles.
          default: auto
          enum:
            - auto
            - secret
            - manual
          x-speakeasy-unknown-values: allow
        awsSecretKey:
          type: string
          title: Secret key
          description: Secret key. This value can be a constant or a JavaScript
            expression, such as `${C.env.SOME_SECRET}`).
        region: {}
        stagePath:
          type: string
          title: Staging location
          description: Filesystem location in which to buffer files, before compressing
            and moving to final destination. Use performant stable storage.
          default: $CRIBL_HOME/state/outputs/staging
        addIdToStagePath:
          type: boolean
          title: Add output ID
          description: Add the Output ID value to staging location
          default: true
        destPath:
          type: string
          title: Key prefix
          description: Root directory to prepend to path before uploading. Enter a
            constant, or a JavaScript expression enclosed in quotes or
            backticks.
        signatureVersion:
          type: string
          title: Signature version
          description: Signature version to use for signing MinIO requests
          default: v4
          enum:
            - v2
            - v4
          x-speakeasy-unknown-values: allow
        objectACL: {}
        storageClass:
          type: string
          title: Storage class
          description: Storage class to select for uploaded objects
          enum:
            - STANDARD
            - REDUCED_REDUNDANCY
          x-speakeasy-enum-descriptions:
            - Standard
            - Reduced Redundancy Storage
          x-speakeasy-unknown-values: allow
        serverSideEncryption:
          type: string
          title: Server-side encryption
          description: Server-side encryption for uploaded objects
          enum:
            - AES256
          x-speakeasy-enum-descriptions:
            - Amazon S3 Managed Key
          x-speakeasy-unknown-values: allow
        reuseConnections:
          type: boolean
          title: Reuse connections
          description: Reuse connections between requests, which can improve performance
          default: true
        rejectUnauthorized:
          type: boolean
          title: Reject unauthorized certificates
          description: Reject certificates that cannot be verified against a valid CA,
            such as self-signed certificates)
          default: true
        verifyPermissions:
          type: boolean
          title: Verify if bucket exists
          description: Disable if you can access files within the bucket but not the
            bucket itself
          default: true
        removeEmptyDirs:
          type: boolean
          title: Remove empty staging directories
          description: Remove empty staging directories after moving files
          default: true
        partitionExpr:
          type: string
          title: Partitioning expression
          description: JavaScript expression defining how files are partitioned and
            organized. Default is date-based. If blank, Stream will fall back to
            the event's __partition field value – if present – otherwise to each
            location's root directory.
          default: "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
        format:
          type: string
          title: Data format
          description: Format of the output data
          enum:
            - json
            - raw
            - parquet
          x-speakeasy-enum-descriptions:
            - JSON
            - Raw
            - Parquet
          default: json
          x-speakeasy-unknown-values: allow
        baseFileName:
          type: string
          title: File name prefix expression
          description: JavaScript expression to define the output filename prefix (can be
            constant)
          default: "`CriblOut`"
        fileNameSuffix:
          type: string
          title: File name suffix expression
          description: JavaScript expression to define the output filename suffix (can be
            constant).  The `__format` variable refers to the value of the `Data
            format` field (`json` or `raw`).  The `__compression` field refers
            to the kind of compression being used (`none` or `gzip`).
          default: '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ?
            ".gz" : ""}`'
        maxFileSizeMB:
          type: number
          title: File size limit (MB)
          description: Maximum uncompressed output file size. Files of this size will be
            closed and moved to final output location.
          default: 32
          maximum: 1024
          minimum: 5
        maxOpenFiles:
          type: number
          title: Open file limit
          description: Maximum number of files to keep open concurrently. When exceeded,
            @{product} will close the oldest open files and move them to the
            final output location.
          default: 100
          minimum: 10
          maximum: 2000
        headerLine:
          type: string
          title: Header line
          description: If set, this line will be written to the beginning of each output
            file
          default: ""
        writeHighWaterMark:
          type: number
          title: Writing high watermark (KB)
          description: Buffer size used to write to a file
          default: 64
          maximum: 4096
          minimum: 16
        onBackpressure:
          type: string
          title: Backpressure behavior
          description: How to handle events when all receivers are exerting backpressure
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        deadletterEnabled:
          type: boolean
          default: false
          title: Enable dead-lettering
          description: If a file fails to move to its final destination after the maximum
            number of retries, move it to a designated directory to prevent
            further errors
        onDiskFullBackpressure:
          type: string
          title: Disk space protection
          description: How to handle events when disk space is below the global 'Min free
            disk space' limit
          enum:
            - block
            - drop
          x-speakeasy-enum-descriptions:
            - Block
            - Drop
          default: block
          x-speakeasy-unknown-values: allow
        forceCloseOnShutdown:
          type: boolean
          title: Force close on shutdown
          description: Force all staged files to close during an orderly Node shutdown.
            This triggers immediate upload of in-progress data — regardless of
            idle time, file age, or size thresholds — to minimize data loss.
          default: false
        maxFileOpenTimeSec:
          type: number
          title: File open time limit (sec)
          description: Maximum amount of time to write to a file. Files open for longer
            than this will be closed and moved to final output location.
          default: 300
          minimum: 10
          maximum: 86400
        maxFileIdleTimeSec:
          type: number
          title: Idle time limit (sec)
          description: Maximum amount of time to keep inactive files open. Files open for
            longer than this will be closed and moved to final output location.
          default: 30
          minimum: 5
          maximum: 86400
        maxConcurrentFileParts:
          type: number
          title: Concurrent file parts limit
          description: Maximum number of parts to upload in parallel per file. Minimum
            part size is 5MB.
          default: 4
          minimum: 1
          maximum: 10
        description:
          type: string
          title: Description
        awsApiKey:
          type: string
          title: Access key
          description: This value can be a constant or a JavaScript expression
            (`${C.env.SOME_ACCESS_KEY}`)
        awsSecret:
          type: string
          title: Secret key pair
          description: Select or create a stored secret that references your access key
            and secret key
        compress:
          type: string
          title: Compression
          description: Data compression format to apply to HTTP content before it is
            delivered
          enum:
            - none
            - gzip
          default: gzip
          x-speakeasy-unknown-values: allow
        compressionLevel:
          type: string
          title: Compression level
          description: Compression level to apply before moving files to final destination
          enum:
            - best_speed
            - normal
            - best_compression
          x-speakeasy-enum-descriptions:
            - Best Speed
            - Normal
            - Best Compression
          default: best_speed
          x-speakeasy-unknown-values: allow
        automaticSchema:
          type: boolean
          title: Automatic schema
          default: false
          description: Automatically calculate the schema based on the events of each
            Parquet file generated
        parquetSchema:
          type: string
          title: Parquet schema
          description: To add a new schema, navigate to Processing > Knowledge > Parquet
            Schemas
          minLength: 1
        parquetVersion:
          type: string
          title: Parquet version
          enum:
            - PARQUET_1_0
            - PARQUET_2_4
            - PARQUET_2_6
          x-speakeasy-enum-descriptions:
            - "1.0"
            - "2.4"
            - "2.6"
          default: PARQUET_2_6
          description: Determines which data types are supported and how they are
            represented
          x-speakeasy-unknown-values: allow
        parquetDataPageVersion:
          type: string
          title: Data page version
          enum:
            - DATA_PAGE_V1
            - DATA_PAGE_V2
          x-speakeasy-enum-descriptions:
            - V1
            - V2
          default: DATA_PAGE_V2
          description: Serialization format of data pages. Note that some reader
            implementations use Data page V2's attributes to work more
            efficiently, while others ignore it.
          x-speakeasy-unknown-values: allow
        parquetRowGroupLength:
          type: number
          title: Group row limit
          description: The number of rows that every group will contain. The final group
            can contain a smaller number of rows.
          default: 10000
          minimum: 1
          maximum: 67108864
        parquetPageSize:
          type: string
          title: Page size
          description: Target memory size for page segments, such as 1MB or 128MB.
            Generally, lower values improve reading speed, while higher values
            improve compression.
          pattern: ^\d+\s*(?:[kK][bB]|[mM][bB]|[gG][bB]|[tT][bB])?$
          default: 1MB
        shouldLogInvalidRows:
          type: boolean
          title: Log invalid rows
          description: Log up to 3 rows that @{product} skips due to data mismatch
        keyValueMetadata:
          type: array
          title: Metadata (optional)
          description: 'The metadata of files the Destination writes will include the
            properties you add here as key-value pairs. Useful for tagging.
            Examples: "key":"OCSF Event Class", "value":"9001"'
          minItems: 0
          items:
            type: object
            required:
              - key
              - value
            properties:
              key:
                type: string
                title: Key
                default: ""
              value:
                type: string
                title: Value
        enableStatistics:
          type: boolean
          title: Write statistics
          default: true
          description: Statistics profile an entire file in terms of minimum/maximum
            values within data, numbers of nulls, etc. You can use Parquet tools
            to view statistics.
        enableWritePageIndex:
          type: boolean
          title: Write page indexes
          default: true
          description: One page index contains statistics for one data page. Parquet
            readers use statistics to enable page skipping.
        enablePageChecksum:
          type: boolean
          title: Write page checksum
          default: false
          description: Parquet tools can use the checksum of a Parquet page to verify data
            integrity
        emptyDirCleanupSec:
          type: number
          title: Staging cleanup period
          description: How frequently, in seconds, to clean up empty directories
          default: 300
          minimum: 10
          maximum: 86400
        directoryBatchSize:
          type: number
          title: Directory batch size
          description: Number of directories to process in each batch during cleanup of
            empty directories. Minimum is 10, maximum is 10000. Higher values
            may require more memory.
          default: 1000
        deadletterPath:
          type: string
          title: Dead-letter location
          description: Storage location for files that fail to reach their final
            destination after maximum retries are exceeded
          default: $CRIBL_HOME/state/outputs/dead-letter
        maxRetryNum:
          type: number
          title: Retry limit
          description: The maximum number of times a file will attempt to move to its
            final destination before being dead-lettered
          default: 20
          minimum: 1
    Output:
      oneOf:
        - $ref: "#/components/schemas/OutputDefault"
        - $ref: "#/components/schemas/OutputWebhook"
        - $ref: "#/components/schemas/OutputSentinel"
        - $ref: "#/components/schemas/OutputDevnull"
        - $ref: "#/components/schemas/OutputSyslog"
        - $ref: "#/components/schemas/OutputSplunk"
        - $ref: "#/components/schemas/OutputSplunkLb"
        - $ref: "#/components/schemas/OutputSplunkHec"
        - $ref: "#/components/schemas/OutputTcpjson"
        - $ref: "#/components/schemas/OutputWavefront"
        - $ref: "#/components/schemas/OutputSignalfx"
        - $ref: "#/components/schemas/OutputFilesystem"
        - $ref: "#/components/schemas/OutputS3"
        - $ref: "#/components/schemas/OutputAzureBlob"
        - $ref: "#/components/schemas/OutputAzureDataExplorer"
        - $ref: "#/components/schemas/OutputAzureLogs"
        - $ref: "#/components/schemas/OutputKinesis"
        - $ref: "#/components/schemas/OutputHoneycomb"
        - $ref: "#/components/schemas/OutputAzureEventhub"
        - $ref: "#/components/schemas/OutputGoogleChronicle"
        - $ref: "#/components/schemas/OutputGoogleCloudStorage"
        - $ref: "#/components/schemas/OutputGoogleCloudLogging"
        - $ref: "#/components/schemas/OutputGooglePubsub"
        - $ref: "#/components/schemas/OutputExabeam"
        - $ref: "#/components/schemas/OutputKafka"
        - $ref: "#/components/schemas/OutputConfluentCloud"
        - $ref: "#/components/schemas/OutputMsk"
        - $ref: "#/components/schemas/OutputElastic"
        - $ref: "#/components/schemas/OutputElasticCloud"
        - $ref: "#/components/schemas/OutputNewrelic"
        - $ref: "#/components/schemas/OutputNewrelicEvents"
        - $ref: "#/components/schemas/OutputInfluxdb"
        - $ref: "#/components/schemas/OutputCloudwatch"
        - $ref: "#/components/schemas/OutputMinio"
        - $ref: "#/components/schemas/OutputStatsd"
        - $ref: "#/components/schemas/OutputStatsdExt"
        - $ref: "#/components/schemas/OutputGraphite"
        - $ref: "#/components/schemas/OutputRouter"
        - $ref: "#/components/schemas/OutputSns"
        - $ref: "#/components/schemas/OutputSqs"
        - $ref: "#/components/schemas/OutputSnmp"
        - $ref: "#/components/schemas/OutputSumoLogic"
        - $ref: "#/components/schemas/OutputDatadog"
        - $ref: "#/components/schemas/OutputGrafanaCloud"
        - $ref: "#/components/schemas/OutputLoki"
        - $ref: "#/components/schemas/OutputPrometheus"
        - $ref: "#/components/schemas/OutputRing"
        - $ref: "#/components/schemas/OutputOpenTelemetry"
        - $ref: "#/components/schemas/OutputServiceNow"
        - $ref: "#/components/schemas/OutputDataset"
        - $ref: "#/components/schemas/OutputCriblTcp"
        - $ref: "#/components/schemas/OutputCriblHttp"
        - $ref: "#/components/schemas/OutputHumioHec"
        - $ref: "#/components/schemas/OutputCrowdstrikeNextGenSiem"
        - $ref: "#/components/schemas/OutputDlS3"
        - $ref: "#/components/schemas/OutputSecurityLake"
        - $ref: "#/components/schemas/OutputCriblLake"
        - $ref: "#/components/schemas/OutputDiskSpool"
        - $ref: "#/components/schemas/OutputClickHouse"
        - $ref: "#/components/schemas/OutputXsiam"
        - $ref: "#/components/schemas/OutputNetflow"
        - $ref: "#/components/schemas/OutputDynatraceHttp"
        - $ref: "#/components/schemas/OutputDynatraceOtlp"
        - $ref: "#/components/schemas/OutputSentinelOneAiSiem"
        - $ref: "#/components/schemas/OutputChronicle"
        - $ref: "#/components/schemas/OutputDatabricks"
        - $ref: "#/components/schemas/OutputMicrosoftFabric"
        - $ref: "#/components/schemas/OutputCloudflareR2"
      discriminator:
        propertyName: type
        mapping:
          default: "#/components/schemas/OutputDefault"
          webhook: "#/components/schemas/OutputWebhook"
          sentinel: "#/components/schemas/OutputSentinel"
          devnull: "#/components/schemas/OutputDevnull"
          syslog: "#/components/schemas/OutputSyslog"
          splunk: "#/components/schemas/OutputSplunk"
          splunk_lb: "#/components/schemas/OutputSplunkLb"
          splunk_hec: "#/components/schemas/OutputSplunkHec"
          tcpjson: "#/components/schemas/OutputTcpjson"
          wavefront: "#/components/schemas/OutputWavefront"
          signalfx: "#/components/schemas/OutputSignalfx"
          filesystem: "#/components/schemas/OutputFilesystem"
          s3: "#/components/schemas/OutputS3"
          azure_blob: "#/components/schemas/OutputAzureBlob"
          azure_data_explorer: "#/components/schemas/OutputAzureDataExplorer"
          azure_logs: "#/components/schemas/OutputAzureLogs"
          kinesis: "#/components/schemas/OutputKinesis"
          honeycomb: "#/components/schemas/OutputHoneycomb"
          azure_eventhub: "#/components/schemas/OutputAzureEventhub"
          google_chronicle: "#/components/schemas/OutputGoogleChronicle"
          google_cloud_storage: "#/components/schemas/OutputGoogleCloudStorage"
          google_cloud_logging: "#/components/schemas/OutputGoogleCloudLogging"
          google_pubsub: "#/components/schemas/OutputGooglePubsub"
          exabeam: "#/components/schemas/OutputExabeam"
          kafka: "#/components/schemas/OutputKafka"
          confluent_cloud: "#/components/schemas/OutputConfluentCloud"
          msk: "#/components/schemas/OutputMsk"
          elastic: "#/components/schemas/OutputElastic"
          elastic_cloud: "#/components/schemas/OutputElasticCloud"
          newrelic: "#/components/schemas/OutputNewrelic"
          newrelic_events: "#/components/schemas/OutputNewrelicEvents"
          influxdb: "#/components/schemas/OutputInfluxdb"
          cloudwatch: "#/components/schemas/OutputCloudwatch"
          minio: "#/components/schemas/OutputMinio"
          statsd: "#/components/schemas/OutputStatsd"
          statsd_ext: "#/components/schemas/OutputStatsdExt"
          graphite: "#/components/schemas/OutputGraphite"
          router: "#/components/schemas/OutputRouter"
          sns: "#/components/schemas/OutputSns"
          sqs: "#/components/schemas/OutputSqs"
          snmp: "#/components/schemas/OutputSnmp"
          sumo_logic: "#/components/schemas/OutputSumoLogic"
          datadog: "#/components/schemas/OutputDatadog"
          grafana_cloud: "#/components/schemas/OutputGrafanaCloud"
          loki: "#/components/schemas/OutputLoki"
          prometheus: "#/components/schemas/OutputPrometheus"
          ring: "#/components/schemas/OutputRing"
          open_telemetry: "#/components/schemas/OutputOpenTelemetry"
          service_now: "#/components/schemas/OutputServiceNow"
          dataset: "#/components/schemas/OutputDataset"
          cribl_tcp: "#/components/schemas/OutputCriblTcp"
          cribl_http: "#/components/schemas/OutputCriblHttp"
          humio_hec: "#/components/schemas/OutputHumioHec"
          crowdstrike_next_gen_siem: "#/components/schemas/OutputCrowdstrikeNextGenSiem"
          dl_s3: "#/components/schemas/OutputDlS3"
          security_lake: "#/components/schemas/OutputSecurityLake"
          cribl_lake: "#/components/schemas/OutputCriblLake"
          disk_spool: "#/components/schemas/OutputDiskSpool"
          click_house: "#/components/schemas/OutputClickHouse"
          xsiam: "#/components/schemas/OutputXsiam"
          netflow: "#/components/schemas/OutputNetflow"
          dynatrace_http: "#/components/schemas/OutputDynatraceHttp"
          dynatrace_otlp: "#/components/schemas/OutputDynatraceOtlp"
          sentinel_one_ai_siem: "#/components/schemas/OutputSentinelOneAiSiem"
          chronicle: "#/components/schemas/OutputChronicle"
          databricks: "#/components/schemas/OutputDatabricks"
          microsoft_fabric: "#/components/schemas/OutputMicrosoftFabric"
          cloudflare_r2: "#/components/schemas/OutputCloudflareR2"
    RunnableJobCollection:
      required:
        - collector
        - run
      properties:
        id:
          type: string
          title: Job ID
          pattern: ^[a-zA-Z0-9_-]+$
          description: Unique ID for this Job
        description:
          type: string
          title: Description
        type:
          type: string
          title: Job type
          enum:
            - collection
            - executor
            - scheduledSearch
          x-speakeasy-unknown-values: allow
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        removeFields:
          type: array
          title: Remove Discover fields
          description: List of fields to remove from Discover results. Wildcards (for
            example, aws*) are allowed. This is useful when discovery returns
            sensitive fields that should not be exposed in the Jobs user
            interface.
          minItems: 0
          default: []
          items:
            type: string
            title: Items
            description: List of fields to remove from Discover results
        resumeOnBoot:
          type: boolean
          title: Resume job on boot
          description: Resume the ad hoc job if a failure condition causes Stream to
            restart during job execution
          default: false
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        schedule:
          type: object
          title: Schedule
          description: Configuration for a scheduled job
          properties:
            enabled:
              type: boolean
              title: Enabled
              description: Enable to configure scheduling for this Collector
            skippable:
              type: boolean
              title: Skippable
              description: Skippable jobs can be delayed, up to their next run time, if the
                system is hitting concurrency limits
              default: true
            resumeMissed:
              type: boolean
              title: Resume missed runs
              description: If Stream Leader (or single instance) restarts, run all missed jobs
                according to their original schedules
              default: false
            cronSchedule:
              type: string
              title: Cron schedule
              description: A cron schedule on which to run this job
              default: "*/5 * * * *"
            maxConcurrentRuns:
              type: number
              title: Concurrent run limit
              description: The maximum number of instances of this scheduled job that may be
                running at any time
              default: 1
              minimum: 1
            run:
              type: object
              title: Run settings
              if:
                properties:
                  type:
                    enum:
                      - collection
                    x-speakeasy-unknown-values: allow
              then:
                type: object
                required:
                  - mode
                properties:
                  rescheduleDroppedTasks:
                    type: boolean
                    title: Reschedule tasks
                    description: Reschedule tasks that failed with non-fatal errors
                    default: true
                  maxTaskReschedule:
                    type: number
                    title: Task reschedule limit
                    description: Maximum number of times a task can be rescheduled
                    default: 1
                    minimum: 1
                  logLevel:
                    type: string
                    title: Log level
                    description: Level at which to set task logging
                    enum:
                      - error
                      - warn
                      - info
                      - debug
                      - silly
                    default: info
                    x-speakeasy-unknown-values: allow
                  jobTimeout:
                    title: Job timeout
                    type: string
                    description: "Maximum time the job is allowed to run. Time unit defaults to
                      seconds if not specified (examples: 30, 45s, 15m). Enter 0
                      for unlimited time."
                    pattern: \d+[sm]?$
                    default: "0"
                  mode:
                    type: string
                    title: Mode
                    description: Job run mode. Preview will either return up to N matching results,
                      or will run until capture time T is reached. Discovery
                      will gather the list of files to turn into streaming
                      tasks, without running the data collection job. Full Run
                      will run the collection job.
                    default: list
                  timeRangeType:
                    type: string
                    title: Time range
                    default: relative
                  earliest:
                    type: number
                    title: Earliest
                    description: Earliest time to collect data for the selected timezone
                  latest:
                    type: number
                    title: Latest
                    description: Latest time to collect data for the selected timezone
                  timestampTimezone: {}
                  timeWarning:
                    type: object
                    properties: {}
                  expression:
                    type: string
                    title: Filter
                    description: A filter for tokens in the provided collect path and/or the events
                      being collected
                    default: "true"
                  minTaskSize:
                    type: string
                    title: Lower task bundle size
                    description: >-
                      Limits the bundle size for small tasks. For example,
                              if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
                    default: 1MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
                  maxTaskSize:
                    type: string
                    title: Upper task bundle size
                    description: >-
                      Limits the bundle size for files above the lower task
                      bundle size. For example, if your upper bundle size is
                      10MB,
                              you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
                    default: 10MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
              else: false
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        workerAffinity:
          type: boolean
          title: Worker affinity
          description: If enabled, tasks are created and run by the same Worker Node
          default: false
        collector:
          type: object
          required:
            - type
            - conf
          properties:
            type:
              type: string
              title: Collector type
              description: The type of collector to run
            conf:
              type: object
              title: Collector-specific settings
              properties: {}
            destructive:
              type: boolean
              title: Destructive
              description: Delete any files collected (where applicable)
              default: false
            encoding:
              type: string
              title: Encoding
              description: Character encoding to use when parsing ingested data. When not set,
                @{product} will default to UTF-8 but may incorrectly interpret
                multi-byte characters.
        input:
          type: object
          properties:
            type:
              type: string
              enum:
                - collection
              default: collection
              x-speakeasy-unknown-values: allow
            breakerRulesets:
              type: array
              title: Event Breaker rulesets
              description: A list of event-breaking rulesets that will be applied, in order,
                to the input data stream
              items:
                type: string
            staleChannelFlushMs:
              type: number
              title: Event Breaker buffer timeout (ms)
              description: How long (in milliseconds) the Event Breaker will wait for new data
                to be sent to a specific channel before flushing the data stream
                out, as is, to the Pipelines
              default: 10000
              minimum: 10
              maximum: 43200000
            sendToRoutes:
              type: boolean
              title: Send to Routes
              description: Send events to normal routing and event processing. Disable to
                select a specific Pipeline/Destination combination.
              default: true
            preprocess:
              type: object
              required:
                - disabled
              properties:
                disabled:
                  type: boolean
                  title: Disabled
                  default: true
                command:
                  type: string
                  title: Command
                  description: Command to feed the data through (via stdin) and process its output
                    (stdout)
                args:
                  type: array
                  title: Arguments
                  description: Arguments to be added to the custom command
                  items:
                    type: string
            throttleRatePerSec:
              type: string
              title: Throttling
              description: "Rate (in bytes per second) to throttle while writing to an output.
                Accepts values with multiple-byte units, such as KB, MB, and GB.
                (Example: 42 MB) Default value of 0 specifies no throttling."
              pattern: ^[\d.]+(\s[KMGTPEZYkmgtpezy][Bb])?$
              default: "0"
            metadata:
              type: array
              title: Fields
              description: Fields to add to events from this input
              items:
                type: object
                required:
                  - name
                  - value
                properties:
                  name:
                    type: string
                    title: Field Name
                  value:
                    type: string
                    title: Value
                    description: JavaScript expression to compute field's value, enclosed in quotes
                      or backticks. (Can evaluate to a constant.)
            pipeline:
              type: string
              title: Pipeline
              description: Pipeline to process results
            output:
              type: string
              title: Destination
              description: Destination to send results to
        run:
          type: object
          required:
            - mode
          properties:
            rescheduleDroppedTasks:
              type: boolean
              title: Reschedule tasks
              description: Reschedule tasks that failed with non-fatal errors
              default: true
            maxTaskReschedule:
              type: number
              title: Task reschedule limit
              description: Maximum number of times a task can be rescheduled
              default: 1
              minimum: 1
            logLevel:
              type: string
              title: Log level
              description: Level at which to set task logging
              enum:
                - error
                - warn
                - info
                - debug
                - silly
              default: info
              x-speakeasy-unknown-values: allow
            jobTimeout:
              title: Job timeout
              type: string
              description: "Maximum time the job is allowed to run. Time unit defaults to
                seconds if not specified (examples: 30, 45s, 15m). Enter 0 for
                unlimited time."
              pattern: \d+[sm]?$
              default: "0"
            mode:
              type: string
              title: Mode
              description: Job run mode. Preview will either return up to N matching results,
                or will run until capture time T is reached. Discovery will
                gather the list of files to turn into streaming tasks, without
                running the data collection job. Full Run will run the
                collection job.
              default: list
              enum:
                - list
                - preview
                - run
              x-speakeasy-unknown-values: allow
            timeRangeType:
              type: string
              title: Time range
              default: relative
              enum:
                - absolute
                - relative
              x-speakeasy-unknown-values: allow
            earliest:
              type: number
              title: Earliest
              description: Earliest time to collect data for the selected timezone
            latest:
              type: number
              title: Latest
              description: Latest time to collect data for the selected timezone
            timestampTimezone:
              type: string
              title: Range timezone
              description: Timezone to use for Earliest and Latest times
              default: UTC
            timeWarning:
              type: object
              properties: {}
            expression:
              type: string
              title: Filter
              description: A filter for tokens in the provided collect path and/or the events
                being collected
              default: "true"
            minTaskSize:
              type: string
              title: Lower task bundle size
              description: >-
                Limits the bundle size for small tasks. For example,
                        if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
              default: 1MB
              pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
            maxTaskSize:
              type: string
              title: Upper task bundle size
              description: >-
                Limits the bundle size for files above the lower task bundle
                size. For example, if your upper bundle size is 10MB,
                        you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
              default: 10MB
              pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
            discoverToRoutes:
              type: boolean
              title: Send to Routes
              description: Send discover results to Routes
              default: false
            capture:
              type: object
              title: Capture Settings
              properties:
                duration:
                  type: number
                  title: Capture time (sec)
                  description: Amount of time to keep capture open, in seconds
                  minimum: 1
                  default: 60
                maxEvents:
                  type: number
                  title: Capture up to N events
                  description: Maximum number of events to capture
                  default: 100
                  minimum: 1
                  maximum: 10000
                level:
                  type: integer
                  title: Where to capture
                  enum:
                    - 0
                    - 1
                    - 2
                    - 3
                  x-speakeasy-enum-descriptions:
                    - 1. Before pre-processing Pipeline
                    - 2. Before the Routes
                    - 3. Before post-processing Pipeline
                    - 4. Before the Destination
                  default: 0
                  x-speakeasy-unknown-values: allow
      type: object
    RunnableJobExecutor:
      required:
        - executor
        - run
      properties:
        id:
          type: string
          title: Job ID
          pattern: ^[a-zA-Z0-9_-]+$
          description: Unique ID for this Job
        description:
          type: string
          title: Description
        type:
          type: string
          title: Job type
          enum:
            - collection
            - executor
            - scheduledSearch
          x-speakeasy-unknown-values: allow
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        removeFields:
          type: array
          title: Remove Discover fields
          description: List of fields to remove from Discover results. Wildcards (for
            example, aws*) are allowed. This is useful when discovery returns
            sensitive fields that should not be exposed in the Jobs user
            interface.
          minItems: 0
          default: []
          items:
            type: string
            title: Items
            description: List of fields to remove from Discover results
        resumeOnBoot:
          type: boolean
          title: Resume job on boot
          description: Resume the ad hoc job if a failure condition causes Stream to
            restart during job execution
          default: false
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        schedule:
          type: object
          title: Schedule
          description: Configuration for a scheduled job
          properties:
            enabled:
              type: boolean
              title: Enabled
              description: Enable to configure scheduling for this Collector
            skippable:
              type: boolean
              title: Skippable
              description: Skippable jobs can be delayed, up to their next run time, if the
                system is hitting concurrency limits
              default: true
            resumeMissed:
              type: boolean
              title: Resume missed runs
              description: If Stream Leader (or single instance) restarts, run all missed jobs
                according to their original schedules
              default: false
            cronSchedule:
              type: string
              title: Cron schedule
              description: A cron schedule on which to run this job
              default: "*/5 * * * *"
            maxConcurrentRuns:
              type: number
              title: Concurrent run limit
              description: The maximum number of instances of this scheduled job that may be
                running at any time
              default: 1
              minimum: 1
            run:
              type: object
              title: Run settings
              if:
                properties:
                  type:
                    enum:
                      - collection
                    x-speakeasy-unknown-values: allow
              then:
                type: object
                required:
                  - mode
                properties:
                  rescheduleDroppedTasks:
                    type: boolean
                    title: Reschedule tasks
                    description: Reschedule tasks that failed with non-fatal errors
                    default: true
                  maxTaskReschedule:
                    type: number
                    title: Task reschedule limit
                    description: Maximum number of times a task can be rescheduled
                    default: 1
                    minimum: 1
                  logLevel:
                    type: string
                    title: Log level
                    description: Level at which to set task logging
                    enum:
                      - error
                      - warn
                      - info
                      - debug
                      - silly
                    default: info
                    x-speakeasy-unknown-values: allow
                  jobTimeout:
                    title: Job timeout
                    type: string
                    description: "Maximum time the job is allowed to run. Time unit defaults to
                      seconds if not specified (examples: 30, 45s, 15m). Enter 0
                      for unlimited time."
                    pattern: \d+[sm]?$
                    default: "0"
                  mode:
                    type: string
                    title: Mode
                    description: Job run mode. Preview will either return up to N matching results,
                      or will run until capture time T is reached. Discovery
                      will gather the list of files to turn into streaming
                      tasks, without running the data collection job. Full Run
                      will run the collection job.
                    default: list
                  timeRangeType:
                    type: string
                    title: Time range
                    default: relative
                  earliest:
                    type: number
                    title: Earliest
                    description: Earliest time to collect data for the selected timezone
                  latest:
                    type: number
                    title: Latest
                    description: Latest time to collect data for the selected timezone
                  timestampTimezone: {}
                  timeWarning:
                    type: object
                    properties: {}
                  expression:
                    type: string
                    title: Filter
                    description: A filter for tokens in the provided collect path and/or the events
                      being collected
                    default: "true"
                  minTaskSize:
                    type: string
                    title: Lower task bundle size
                    description: >-
                      Limits the bundle size for small tasks. For example,
                              if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
                    default: 1MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
                  maxTaskSize:
                    type: string
                    title: Upper task bundle size
                    description: >-
                      Limits the bundle size for files above the lower task
                      bundle size. For example, if your upper bundle size is
                      10MB,
                              you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
                    default: 10MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
              else: false
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        executor:
          type: object
          required:
            - type
          properties:
            type:
              type: string
              title: Executor type
              description: The type of executor to run
            storeTaskResults:
              type: boolean
              title: Store task results
              description: Determines whether or not to write task results to disk
              default: true
            conf:
              type: object
              title: Executor-specific settings
              properties: {}
        run:
          type: object
          properties:
            rescheduleDroppedTasks:
              type: boolean
              title: Reschedule tasks
              description: Reschedule tasks that failed with non-fatal errors
              default: true
            maxTaskReschedule:
              type: number
              title: Task reschedule limit
              description: Maximum number of times a task can be rescheduled
              default: 1
              minimum: 1
            logLevel:
              type: string
              title: Log level
              description: Level at which to set task logging
              enum:
                - error
                - warn
                - info
                - debug
                - silly
              default: info
              x-speakeasy-unknown-values: allow
            jobTimeout:
              title: Job timeout
              type: string
              description: "Maximum time the job is allowed to run. Time unit defaults to
                seconds if not specified (examples: 30, 45s, 15m). Enter 0 for
                unlimited time."
              pattern: \d+[sm]?$
              default: "0"
      type: object
    RunnableJobScheduledSearch:
      required:
        - savedQueryId
        - type
      properties:
        id:
          type: string
          title: Job ID
          pattern: ^[a-zA-Z0-9_-]+$
          description: Unique ID for this Job
        description:
          type: string
          title: Description
        type:
          type: string
          title: Job type
          enum:
            - collection
            - executor
            - scheduledSearch
          x-speakeasy-unknown-values: allow
        ttl:
          type: string
          title: Time to live
          description: Time to keep the job's artifacts on disk after job completion. This
            also affects how long a job is listed in the Job Inspector.
          pattern: \d+[smh]$
          default: 4h
        ignoreGroupJobsLimit:
          type: boolean
          title: Ignore Worker Group job limits
          description: When enabled, this job's artifacts are not counted toward the
            Worker Group's finished job artifacts limit. Artifacts will be
            removed only after the Collector's configured time to live.
          default: false
        removeFields:
          type: array
          title: Remove Discover fields
          description: List of fields to remove from Discover results. Wildcards (for
            example, aws*) are allowed. This is useful when discovery returns
            sensitive fields that should not be exposed in the Jobs user
            interface.
          minItems: 0
          default: []
          items:
            type: string
            title: Items
            description: List of fields to remove from Discover results
        resumeOnBoot:
          type: boolean
          title: Resume job on boot
          description: Resume the ad hoc job if a failure condition causes Stream to
            restart during job execution
          default: false
        environment:
          type: string
          title: Environment
          description: Optionally, enable this config only on a specified Git branch. If
            empty, will be enabled everywhere.
        schedule:
          type: object
          title: Schedule
          description: Configuration for a scheduled job
          properties:
            enabled:
              type: boolean
              title: Enabled
              description: Enable to configure scheduling for this Collector
            skippable:
              type: boolean
              title: Skippable
              description: Skippable jobs can be delayed, up to their next run time, if the
                system is hitting concurrency limits
              default: true
            resumeMissed:
              type: boolean
              title: Resume missed runs
              description: If Stream Leader (or single instance) restarts, run all missed jobs
                according to their original schedules
              default: false
            cronSchedule:
              type: string
              title: Cron schedule
              description: A cron schedule on which to run this job
              default: "*/5 * * * *"
            maxConcurrentRuns:
              type: number
              title: Concurrent run limit
              description: The maximum number of instances of this scheduled job that may be
                running at any time
              default: 1
              minimum: 1
            run:
              type: object
              title: Run settings
              if:
                properties:
                  type:
                    enum:
                      - collection
                    x-speakeasy-unknown-values: allow
              then:
                type: object
                required:
                  - mode
                properties:
                  rescheduleDroppedTasks:
                    type: boolean
                    title: Reschedule tasks
                    description: Reschedule tasks that failed with non-fatal errors
                    default: true
                  maxTaskReschedule:
                    type: number
                    title: Task reschedule limit
                    description: Maximum number of times a task can be rescheduled
                    default: 1
                    minimum: 1
                  logLevel:
                    type: string
                    title: Log level
                    description: Level at which to set task logging
                    enum:
                      - error
                      - warn
                      - info
                      - debug
                      - silly
                    default: info
                    x-speakeasy-unknown-values: allow
                  jobTimeout:
                    title: Job timeout
                    type: string
                    description: "Maximum time the job is allowed to run. Time unit defaults to
                      seconds if not specified (examples: 30, 45s, 15m). Enter 0
                      for unlimited time."
                    pattern: \d+[sm]?$
                    default: "0"
                  mode:
                    type: string
                    title: Mode
                    description: Job run mode. Preview will either return up to N matching results,
                      or will run until capture time T is reached. Discovery
                      will gather the list of files to turn into streaming
                      tasks, without running the data collection job. Full Run
                      will run the collection job.
                    default: list
                  timeRangeType:
                    type: string
                    title: Time range
                    default: relative
                  earliest:
                    type: number
                    title: Earliest
                    description: Earliest time to collect data for the selected timezone
                  latest:
                    type: number
                    title: Latest
                    description: Latest time to collect data for the selected timezone
                  timestampTimezone: {}
                  timeWarning:
                    type: object
                    properties: {}
                  expression:
                    type: string
                    title: Filter
                    description: A filter for tokens in the provided collect path and/or the events
                      being collected
                    default: "true"
                  minTaskSize:
                    type: string
                    title: Lower task bundle size
                    description: >-
                      Limits the bundle size for small tasks. For example,
                              if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
                    default: 1MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
                  maxTaskSize:
                    type: string
                    title: Upper task bundle size
                    description: >-
                      Limits the bundle size for files above the lower task
                      bundle size. For example, if your upper bundle size is
                      10MB,
                              you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
                    default: 10MB
                    pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
              else: false
        streamtags:
          type: array
          title: Tags
          description: Tags for filtering and grouping in @{product}
          default: []
          items:
            type: string
        savedQueryId:
          type: string
          title: ID of the SavedQuery
          description: Identifies which search query to run
      type: object
    RunnableJob:
      oneOf:
        - $ref: "#/components/schemas/RunnableJobCollection"
        - $ref: "#/components/schemas/RunnableJobExecutor"
        - $ref: "#/components/schemas/RunnableJobScheduledSearch"
    JobStatus:
      type: object
      properties:
        reason:
          type: object
          additionalProperties: true
        state:
          type: integer
          description: State of the Job
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
          x-speakeasy-enums:
            - Initializing
            - Pending
            - Running
            - Paused
            - Cancelled
            - Finished
            - Failed
            - Orphaned
            - Unknown
            - Length
          x-speakeasy-unknown-values: allow
      required:
        - state
    JobInfo:
      type: object
      properties:
        args:
          $ref: "#/components/schemas/RunnableJob"
        id:
          type: string
        keep:
          type: boolean
        stats:
          type: object
          additionalProperties:
            oneOf:
              - type: number
              - type: object
                additionalProperties:
                  type: number
        status:
          $ref: "#/components/schemas/JobStatus"
      required:
        - args
        - id
        - stats
        - status
    OutputSamplesResponse:
      type: object
      properties:
        events:
          type: array
          items:
            type: object
            additionalProperties: true
      required:
        - events
    OutputTestResponse:
      type: object
      properties:
        details:
          type: object
          additionalProperties: true
        error:
          type: string
        outputId:
          type: string
        success:
          type: boolean
        successDetail:
          type: string
      required:
        - outputId
        - success
    CriblEvent:
      type: object
      properties:
        _raw:
          type: string
      required:
        - _raw
    OutputTestRequest:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: "#/components/schemas/CriblEvent"
      required:
        - events
    SchemaLibEntry:
      type: object
      additionalProperties: true
      required:
        - id
        - schema
      properties:
        id:
          type: string
          title: ID
          pattern: ^[a-zA-Z0-9_-]+$
        description:
          type: string
          title: Description
        schema:
          type: string
          title: Schema
          description: JSON schema matching standards of draft version 2019-09
    ProfilerItem:
      type: object
      properties:
        createTime:
          type: number
        id:
          type: string
        size:
          type: number
        workerId:
          type: string
      required:
        - id
    RoutesRoute:
      type: object
      additionalProperties: true
      required:
        - pipeline
        - name
      properties:
        id:
          type: string
          title: Route ID
        name:
          type: string
          title: Route name
        disabled:
          type: boolean
          title: Disabled
          description: Disable this routing rule
        filter:
          type: string
          title: Filter
          description: JavaScript expression to select data to route
          default: "true"
        pipeline:
          type: string
          title: Pipeline
          description: Pipeline to send the matching data to
        enableOutputExpression:
          type: boolean
          title: Enable expression
          description: Enable to use a JavaScript expression that evaluates to the name of
            the Description below
          default: false
        output: {}
        outputExpression: {}
        description:
          type: string
          title: Description
        final:
          title: Final
          description: Flag to control whether the event gets consumed by this Route
            (Final), or cloned into it
          type: boolean
          default: true
    Routes:
      type: object
      additionalProperties: false
      required:
        - routes
      properties:
        id:
          type: string
          title: ID
          description: Routes ID
        routes:
          type: array
          title: Route
          description: Pipeline routing rules
          items:
            $ref: "#/components/schemas/RoutesRoute"
        groups:
          type: object
          additionalProperties:
            type: object
            required:
              - name
            properties:
              name:
                type: string
                title: Group Name
              description:
                type: string
                title: Description
                description: Short description of this group
              disabled:
                type: boolean
                title: Disabled
                description: Whether this group is disabled
        comments:
          type: array
          title: Comments
          description: Comments
          items:
            type: object
            properties:
              comment:
                type: string
                title: Comment
                description: Optional, short description of this Route's purpose
            additionalProperties: true
    RouteCloneConf:
      type: object
      title: Fields
      description: Key value pairs to set/overwrite in the clone
      properties: {}
      additionalProperties:
        type: string
        title: Clone fields
    RouteConf:
      type: object
      properties:
        clones:
          type: array
          items:
            $ref: "#/components/schemas/RouteCloneConf"
        context:
          type: string
        description:
          type: string
        disabled:
          type: boolean
        enableOutputExpression:
          type: boolean
        filter:
          type: string
        final:
          type: boolean
        groupId:
          type: string
        id:
          type: string
        name:
          type: string
        output:
          type: string
        outputExpression:
          type: string
        pipeline:
          type: string
      required:
        - final
        - id
        - name
        - pipeline
    RouteDefinitions:
      type: array
      items:
        $ref: "#/components/schemas/RouteConf"
    SecretType:
      type: string
      enum:
        - text
        - keypair
        - credentials
      x-speakeasy-unknown-values: allow
    RestSecret:
      type: object
      properties:
        apiKey:
          type: string
        description:
          type: string
        id:
          type: string
        password:
          type: string
        secretKey:
          type: string
        secretType:
          $ref: "#/components/schemas/SecretType"
        tags:
          type: string
        username:
          type: string
        value:
          type: string
      required:
        - id
        - secretType
    HealthStringType:
      type: string
      enum:
        - Green
        - Yellow
        - Red
        - Unknown
      x-speakeasy-unknown-values: allow
    HealthCountType:
      type: object
      properties:
        Green:
          type: number
        Yellow:
          type: number
        Red:
          type: number
        Unknown:
          type: number
      required:
        - Green
        - Red
        - Unknown
        - Yellow
    InputStatus:
      type: object
      properties:
        id:
          type: string
        status:
          type: object
          properties:
            error:
              type: object
              properties:
                details:
                  type: object
                  additionalProperties: true
                message:
                  type: string
              required:
                - message
            health:
              $ref: "#/components/schemas/HealthStringType"
            healthCounts:
              $ref: "#/components/schemas/HealthCountType"
            metrics:
              type: object
              additionalProperties: true
            pq:
              type: object
              properties:
                error:
                  type: object
                  properties:
                    details:
                      type: object
                      additionalProperties: true
                    message:
                      type: string
                  required:
                    - message
                health:
                  $ref: "#/components/schemas/HealthStringType"
                healthCounts:
                  $ref: "#/components/schemas/HealthCountType"
                timestamp:
                  type: number
              required:
                - health
                - healthCounts
                - timestamp
            timestamp:
              type: number
          required:
            - health
            - healthCounts
            - metrics
            - timestamp
      required:
        - id
        - status
    OutputStatus:
      type: object
      properties:
        id:
          type: string
        status:
          type: object
          properties:
            error:
              type: object
              properties:
                details:
                  type: object
                  additionalProperties: true
                message:
                  type: string
              required:
                - message
            health:
              $ref: "#/components/schemas/HealthStringType"
            healthCounts:
              $ref: "#/components/schemas/HealthCountType"
            metrics:
              type: object
              additionalProperties: true
            pq:
              type: object
              properties:
                error:
                  type: object
                  properties:
                    details:
                      type: object
                      additionalProperties: true
                    message:
                      type: string
                  required:
                    - message
                health:
                  $ref: "#/components/schemas/HealthStringType"
                healthCounts:
                  $ref: "#/components/schemas/HealthCountType"
                timestamp:
                  type: number
              required:
                - health
                - healthCounts
                - timestamp
            timestamp:
              type: number
          required:
            - health
            - healthCounts
            - metrics
            - timestamp
      required:
        - id
        - status
    AppScopeProcessingStatus:
      type: string
      nullable: true
      enum:
        - normal
        - attaching
        - attach_failed
        - updating
        - update_failed
        - detaching
        - detached
        - detach_failed
      x-speakeasy-unknown-values: allow
    AppScopeProcessStatus:
      type: string
      nullable: true
      enum:
        - green
        - yellow
        - red
      x-speakeasy-unknown-values: allow
    AppScopeProcess:
      type: object
      properties:
        cfg:
          $ref: "#/components/schemas/AppscopeConfigWithCustom"
        config_id:
          type: string
        id:
          type: string
        interfaces:
          type: array
          items:
            type: object
            properties:
              config:
                type: string
              connected:
                type: boolean
              name:
                type: string
        lastError:
          type: string
        process:
          type: object
          properties:
            hostPid:
              type: number
            id:
              type: string
            machine_id:
              type: string
            pid:
              type: number
            uuid:
              type: string
          required:
            - pid
        processingStatus:
          $ref: "#/components/schemas/AppScopeProcessingStatus"
        source_id:
          type: string
        status:
          $ref: "#/components/schemas/AppScopeProcessStatus"
      required:
        - id
    EdgeFileInspectResponse:
      type: object
    SymLinkInfo:
      type: object
      properties:
        symLinkTarget:
          type: string
        symLinkTargetAbsolutePath:
          type: string
        symLinkTargetIsDirectory:
          type: boolean
        symLinkTargetIsFile:
          type: boolean
      required:
        - symLinkTarget
        - symLinkTargetAbsolutePath
    FilesystemEntry:
      type: object
      properties:
        mode:
          type: string
        name:
          type: string
        stats:
          type: object
          additionalProperties: true
        symLinkInfo:
          $ref: "#/components/schemas/SymLinkInfo"
        type:
          type: string
      required:
        - name
        - type
    EdgeMapQueryResult:
      type: object
      properties:
        __worker_info:
          type: object
          properties:
            hostname:
              type: string
          required:
            - hostname
        __worker_node:
          type: string
      required:
        - __worker_info
        - __worker_node
    AwsMetadata:
      type: object
      properties:
        hostname:
          type: string
        identity:
          type: object
          additionalProperties: true
        public_ipv4:
          type: string
        roles:
          type: array
          items:
            type: string
        security_groups:
          type: array
          items:
            type: string
        tags:
          type: object
        version:
          type: number
      required:
        - version
    CriblMetadata:
      type: object
      properties:
        config_version:
          type: string
        group:
          type: string
        install_type:
          type: string
        mode:
          type: string
        tags:
          type: array
          items:
            type: string
        version:
          type: string
      required:
        - mode
        - version
    EnvMetadata:
      type: object
    NetworkInterfaces:
      type: object
    OsMetadata:
      type: object
      properties:
        arch:
          type: string
        cpu_count:
          type: number
        cpu_speed_mhz:
          type: number
        cpu_type:
          type: string
        gid:
          type: number
        homedir:
          type: string
        hostname:
          type: string
        interfaces:
          $ref: "#/components/schemas/NetworkInterfaces"
        machine_id:
          type: string
        memory:
          type: number
        os_id:
          type: string
        os_name:
          type: string
        os_version:
          type: string
        os_version_id:
          type: string
        platform:
          type: string
        release:
          type: string
        timezone:
          type: string
        timezone_offset:
          type: string
        uid:
          type: number
        username:
          type: string
      required:
        - arch
        - cpu_count
        - cpu_speed_mhz
        - cpu_type
        - gid
        - homedir
        - hostname
        - interfaces
        - machine_id
        - memory
        - os_id
        - os_name
        - os_version
        - os_version_id
        - platform
        - release
        - timezone
        - timezone_offset
        - uid
        - username
    KubeMetadata:
      type: object
      properties:
        cluster:
          type: object
          additionalProperties: true
        container:
          type: object
          additionalProperties: true
        namespace:
          type: string
        node:
          type: object
          additionalProperties: true
        pod:
          type: object
          additionalProperties: true
        source:
          type: string
      required:
        - namespace
        - source
    Metadata:
      type: object
      properties:
        aws:
          $ref: "#/components/schemas/AwsMetadata"
        cribl:
          $ref: "#/components/schemas/CriblMetadata"
        env:
          $ref: "#/components/schemas/EnvMetadata"
        hostOs:
          $ref: "#/components/schemas/OsMetadata"
        kube:
          $ref: "#/components/schemas/KubeMetadata"
        os:
          $ref: "#/components/schemas/OsMetadata"
        timestamp:
          type: number
      required:
        - timestamp
    SampleFile:
      type: object
      properties:
        bytes:
          type: string
        bytesRead:
          type: number
        length:
          type: number
      required:
        - bytes
        - bytesRead
        - length
    CrudEntityBase:
      type: object
      properties:
        id:
          type: string
      required:
        - id
    MultiFactorAuthSchema:
      type: object
      properties:
        accessControlAllowOrigin:
          type: string
        allowLogin:
          type: boolean
        apiServerUrl:
          type: string
        disabled:
          type: boolean
        type:
          type: string
          enum:
            - piv
          x-speakeasy-unknown-values: allow
        usernameField:
          type: string
        usernameRegex:
          type: string
      required:
        - accessControlAllowOrigin
        - allowLogin
        - apiServerUrl
        - disabled
        - type
        - usernameField
        - usernameRegex
    AuthToken:
      type: object
      properties:
        forcePasswordChange:
          type: boolean
        token:
          type: string
      required:
        - forcePasswordChange
        - token
    LoginInfo:
      type: object
      properties:
        password:
          type: string
        username:
          type: string
      required:
        - password
        - username
    RedirectInfo:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        redirectUrl:
          type: string
        token:
          type: string
    AuthPolicyEntry:
      type: object
      properties:
        actions:
          type: array
          items:
            type: string
        object:
          type: string
      required:
        - actions
        - object
    CaptureLevel:
      type: integer
      enum:
        - 0
        - 1
        - 2
        - 3
      x-speakeasy-unknown-values: allow
    CaptureParams:
      type: object
      properties:
        duration:
          type: number
        filter:
          type: string
        level:
          $ref: "#/components/schemas/CaptureLevel"
        maxEvents:
          type: number
        stepDuration:
          type: number
        workerId:
          type: string
        workerThreshold:
          type: number
      required:
        - duration
        - filter
        - level
        - maxEvents
    ChangelogState:
      type: object
      properties:
        lastViewedCurrent:
          type: string
        lastViewedUpgrade:
          type: string
    ClickHouseDescriptionColumn:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
      required:
        - name
        - type
    ClickHouseDescriptionResult:
      type: object
      properties:
        description:
          type: array
          items:
            $ref: "#/components/schemas/ClickHouseDescriptionColumn"
        errorMsg:
          type: string
        success:
          type: boolean
      required:
        - success
    HTTPOutAuthConfig:
      type: object
      properties:
        disabled:
          type: boolean
        password:
          type: string
        token:
          type: string
        username:
          type: string
    CrudPolicy:
      type: object
      properties:
        Create:
          type: array
          items:
            $ref: "#/components/schemas/AuthPolicyEntry"
        Delete:
          type: array
          items:
            $ref: "#/components/schemas/AuthPolicyEntry"
        List:
          type: array
          items:
            $ref: "#/components/schemas/AuthPolicyEntry"
        Read:
          type: array
          items:
            $ref: "#/components/schemas/AuthPolicyEntry"
        Replace:
          type: array
          items:
            $ref: "#/components/schemas/AuthPolicyEntry"
        Update:
          type: array
          items:
            $ref: "#/components/schemas/AuthPolicyEntry"
      required:
        - Create
        - Delete
        - List
        - Read
        - Replace
        - Update
    Expression:
      $ref: "#/components/schemas/CrudPolicy"
    NameValue:
      type: object
      properties:
        name:
          type: string
        value:
          $ref: "#/components/schemas/Expression"
      required:
        - name
        - value
    HTTPOutExtraParamConfig:
      type: object
      properties:
        name:
          type: string
        value:
          type: object
          additionalProperties: true
      required:
        - name
        - value
    Format:
      type: string
      enum:
        - json-compact-each-row-with-names
        - json-each-row
      x-speakeasy-unknown-values: allow
    MappingType:
      type: string
      enum:
        - automatic
        - custom
      x-speakeasy-unknown-values: allow
    HTTPOutResponseRetryConfig:
      type: object
      properties:
        backoffRate:
          type: number
        disableJitter:
          type: boolean
        httpStatus:
          type: number
        initialBackoff:
          type: number
        maxBackoff:
          type: number
    RetryBackoffOptions:
      type: object
      properties:
        backoffRate:
          type: number
        disableJitter:
          type: boolean
        initialBackoff:
          type: number
        maxBackoff:
          type: number
    TLSClientParams:
      type: object
      properties:
        caPath:
          type: string
        certPath:
          type: string
        checkServerIdentity:
          type: object
        disabled:
          type: boolean
        maxVersion:
          $ref: "#/components/schemas/SecureVersion"
        minVersion:
          $ref: "#/components/schemas/SecureVersion"
        passphrase:
          type: string
        privKeyPath:
          type: string
        rejectUnauthorized:
          type: boolean
        servername:
          type: string
      required:
        - disabled
    CHOutConfig:
      type: object
      properties:
        asyncInserts:
          type: boolean
        auth:
          $ref: "#/components/schemas/HTTPOutAuthConfig"
        authType:
          type: string
          enum:
            - token
            - none
            - textSecret
            - basic
            - credentialsSecret
            - secret
            - manual
            - manualAPIKey
            - sslUserCertificate
          x-speakeasy-unknown-values: allow
        columnMappings:
          type: array
          items:
            type: object
            properties:
              columnName:
                type: string
              columnType:
                type: string
              columnValueExpression:
                type: string
            required:
              - columnName
              - columnType
              - columnValueExpression
        compress:
          type: boolean
        concurrency:
          type: number
        database:
          type: string
        dumpFormatErrorsToDisk:
          type: boolean
        excludeMappingFields:
          type: array
          items:
            type: string
        extraHttpHeaders:
          type: array
          items:
            $ref: "#/components/schemas/NameValue"
        extraParams:
          type: array
          items:
            $ref: "#/components/schemas/HTTPOutExtraParamConfig"
        failedRequestLoggingMode:
          type: string
        flushPeriodSec:
          type: number
        format:
          $ref: "#/components/schemas/Format"
        keepAlive:
          type: boolean
        loadBalanced:
          type: boolean
        mappingType:
          $ref: "#/components/schemas/MappingType"
        maxConnectionReuseSec:
          type: number
        maxPayloadEvents:
          type: number
        maxPayloadSizeKB:
          type: number
        maxSockets:
          type: number
        method:
          type: string
        password:
          type: string
        rejectUnauthorized:
          type: boolean
        responseHonorRetryAfterHeader:
          type: boolean
        responseRetrySettings:
          type: array
          items:
            $ref: "#/components/schemas/HTTPOutResponseRetryConfig"
        safeHeaders:
          type: array
          items:
            type: string
        sqlUsername:
          type: string
        tableName:
          type: string
        tableNameExpression:
          type: string
        timeoutRetrySettings:
          $ref: "#/components/schemas/RetryBackoffOptions"
        timeoutSec:
          type: number
        tls:
          $ref: "#/components/schemas/TLSClientParams"
        token:
          type: string
        totalMemoryLimitKB:
          type: number
        url:
          type: string
        urls:
          type: array
        useRoundRobinDns:
          type: boolean
        username:
          type: string
        waitForAsyncInserts:
          type: boolean
      required:
        - asyncInserts
        - database
        - flushPeriodSec
        - format
        - loadBalanced
        - mappingType
        - tableName
        - url
    CluiType:
      type: string
      enum:
        - input
        - output
        - route
        - pipeline
        - knowledge
        - collector
        - pack
        - monitoring
        - monitor
      x-speakeasy-unknown-values: allow
    CluiItem:
      type: object
      properties:
        category:
          type: string
          enum:
            - link
          x-speakeasy-unknown-values: allow
        groupId:
          type: string
        id:
          type: string
        name:
          type: string
        packId:
          type: string
        subType:
          type: string
        type:
          $ref: "#/components/schemas/CluiType"
      required:
        - category
        - type
    DistributedUpgradeRequest:
      type: object
      additionalProperties: false
      properties:
        packageUrls:
          title: Custom Path
          description: Provide your own URLs or local paths for platform-specific Cribl
            packages
          type: array
          items:
            type: object
            required:
              - packageUrl
            properties:
              packageUrl:
                type: string
                title: Platform-Specific Package Location
                description: Package HTTP URL or local path
                pattern: (\d+)\.(\d+)\.?(\d+)?-?([-.a-zA-Z0-9]*)-([a-z0-9]{8})-(linux|darwin|win32)-([0-9a-zA-Z]+)
                minLength: 1
              packageHashUrl:
                type: string
                title: Package Hash Location
                description: Package's MD5 or SHA256 hash HTTP URL or local path
                pattern: (\d+)\.(\d+)\.?(\d+)?-?([-.a-zA-Z0-9]*)-([a-z0-9]{8})-(linux|darwin|win32)-([0-9a-zA-Z]+)\.(tgz|msi|pkg)?\.(md5|sha256)
                minLength: 1
        upgradePercentage:
          type: number
          title: Percentage of workers to upgrade
          description: Percentage of the total worker nodes on the group to run the
            upgrade on
          minimum: 0.00001
          maximum: 1
          default: 1
        workerRetries:
          type: number
          title: Worker node connect retry count
          description: Number of times to retry conncecting to a worker node before
            marking the upgrade as failed.
          minimum: 1
          default: 5
        workerRetryDelay:
          type: number
          title: Worker node connect retry delay
          description: Delay between retries
          minimum: 100
          default: 1000
        upgradeMode:
          type: string
          title: Upgrade mode
          enum:
            - rolling
            - regular
            - batch
          x-speakeasy-unknown-values: allow
        versionTo:
          type: string
          title: Exact version to match
    ExprLibEntry:
      type: object
      properties:
        context:
          type: object
          additionalProperties: true
        evalType:
          type: string
        expr:
          type: string
          description: JavaScript expression to evaluate
        id:
          type: string
        pack:
          type: string
        result:
          type: object
          additionalProperties: true
        unprotected:
          type: boolean
      required:
        - expr
        - id
    Function:
      type: object
      properties:
        __conf:
          type: object
          additionalProperties: true
        __filename:
          type: string
        disabled:
          type: boolean
        group:
          type: string
        id:
          type: string
        initTime:
          type: number
        loadTime:
          type: number
        modTime:
          type: number
        name:
          type: string
        uischema:
          type: object
          additionalProperties: true
        version:
          type: string
      required:
        - __conf
        - __filename
        - disabled
        - group
        - id
        - initTime
        - loadTime
        - modTime
        - name
        - uischema
        - version
    Condition:
      $ref: "#/components/schemas/Function"
    HealthServerStatus:
      type: object
      properties:
        role:
          type: string
          enum:
            - standby
            - primary
          x-speakeasy-unknown-values: allow
        startTime:
          type: number
        status:
          type: string
          enum:
            - shutting down
            - healthy
            - standby
          x-speakeasy-unknown-values: allow
      required:
        - startTime
        - status
    HealthyWorkerStatus:
      type: object
      properties:
        status:
          type: string
          enum:
            - healthy
          x-speakeasy-unknown-values: allow
      required:
        - status
    DownWorkerStatus:
      type: object
      properties:
        status:
          type: string
          enum:
            - down
          x-speakeasy-unknown-values: allow
      required:
        - status
    InsightsQueryResponse:
      type: object
      properties:
        timeSeries:
          type: array
          items:
            type: object
            properties:
              dimensions:
                type: object
                additionalProperties:
                  type: string
              name:
                type: string
              points:
                type: array
                items:
                  type: object
                  properties:
                    endTime:
                      type: number
                    startTime:
                      type: number
                    value:
                      type: number
                  required:
                    - endTime
                    - startTime
                    - value
            required:
              - dimensions
              - name
              - points
      required:
        - timeSeries
    InsightsQueryRequest:
      type: object
      properties:
        bucketSize:
          type: number
        dimensionFilters:
          type: array
          items:
            oneOf:
              - type: object
                properties:
                  name:
                    type: string
                  operator:
                    type: string
                    enum:
                      - eq
                    x-speakeasy-unknown-values: allow
                  value:
                    type: string
                required:
                  - name
                  - operator
                  - value
              - type: object
                properties:
                  name:
                    type: string
                  operator:
                    type: string
                    enum:
                      - ne
                    x-speakeasy-unknown-values: allow
                  value:
                    type: string
                required:
                  - name
                  - operator
                  - value
              - type: object
                properties:
                  name:
                    type: string
                  operator:
                    type: string
                    enum:
                      - exists
                    x-speakeasy-unknown-values: allow
                  value:
                    type: boolean
                required:
                  - name
                  - operator
                  - value
        dimensionSplits:
          type: array
          items:
            type: string
        endTime:
          type: number
        metricExpressions:
          type: array
          items:
            type: string
        startTime:
          type: number
      required:
        - metricExpressions
    JobState:
      type: object
      properties:
        id:
          type: string
        state:
          type: string
      required:
        - id
        - state
    JobRunTypes:
      type: string
      enum:
        - adhoc
        - scheduled
        - system
      x-speakeasy-unknown-values: allow
    AUTH_PROVIDER:
      type: string
      enum:
        - token
        - aws-iam
        - aws-ec2
      x-speakeasy-unknown-values: allow
    SECRET_PROVIDER:
      type: string
      enum:
        - local
        - vault
        - aws-kms
      x-speakeasy-unknown-values: allow
    AWSKMSServiceConfig:
      type: object
      properties:
        kmsKeyArn:
          type: string
        region:
          type: string
      required:
        - kmsKeyArn
        - region
    VaultKMSTlsClientConfig:
      type: object
      properties:
        caPath:
          type: string
        certPath:
          type: string
        certificateName:
          type: string
        disabled:
          type: boolean
        maxVersion:
          $ref: "#/components/schemas/SecureVersion"
        minVersion:
          $ref: "#/components/schemas/SecureVersion"
        passphrase:
          type: string
        privKeyPath:
          type: string
        rejectUnauthorized:
          type: boolean
        servername:
          type: string
      required:
        - disabled
    KMSProviderConfig:
      type: object
      properties:
        auth:
          oneOf:
            - type: object
              properties:
                assumeRoleArn:
                  type: string
                assumeRoleExternalId:
                  type: string
                awsApiKey:
                  type: string
                awsAuthenticationMethod:
                  type: string
                awsSecretKey:
                  type: string
                enableAssumeRole:
                  type: boolean
                provider:
                  $ref: "#/components/schemas/AUTH_PROVIDER"
                token:
                  type: string
                vaultAWSIAMServerID:
                  type: string
                vaultRole:
                  type: string
              required:
                - provider
                - vaultAWSIAMServerID
            - type: object
              properties:
                assumeRoleArn:
                  type: string
                assumeRoleExternalId:
                  type: string
                awsApiKey:
                  type: string
                awsAuthenticationMethod:
                  type: string
                awsSecretKey:
                  type: string
                enableAssumeRole:
                  type: boolean
        enableHealthCheck:
          type: boolean
        healthCheckEndpoint:
          type: string
        namespace:
          type: string
        provider:
          $ref: "#/components/schemas/SECRET_PROVIDER"
        secretDir:
          type: string
        service:
          $ref: "#/components/schemas/AWSKMSServiceConfig"
        tls:
          $ref: "#/components/schemas/VaultKMSTlsClientConfig"
        url:
          type: string
      required:
        - enableHealthCheck
        - provider
    KMSHealthStatus:
      type: integer
      enum:
        - 0
        - 1
        - 2
        - 3
      x-speakeasy-unknown-values: allow
    KMSHealthTest:
      type: object
      properties:
        details:
          type: object
          additionalProperties: true
        error:
          type: object
          required:
            - name
            - message
          properties:
            name:
              type: string
            message:
              type: string
            stack:
              type: string
        status:
          $ref: "#/components/schemas/KMSHealthStatus"
      required:
        - status
    KMSHealth:
      type: object
      properties:
        auth:
          $ref: "#/components/schemas/KMSHealthTest"
        connection:
          $ref: "#/components/schemas/KMSHealthTest"
        system:
          $ref: "#/components/schemas/KMSHealthTest"
      required:
        - auth
        - connection
        - system
    License:
      type: object
      properties:
        cls:
          type: string
          enum:
            - prod
            - trial
            - free
          x-speakeasy-unknown-values: allow
        email:
          type: string
        exp:
          type: number
        f_ph:
          type: number
        f_phg:
          type: number
        guid:
          type: string
        iat:
          type: number
        id:
          type: string
        iss:
          type: string
        license:
          type: string
        limits:
          type: object
          properties:
            edge_groups:
              type: number
            edge_procs:
              type: number
            kms:
              type: number
            lake_access_groups:
              type: number
            lake_ddss:
              type: number
            lake_metrics:
              type: number
            lake_storage_locations:
              type: number
            lakehouse:
              type: number
            leader_resiliency:
              type: number
            max_executors_per_search:
              type: number
            notifications:
              type: number
            outpost:
              type: number
            persistent_queue:
              type: number
            projects:
              type: number
            rbac:
              type: number
            remote_auth:
              type: number
            remote_git:
              type: number
            s3_bundle:
              type: number
            sds:
              type: number
            search_acceleration:
              type: number
            search_groups:
              type: number
            system_email:
              type: number
            worker_groups:
              type: number
            worker_procs:
              type: number
        quota:
          type: number
        sub:
          type: string
        title:
          type: string
      required:
        - cls
        - email
        - exp
        - f_ph
        - f_phg
        - guid
        - iat
        - id
        - iss
        - license
        - quota
        - title
    LicenseRequest:
      type: object
      properties:
        license:
          type: string
      required:
        - license
    EdgeUsageMetrics:
      type: object
      properties:
        droppedBytes:
          type: number
        exemptedLicenseInBytes:
          type: number
        inBytes:
          type: number
        inEvents:
          type: number
        inMetricsEvents:
          type: number
        outBytes:
          type: number
        outEvents:
          type: number
      required:
        - exemptedLicenseInBytes
        - inBytes
        - inEvents
        - outBytes
        - outEvents
    GuardUsageMetrics:
      type: object
      properties:
        inBytes:
          type: number
        inEvents:
          type: number
      required:
        - inBytes
        - inEvents
    UsageMetricsExtended:
      type: object
      properties:
        droppedBytes:
          type: number
        edge:
          $ref: "#/components/schemas/EdgeUsageMetrics"
        endTime:
          type: number
        exemptedLicenseInBytes:
          type: number
        guard:
          $ref: "#/components/schemas/GuardUsageMetrics"
        inBytes:
          type: number
        inEvents:
          type: number
        inMetricsEvents:
          type: number
        outBytes:
          type: number
        outEvents:
          type: number
        startTime:
          type: number
      required:
        - endTime
        - exemptedLicenseInBytes
        - inBytes
        - inEvents
        - outBytes
        - outEvents
        - startTime
    LoggerEntry:
      type: object
      properties:
        canDelete:
          type: boolean
        id:
          type: string
        level:
          type: string
        ttl:
          type: number
      required:
        - id
        - level
    TtlConfig:
      type: object
      additionalProperties:
        type: object
        properties:
          level:
            type: string
          ttl:
            type: number
        required:
          - level
          - ttl
    LoggerConfig:
      type: object
      properties:
        channels:
          type: array
          items:
            $ref: "#/components/schemas/LoggerEntry"
        defaultRedactFields:
          type: array
          items:
            type: string
        id:
          type: string
        limitRate:
          type: number
        maxSizeBytes:
          type: number
        redactFields:
          type: array
          items:
            type: string
        redactLabel:
          type: string
        ttlConfig:
          $ref: "#/components/schemas/TtlConfig"
      required:
        - channels
        - id
        - limitRate
        - maxSizeBytes
        - redactFields
        - redactLabel
    LogFileInfo:
      type: object
      properties:
        id:
          type: string
        path:
          type: string
        size:
          type: number
      required:
        - id
        - path
    InstallWarnings:
      type: array
      items:
        type: string
    PackInstallInfo:
      type: object
      properties:
        author:
          type: string
        dependencies:
          type: object
          additionalProperties:
            type: string
        description:
          type: string
        displayName:
          type: string
        exports:
          type: array
          items:
            type: string
        id:
          type: string
        inputs:
          type: number
        isDisabled:
          type: boolean
        minLogStreamVersion:
          type: string
        outputs:
          type: number
        settings:
          type: object
          additionalProperties: true
        source:
          type: string
        spec:
          type: string
        tags:
          type: object
          properties:
            dataType:
              type: array
              items:
                type: string
            domain:
              type: array
              items:
                type: string
            streamtags:
              type: array
              items:
                type: string
            technology:
              type: array
              items:
                type: string
        version:
          type: string
        warnings:
          $ref: "#/components/schemas/InstallWarnings"
      required:
        - id
        - source
    PackRequestBody:
      type: object
      properties:
        id:
          type: string
        spec:
          type: string
        version:
          type: string
        minLogStreamVersion:
          type: string
        displayName:
          type: string
        author:
          type: string
        description:
          type: string
        source:
          type: string
          description: The source of the pack. If not present, an empty pack will be created
        tags:
          type: object
          properties:
            dataType:
              type: array
              items:
                type: string
            domain:
              type: array
              items:
                type: string
            technology:
              type: array
              items:
                type: string
            streamtags:
              type: array
              items:
                type: string
        allowCustomFunctions:
          type: boolean
        force:
          type: boolean
      anyOf:
        - required:
            - id
        - required:
            - source
    PackInfo:
      type: object
      properties:
        author:
          type: string
        dependencies:
          type: object
          additionalProperties:
            type: string
        description:
          type: string
        displayName:
          type: string
        exports:
          type: array
          items:
            type: string
        id:
          type: string
        inputs:
          type: number
        isDisabled:
          type: boolean
        minLogStreamVersion:
          type: string
        outputs:
          type: number
        settings:
          type: object
          additionalProperties: true
        source:
          type: string
        spec:
          type: string
        tags:
          type: object
          properties:
            dataType:
              type: array
              items:
                type: string
            domain:
              type: array
              items:
                type: string
            streamtags:
              type: array
              items:
                type: string
            technology:
              type: array
              items:
                type: string
        version:
          type: string
      required:
        - id
        - source
    PackUpgradeRequest:
      type: object
      properties:
        allowCustomFunctions:
          type: boolean
        minor:
          type: string
        source:
          type: string
        spec:
          type: string
      required:
        - source
    PackClone:
      type: object
      properties:
        dest:
          type: string
        dstGroups:
          type: array
          items:
            type: string
        force:
          type: boolean
        packs:
          type: array
          items:
            type: string
        srcGroup:
          type: string
      required:
        - dstGroups
        - packs
        - srcGroup
    ReferencedEntity:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
      required:
        - id
        - type
    ReferencingEntity:
      type: object
      properties:
        id:
          type: string
        refs:
          type: array
          items:
            $ref: "#/components/schemas/ReferencedEntity"
        type:
          type: string
      required:
        - id
        - refs
        - type
    PackExportModeTypes:
      type: string
      enum:
        - merge_safe
        - merge
        - default_only
      x-speakeasy-unknown-values: allow
    UploadPackResponse:
      type: object
      properties:
        source:
          type: string
      required:
        - source
    PublishPackToGitStatusType:
      type: string
      enum:
        - error
        - success
        - noop
      x-speakeasy-unknown-values: allow
    PublishPackResponse:
      type: object
      properties:
        git:
          type: object
          properties:
            branch:
              type: string
            commitHash:
              type: string
            commitMessage:
              type: string
          required:
            - branch
            - commitHash
            - commitMessage
        id:
          type: string
        message:
          type: string
        source:
          type: string
        status:
          $ref: "#/components/schemas/PublishPackToGitStatusType"
      required:
        - id
    PreviewDataParams:
      type: object
      properties:
        cpuProfile:
          type: boolean
        dropped:
          type: boolean
        enhanceMetricsOutput:
          type: boolean
        events:
          type: array
          items:
            type: object
            additionalProperties: true
        inputId:
          type: string
        level:
          type: number
        memory:
          type: number
        mode:
          type: string
          enum:
            - pipe
            - route
            - routeAndSend
          x-speakeasy-unknown-values: allow
        pipelineId:
          type: string
        sampleId:
          type: string
        samplePipelineId:
          type: string
        timeout:
          type: number
      required:
        - mode
        - pipelineId
        - sampleId
    ProcessEntry:
      type: object
      properties:
        env:
          type: object
          additionalProperties: true
        id:
          type: string
        pid:
          type: number
        restartOnExit:
          type: boolean
        restarts:
          type: number
        startTime:
          type: number
        type:
          type: string
      required:
        - id
        - restartOnExit
        - restarts
        - startTime
        - type
    ProductsAll:
      type: string
      enum:
        - stream
        - edge
        - search
        - lake
      x-speakeasy-unknown-values: allow
    GitCommitSummary:
      type: object
      properties:
        author:
          type: object
          properties:
            email:
              type: string
            name:
              type: string
          required:
            - email
            - name
        branch:
          type: string
        commit:
          type: string
        files:
          type: object
          properties:
            created:
              type: array
              items:
                type: string
            deleted:
              type: array
              items:
                type: string
            modified:
              type: array
              items:
                type: string
            renamed:
              type: array
              items:
                type: string
        summary:
          type: object
          properties:
            changes:
              type: number
            deletions:
              type: number
            insertions:
              type: number
          required:
            - changes
            - deletions
            - insertions
      required:
        - branch
        - commit
        - files
        - summary
    ProjectGitCommitParams:
      type: object
      properties:
        effective:
          type: boolean
        message:
          type: string
      required:
        - message
    GitFile:
      type: object
      properties:
        children:
          type: array
          items:
            $ref: "#/components/schemas/GitFile"
        name:
          type: string
        state:
          type: string
      required:
        - name
    GitFilesResponse:
      type: object
      properties:
        commitMessage:
          type: object
          additionalProperties: true
        count:
          type: number
        items:
          type: array
          items:
            $ref: "#/components/schemas/GitFile"
      required:
        - count
        - items
    GitRevertResult:
      type: object
      properties:
        audit:
          type: object
          properties:
            files:
              type: object
              properties:
                created:
                  type: array
                  items:
                    type: string
                deleted:
                  type: array
                  items:
                    type: string
                modified:
                  type: array
                  items:
                    type: string
                renamed:
                  type: array
                  items:
                    type: string
            group:
              type: string
            id:
              type: string
          required:
            - id
        reverted:
          type: boolean
      required:
        - audit
        - reverted
    GitRevertParams:
      type: object
      properties:
        commit:
          type: string
        force:
          type: boolean
        message:
          type: string
      required:
        - commit
    LicenseLimits:
      type: object
      properties:
        edge_groups:
          type: number
        edge_procs:
          type: number
        kms:
          type: number
        lake_access_groups:
          type: number
        lake_ddss:
          type: number
        lake_metrics:
          type: number
        lake_storage_locations:
          type: number
        lakehouse:
          type: number
        leader_resiliency:
          type: number
        max_executors_per_search:
          type: number
        notifications:
          type: number
        outpost:
          type: number
        persistent_queue:
          type: number
        projects:
          type: number
        rbac:
          type: number
        remote_auth:
          type: number
        remote_git:
          type: number
        s3_bundle:
          type: number
        sds:
          type: number
        search_acceleration:
          type: number
        search_groups:
          type: number
        system_email:
          type: number
        worker_groups:
          type: number
        worker_procs:
          type: number
      required:
        - rbac
        - remote_auth
        - remote_git
        - worker_groups
        - worker_procs
    LicenseInfo:
      type: object
      properties:
        email:
          type: string
        isRegistered:
          type: boolean
        isSplunkApp:
          type: boolean
        limits:
          $ref: "#/components/schemas/LicenseLimits"
        type:
          type: string
          enum:
            - prod
            - trial
            - free
          x-speakeasy-unknown-values: allow
      required:
        - isRegistered
        - limits
        - type
    OpenSslInfo:
      type: object
      properties:
        fipsProviderVersion:
          type: string
        version:
          type: string
      required:
        - fipsProviderVersion
        - version
    SystemConf:
      type: object
      properties:
        installType:
          type: string
        restart:
          type: string
        upgrade:
          type: string
      required:
        - installType
        - restart
        - upgrade
    SystemInfo:
      type: object
      properties:
        BUILD:
          type: object
          additionalProperties: true
        apiPort:
          type: number
        conf:
          type: object
          properties:
            confVersion:
              type: string
            inputs:
              type: number
            name:
              type: string
            outputs:
              type: number
            pipelines:
              type: number
            routes:
              type: number
            rules:
              type: number
          required:
            - inputs
            - outputs
            - pipelines
            - routes
            - rules
        configPath:
          type: string
        cpus:
          type: array
          items:
            type: object
            properties:
              model:
                type: string
              speed:
                type: number
              times:
                type: object
                additionalProperties: true
            required:
              - model
              - speed
              - times
        diskUsage:
          type: object
          properties:
            bytesAvailable:
              type: number
            bytesUsed:
              type: number
            diskPath:
              type: string
            totalDiskSize:
              type: number
          required:
            - bytesAvailable
            - bytesUsed
            - diskPath
            - totalDiskSize
        distMode:
          type: string
          enum:
            - edge
            - worker
            - single
            - master
            - managed-edge
            - outpost
            - search-supervisor
          x-speakeasy-unknown-values: allow
        env:
          type: object
        guid:
          type: string
        hasCloudWorkspace:
          type: boolean
        hostname:
          type: string
        installPath:
          type: string
        isCriblSandbox:
          type: boolean
        isFedRampEnabled:
          type: boolean
        isFipsEnabled:
          type: boolean
        license:
          $ref: "#/components/schemas/LicenseInfo"
        limits:
          type: object
          properties:
            samples:
              type: object
              properties:
                maxSize:
                  type: string
              required:
                - maxSize
          required:
            - samples
        loadavg:
          type: array
          items:
            type: number
        memory:
          type: object
          properties:
            free:
              type: number
            total:
              type: number
          required:
            - free
            - total
        messages:
          type: array
          items:
            $ref: "#/components/schemas/BulletinMessage"
        net:
          type: object
          additionalProperties: true
        openssl:
          $ref: "#/components/schemas/OpenSslInfo"
        os:
          type: object
          properties:
            arch:
              type: string
            endianness:
              type: string
            platform:
              type: string
            release:
              type: string
            type:
              type: string
          required:
            - arch
            - endianness
            - platform
            - release
            - type
        systemConf:
          $ref: "#/components/schemas/SystemConf"
        uptime:
          type: number
        version:
          type: string
        workerProcesses:
          type: number
      required:
        - BUILD
        - apiPort
        - conf
        - configPath
        - cpus
        - diskUsage
        - distMode
        - env
        - guid
        - hostname
        - installPath
        - license
        - limits
        - loadavg
        - memory
        - messages
        - net
        - os
        - systemConf
        - uptime
        - version
        - workerProcesses
    Diag:
      type: object
      properties:
        id:
          type: string
        modTime:
          type: number
        path:
          type: string
        size:
          type: number
      required:
        - id
        - path
    SendDiagBundle:
      type: object
      properties:
        sendToCribl:
          title: Send to Cribl Support
          description: Send diagnostic bundle to Cribl Support
          type: boolean
          default: false
        path:
          type: string
          title: Diag bundle file path
          description: Existing bundle that will be sent to Cribl Support. Max 100MB.
        renameJs:
          title: Rename .js files
          description: Append .txt to JavaScript files
          type: boolean
          default: true
        includeMetrics:
          title: Include metrics
          description: Disable to exclude metrics from the bundle
          type: boolean
          default: true
        includeGit:
          title: Include git
          description: Disable to exclude the git audit from the bundle. Unavailable for
            worker, managed-edge, and outpost modes
          type: boolean
          default: true
        includeTopTalkers:
          title: Include top talkers
          description: Include data about your 10 highest-volume Sources, Destinations,
            Pipelines, Routes, and Packs in the diagnostic bundle
          type: boolean
          default: false
        maxIncludeJobs:
          title: Latest number of jobs
          description: Number of jobs, including all tasks that will be included in the
            bundle
          type: number
          minimum: 0
        includeInstallLogs:
          title: Include installation logs
          description: Enable to include installation logs in the bundle (Windows only)
          type: boolean
          default: false
    MetricNameInfo:
      type: object
      properties:
        dims:
          type: array
          items:
            type: object
            properties:
              count:
                type: number
              name:
                type: string
              values:
                type: array
                items:
                  type: string
            required:
              - count
              - name
              - values
        name:
          type: string
      required:
        - dims
        - name
    SystemMetricsEnum:
      type: object
      properties:
        dimKeyFilter:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        dimValueFilter:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        earliest:
          type: number
        filterExpr:
          type: string
        maxValues:
          type: number
        metricNameFilter:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        namespace:
          type: string
    SearchAggMode:
      type: string
      nullable: true
      enum:
        - Coordinated
        - CoordinatedSuppressPreview
        - DistributedCoordinated
        - DistributedCoordinatedSuppressPreview
        - Federated
      x-speakeasy-unknown-values: allow
    AggregationMgrOptions:
      type: object
      properties:
        aggregations:
          type: array
          items:
            type: string
        cumulative:
          type: boolean
        dotsAsLiterals:
          type: boolean
        flushEventLimit:
          type: number
        flushMemLimit:
          type: number
        hostname:
          type: string
        idleTimeLimitSeconds:
          type: number
        lagToleranceSeconds:
          type: number
        metricsMode:
          type: boolean
        prefix:
          type: string
        preserveSplitByStructure:
          type: boolean
        searchAggMode:
          $ref: "#/components/schemas/SearchAggMode"
        splitBys:
          type: array
          items:
            type: string
        sufficientStatsOnly:
          type: boolean
        timeWindowSeconds:
          type: number
      required:
        - aggregations
        - cumulative
        - flushEventLimit
        - flushMemLimit
        - hostname
        - metricsMode
        - sufficientStatsOnly
        - timeWindowSeconds
    MetricsStore:
      type: object
      properties: {}
    MetricsAggOpts:
      type: object
      properties:
        aggs:
          $ref: "#/components/schemas/AggregationMgrOptions"
        alwaysBounds:
          type: boolean
        earliest:
          oneOf:
            - type: string
            - type: number
        latest:
          oneOf:
            - type: string
            - type: number
        metrics:
          $ref: "#/components/schemas/MetricsStore"
        where:
          type: string
      required:
        - aggs
    AuthConfig:
      type: object
      properties:
        fallback:
          type: boolean
        fallbackBadLogin:
          type: boolean
        filter_type:
          type: string
        host:
          type: string
        port:
          type: number
        ssl:
          type: boolean
        type:
          type: string
          enum:
            - ldap
            - splunk
            - local
            - openid
            - saas
            - saml
          x-speakeasy-unknown-values: allow
      required:
        - fallback
        - fallbackBadLogin
        - host
        - port
        - ssl
        - type
    UpgradeGroupSettings:
      type: object
      properties:
        isRolling:
          type: boolean
        quantity:
          type: number
        retryCount:
          type: number
        retryDelay:
          type: number
    UpgradePackageUrls:
      type: object
      properties:
        packageHashUrl:
          type: string
        packageUrl:
          type: string
      required:
        - packageUrl
    UpgradeSettings:
      type: object
      properties:
        automaticUpgradeCheckPeriod:
          type: string
        disableAutomaticUpgrade:
          type: boolean
        enableLegacyEdgeUpgrade:
          type: boolean
        packageUrls:
          type: array
          items:
            $ref: "#/components/schemas/UpgradePackageUrls"
        upgradeSource:
          type: string
      required:
        - disableAutomaticUpgrade
        - enableLegacyEdgeUpgrade
        - upgradeSource
    SystemSettingsConf:
      type: object
      properties:
        api:
          type: object
          properties:
            baseUrl:
              type: string
            disableApiCache:
              type: boolean
            disabled:
              type: boolean
            headers:
              type: object
            host:
              type: string
            idleSessionTTL:
              type: number
            listenOnPort:
              type: boolean
            loginRateLimit:
              type: string
            port:
              type: number
            protocol:
              type: string
            scripts:
              type: boolean
            sensitiveFields:
              type: array
              items:
                type: string
            ssl:
              type: object
              properties:
                caPath:
                  type: string
                certPath:
                  type: string
                disabled:
                  type: boolean
                passphrase:
                  type: string
                privKeyPath:
                  type: string
              required:
                - certPath
                - disabled
                - passphrase
                - privKeyPath
            ssoRateLimit:
              type: string
            workerRemoteAccess:
              type: boolean
          required:
            - disabled
            - host
            - port
            - protocol
            - ssl
            - workerRemoteAccess
        backups:
          type: object
          properties:
            backupPersistence:
              type: string
            backupsDirectory:
              type: string
          required:
            - backupPersistence
            - backupsDirectory
        customLogo:
          type: object
          properties:
            enabled:
              type: boolean
            logoDescription:
              type: string
            logoImage:
              type: string
          required:
            - enabled
            - logoDescription
            - logoImage
        pii:
          type: object
          properties:
            enablePiiDetection:
              type: boolean
          required:
            - enablePiiDetection
        proxy:
          type: object
          properties:
            useEnvVars:
              type: boolean
          required:
            - useEnvVars
        rollback:
          type: object
          properties:
            rollbackEnabled:
              type: boolean
            rollbackRetries:
              type: number
            rollbackTimeout:
              type: number
          required:
            - rollbackEnabled
        shutdown:
          type: object
          properties:
            drainTimeout:
              type: number
          required:
            - drainTimeout
        sni:
          type: object
          properties:
            disableSNIRouting:
              type: boolean
          required:
            - disableSNIRouting
        sockets:
          type: object
          properties:
            directory:
              type: string
        support:
          type: object
          properties:
            featureFlagOverrides:
              type: array
              items:
                type: object
                properties:
                  disabled:
                    type: boolean
                  flagId:
                    type: string
                required:
                  - disabled
                  - flagId
        system:
          type: object
          properties:
            intercom:
              type: boolean
            upgrade:
              enum:
                - false
                - api
              x-speakeasy-unknown-values: allow
          required:
            - intercom
            - upgrade
        tls:
          type: object
          properties:
            defaultCipherList:
              type: string
            defaultEcdhCurve:
              type: string
            maxVersion:
              type: string
            minVersion:
              type: string
            rejectUnauthorized:
              type: boolean
          required:
            - defaultCipherList
            - defaultEcdhCurve
            - maxVersion
            - minVersion
            - rejectUnauthorized
        upgradeGroupSettings:
          $ref: "#/components/schemas/UpgradeGroupSettings"
        upgradeSettings:
          $ref: "#/components/schemas/UpgradeSettings"
        workers:
          type: object
          properties:
            count:
              type: number
            enableHeapSnapshots:
              type: boolean
            loadThrottlePerc:
              type: number
            memory:
              type: number
            minimum:
              type: number
            startupMaxConns:
              type: number
            startupThrottleTimeout:
              type: number
            v8SingleThread:
              type: boolean
          required:
            - count
            - memory
            - minimum
      required:
        - api
        - backups
        - customLogo
        - pii
        - proxy
        - rollback
        - shutdown
        - sni
        - system
        - tls
        - upgradeGroupSettings
        - upgradeSettings
        - workers
    GitOpsType:
      type: string
      enum:
        - none
        - pull
        - push
      x-speakeasy-unknown-values: allow
    GitSettings:
      type: object
      properties:
        authType:
          type: string
        autoAction:
          type: string
        autoActionMessage:
          type: string
        autoActionSchedule:
          type: string
        branch:
          type: string
        commitDeploySingleAction:
          type: boolean
        copilotAutoGitCommitMessages:
          type: boolean
        defaultCommitMessage:
          type: string
        gitOps:
          $ref: "#/components/schemas/GitOpsType"
        password:
          type: string
        remote:
          type: string
        sshKey:
          type: string
        strictHostKeyChecking:
          type: boolean
        timeout:
          type: number
        user:
          type: string
    MaxConcurrentSearchesType:
      oneOf:
        - type: number
        - type: string
          pattern: ^[0-9]+%$
    SearchSettings:
      type: object
      properties:
        compressObjectCacheArtifacts:
          type: boolean
        fieldSummaryMaxFields:
          type: number
        fieldSummaryMaxNestedDepth:
          type: number
        maxConcurrentSearches:
          $ref: "#/components/schemas/MaxConcurrentSearchesType"
        maxExecutorsPerSearch:
          type: number
        maxResultsPerSearch:
          type: number
        maxSearchDuration:
          type: string
          pattern: ^[0-9]+(s|w|d|m|h)$
        searchHistoryMaxJobs:
          type: number
        searchHistoryTTL:
          type: string
          pattern: ^[0-9]+(s|w|d|m|h)$
        searchQueueLength:
          oneOf:
            - type: number
            - type: string
              pattern: ^[0-9]+%$
        warmPoolSize:
          oneOf:
            - type: number
            - enum:
                - auto
              x-speakeasy-unknown-values: allow
        writeOnlyProviderSecrets:
          type: boolean
      required:
        - compressObjectCacheArtifacts
        - fieldSummaryMaxFields
        - fieldSummaryMaxNestedDepth
        - maxConcurrentSearches
        - maxExecutorsPerSearch
        - maxResultsPerSearch
        - maxSearchDuration
        - searchHistoryMaxJobs
        - searchHistoryTTL
        - searchQueueLength
        - warmPoolSize
        - writeOnlyProviderSecrets
    JobSettings:
      type: object
      properties:
        concurrentJobLimit:
          type: number
        concurrentScheduledJobLimit:
          type: number
        concurrentSystemJobLimit:
          type: number
        concurrentSystemTaskLimit:
          type: number
        concurrentTaskLimit:
          type: number
        disableTasks:
          type: boolean
        finishedJobArtifactsLimit:
          type: number
        finishedTaskArtifactsLimit:
          type: number
        jobArtifactsReaperPeriod:
          type: string
        jobTimeout:
          type: string
        maxTaskPerc:
          type: number
        schedulingPolicy:
          type: string
        taskHeartbeatPeriod:
          type: number
        taskManifestFlushPeriodMs:
          type: number
        taskManifestMaxBufferSize:
          type: number
        taskManifestReadBufferSize:
          type: string
        taskPollTimeoutMs:
          type: number
      required:
        - concurrentJobLimit
        - concurrentScheduledJobLimit
        - concurrentSystemJobLimit
        - concurrentSystemTaskLimit
        - concurrentTaskLimit
        - finishedJobArtifactsLimit
        - finishedTaskArtifactsLimit
        - jobArtifactsReaperPeriod
        - jobTimeout
        - maxTaskPerc
        - schedulingPolicy
        - taskHeartbeatPeriod
        - taskManifestFlushPeriodMs
        - taskManifestMaxBufferSize
        - taskManifestReadBufferSize
        - taskPollTimeoutMs
    EdgeHeartbeatMetricsMode:
      type: string
      enum:
        - minimal
        - basic
        - all
        - custom
      x-speakeasy-unknown-values: allow
    Limits:
      type: object
      properties:
        cpuProfileTTL:
          type: string
        disableMetricsAccessorCache:
          type: boolean
        edgeMetricsCustomExpression:
          type: string
        edgeMetricsMode:
          $ref: "#/components/schemas/EdgeHeartbeatMetricsMode"
        edgeNodesCount:
          type: number
        enableMetricsPersistence:
          type: boolean
        enableWorkerPersistence:
          type: boolean
        eventsMetadataSources:
          type: array
          items:
            type: string
        largeEventsThreshold:
          type: string
        lookupMaxSize:
          type: string
        lookupMaxTotalSize:
          type: string
        maxDimensionValueSize:
          type: number
        maxMetrics:
          type: number
        maxPQSize:
          type: string
        maxReconnectInterval:
          type: string
        metricsDirectory:
          type: string
        metricsDropList:
          type: array
          items:
            type: string
        metricsFieldsBlacklist:
          type: array
          items:
            type: string
        metricsGCPeriod:
          type: string
        metricsMaxCardinality:
          type: number
        metricsMaxDiskSpace:
          type: string
        metricsNeverDropList:
          type: array
          items:
            type: string
        metricsWorkerIdBlacklist:
          type: array
          items:
            type: string
        minFreeSpace:
          type: string
        minReconnectInterval:
          type: string
        netFlowTemplateFlushInterval:
          type: number
        randomReconnectInterval:
          type: string
        samples:
          type: object
          properties:
            maxSize:
              type: string
          required:
            - maxSize
        workerMaxMetrics:
          type: number
      required:
        - cpuProfileTTL
        - enableMetricsPersistence
        - metricsDirectory
        - metricsFieldsBlacklist
        - metricsGCPeriod
        - metricsNeverDropList
        - metricsWorkerIdBlacklist
        - minFreeSpace
        - samples
    RedisCacheLimits:
      type: object
      properties:
        clientTrackingMechanism:
          type: string
        enableServerAssist:
          type: boolean
        keyTTLSecs:
          type: number
        maxCacheSize:
          type: number
        maxNumKeys:
          type: number
        servicePeriodSecs:
          type: number
    RedisConnectionLimits:
      type: object
      properties:
        disabled:
          type: boolean
        maxConnections:
          type: number
    RedisLimits:
      type: object
      properties:
        connections:
          $ref: "#/components/schemas/RedisConnectionLimits"
      required:
        - connections
    ServiceProcsType:
      oneOf:
        - type: number
        - enum:
            - auto
          x-speakeasy-unknown-values: allow
    ConnectionProxyLimitConfigs:
      type: object
      properties:
        procs:
          $ref: "#/components/schemas/ServiceProcsType"
    CommonServiceLimitConfigs:
      type: object
      properties:
        memoryLimit:
          type: string
        procs:
          $ref: "#/components/schemas/ServiceProcsType"
      required:
        - memoryLimit
    ServicesLimits:
      type: object
      properties:
        connection_proxy:
          $ref: "#/components/schemas/ConnectionProxyLimitConfigs"
        connections:
          $ref: "#/components/schemas/CommonServiceLimitConfigs"
        metrics:
          $ref: "#/components/schemas/CommonServiceLimitConfigs"
        notifications:
          $ref: "#/components/schemas/CommonServiceLimitConfigs"
      required:
        - connections
        - metrics
        - notifications
    SystemSettings:
      type: object
      properties:
        api:
          type: object
          properties:
            baseUrl:
              type: string
            disableApiCache:
              type: boolean
            disabled:
              type: boolean
            headers:
              type: object
            host:
              type: string
            idleSessionTTL:
              type: number
            listenOnPort:
              type: boolean
            loginRateLimit:
              type: string
            port:
              type: number
            protocol:
              type: string
            scripts:
              type: boolean
            sensitiveFields:
              type: array
              items:
                type: string
            ssl:
              type: object
              properties:
                caPath:
                  type: string
                certPath:
                  type: string
                disabled:
                  type: boolean
                passphrase:
                  type: string
                privKeyPath:
                  type: string
              required:
                - certPath
                - disabled
                - passphrase
                - privKeyPath
            ssoRateLimit:
              type: string
            workerRemoteAccess:
              type: boolean
          required:
            - disabled
            - host
            - port
            - protocol
            - ssl
            - workerRemoteAccess
        auth:
          $ref: "#/components/schemas/AuthConfig"
        backups:
          type: object
          properties:
            backupPersistence:
              type: string
            backupsDirectory:
              type: string
          required:
            - backupPersistence
            - backupsDirectory
        customLogo:
          type: object
          properties:
            enabled:
              type: boolean
            logoDescription:
              type: string
            logoImage:
              type: string
          required:
            - enabled
            - logoDescription
            - logoImage
        distributed:
          type: object
          properties:
            mode:
              type: string
              enum:
                - edge
                - worker
                - single
                - master
                - managed-edge
                - outpost
                - search-supervisor
              x-speakeasy-unknown-values: allow
          required:
            - mode
        fips:
          type: boolean
        git:
          $ref: "#/components/schemas/GitSettings"
        jobLimits:
          $ref: "#/components/schemas/JobSettings"
        limits:
          $ref: "#/components/schemas/Limits"
        pii:
          type: object
          properties:
            enablePiiDetection:
              type: boolean
          required:
            - enablePiiDetection
        proxy:
          type: object
          properties:
            useEnvVars:
              type: boolean
          required:
            - useEnvVars
        redisCacheLimits:
          $ref: "#/components/schemas/RedisCacheLimits"
        redisLimits:
          $ref: "#/components/schemas/RedisLimits"
        rollback:
          type: object
          properties:
            rollbackEnabled:
              type: boolean
            rollbackRetries:
              type: number
            rollbackTimeout:
              type: number
          required:
            - rollbackEnabled
        searchLimits:
          $ref: "#/components/schemas/SearchSettings"
        servicesLimits:
          $ref: "#/components/schemas/ServicesLimits"
        shutdown:
          type: object
          properties:
            drainTimeout:
              type: number
          required:
            - drainTimeout
        sni:
          type: object
          properties:
            disableSNIRouting:
              type: boolean
          required:
            - disableSNIRouting
        sockets:
          type: object
          properties:
            directory:
              type: string
        support:
          type: object
          properties:
            featureFlagOverrides:
              type: array
              items:
                type: object
                properties:
                  disabled:
                    type: boolean
                  flagId:
                    type: string
                required:
                  - disabled
                  - flagId
        system:
          type: object
          properties:
            intercom:
              type: boolean
            upgrade:
              enum:
                - false
                - api
              x-speakeasy-unknown-values: allow
          required:
            - intercom
            - upgrade
        tls:
          type: object
          properties:
            defaultCipherList:
              type: string
            defaultEcdhCurve:
              type: string
            maxVersion:
              type: string
            minVersion:
              type: string
            rejectUnauthorized:
              type: boolean
          required:
            - defaultCipherList
            - defaultEcdhCurve
            - maxVersion
            - minVersion
            - rejectUnauthorized
        upgradeGroupSettings:
          $ref: "#/components/schemas/UpgradeGroupSettings"
        upgradeSettings:
          $ref: "#/components/schemas/UpgradeSettings"
        workers:
          type: object
          properties:
            count:
              type: number
            enableHeapSnapshots:
              type: boolean
            loadThrottlePerc:
              type: number
            memory:
              type: number
            minimum:
              type: number
            startupMaxConns:
              type: number
            startupThrottleTimeout:
              type: number
            v8SingleThread:
              type: boolean
          required:
            - count
            - memory
            - minimum
      required:
        - api
        - auth
        - backups
        - customLogo
        - distributed
        - fips
        - git
        - jobLimits
        - limits
        - pii
        - proxy
        - redisCacheLimits
        - redisLimits
        - rollback
        - searchLimits
        - servicesLimits
        - shutdown
        - sni
        - system
        - tls
        - upgradeGroupSettings
        - upgradeSettings
        - workers
    PublicSettings:
      type: object
      properties:
        apiProtocol:
          type: string
        intercom:
          type: boolean
        isRegistered:
          type: boolean
      required:
        - apiProtocol
        - intercom
        - isRegistered
    VersionInfo:
      type: object
      properties:
        architecture:
          type: string
        build:
          type: string
        downloadUrl:
          type: string
        fullVersion:
          type: string
        major:
          type: number
        minor:
          type: number
        platform:
          type: string
        point:
          type: number
        preRelease:
          type: string
      required:
        - build
        - fullVersion
        - major
        - minor
    UpgradeResult:
      type: object
      properties:
        availableVersions:
          type: array
          items:
            $ref: "#/components/schemas/VersionInfo"
        canUpgrade:
          type: boolean
        installedVersion:
          $ref: "#/components/schemas/VersionInfo"
        isSuccess:
          type: boolean
        message:
          type: string
        upgradedToVersion:
          $ref: "#/components/schemas/VersionInfo"
      required:
        - availableVersions
        - canUpgrade
        - installedVersion
        - isSuccess
        - message
        - upgradedToVersion
    UpgradeMasterRequest:
      type: object
      properties:
        packages:
          title: Custom Path
          description: Provide your own URLs or local paths for platform-specific Cribl
            packages
          type: array
          items:
            type: object
            required:
              - packageUrl
            properties:
              packageUrl:
                type: string
                title: Platform-Specific Package Location
                description: Package HTTP URL or local path
                pattern: (\d+)\.(\d+)\.?(\d+)?-?([-.a-zA-Z0-9]*)-([a-z0-9]{8})-(linux|darwin|win32)-([0-9a-zA-Z]+)
                minLength: 1
              packageHashUrl:
                type: string
                title: Package Hash Location
                description: Package's MD5 or SHA256 hash HTTP URL or local path
                pattern: (\d+)\.(\d+)\.?(\d+)?-?([-.a-zA-Z0-9]*)-([a-z0-9]{8})-(linux|darwin|win32)-([0-9a-zA-Z]+)\.(tgz|msi|pkg)?\.(md5|sha256)
                minLength: 1
    UiStatePatch:
      type: object
      required:
        - op
        - value
      properties:
        op:
          type: string
          enum:
            - set
            - push-recent
          x-speakeasy-unknown-values: allow
        value:
          oneOf:
            - type: string
              maxLength: 1000
            - type: object
            - type: array
              items:
                oneOf:
                  - type: string
                    maxLength: 1000
                  - type: object
        args:
          type: object
          additionalProperties: true
    BranchInfo:
      type: object
      properties:
        id:
          type: string
      required:
        - id
    GitCommitParams:
      type: object
      properties:
        effective:
          type: boolean
        files:
          type: array
          items:
            type: string
        group:
          type: string
        message:
          type: string
      required:
        - message
    GitCountResult:
      type: object
      properties:
        count:
          type: number
      required:
        - count
    CurrentBranchResult:
      type: object
      properties:
        branch:
          type: string
      required:
        - branch
    DiffFiles:
      type: array
      items:
        type: object
        properties:
          addedLines:
            type: number
          blocks:
            type: array
            items:
              type: object
              properties:
                header:
                  type: string
                lines:
                  type: array
                  items:
                    oneOf:
                      - type: object
                        properties:
                          content:
                            type: string
                          oldNumber:
                            type: number
                        required:
                          - content
                          - oldNumber
                      - type: object
                        properties:
                          content:
                            type: string
                          newNumber:
                            type: number
                        required:
                          - content
                          - newNumber
                      - type: object
                        properties:
                          content:
                            type: string
                          newNumber:
                            type: number
                          oldNumber:
                            type: number
                        required:
                          - content
                          - newNumber
                          - oldNumber
                newStartLine:
                  type: number
                oldStartLine:
                  type: number
                oldStartLine2:
                  type: number
              required:
                - header
                - lines
                - newStartLine
                - oldStartLine
          changedPercentage:
            type: number
          checksumAfter:
            type: string
          checksumBefore:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
          deletedFileMode:
            type: string
          deletedLines:
            type: number
          isBinary:
            type: boolean
          isCombined:
            type: boolean
          isCopy:
            type: boolean
          isDeleted:
            type: boolean
          isGitDiff:
            type: boolean
          isNew:
            type: boolean
          isRename:
            type: boolean
          isTooBig:
            type: boolean
          language:
            type: string
          mode:
            type: string
          newFileMode:
            type: string
          newMode:
            type: string
          newName:
            type: string
          oldMode:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
          oldName:
            type: string
          unchangedPercentage:
            type: number
        required:
          - addedLines
          - blocks
          - deletedLines
          - isCombined
          - isGitDiff
          - language
          - newName
          - oldName
    GitDiffResult:
      type: object
      properties:
        diffJson:
          $ref: "#/components/schemas/DiffFiles"
      required:
        - diffJson
    GitInfo:
      type: object
      properties:
        remote:
          oneOf:
            - type: string
            - enum:
                - false
              x-speakeasy-unknown-values: allow
        versioning:
          type: boolean
      required:
        - remote
        - versioning
    GitLogResult:
      type: object
      properties:
        author_email:
          type: string
        author_name:
          type: string
        body:
          type: string
        date:
          type: string
        hash:
          type: string
        message:
          type: string
        refs:
          type: string
    GitShowResult:
      type: object
      properties:
        commitMessage:
          type: string
        diffJson:
          $ref: "#/components/schemas/DiffFiles"
      required:
        - commitMessage
        - diffJson
    GitStatusResult:
      type: object
      properties:
        ahead:
          type: number
        behind:
          type: number
        conflicted:
          type: array
          items:
            type: string
        created:
          type: array
          items:
            type: string
        current:
          type: string
        deleted:
          type: array
          items:
            type: string
        files:
          type: array
          items:
            type: object
            properties:
              index:
                type: string
              path:
                type: string
              working_dir:
                type: string
            required:
              - index
              - path
              - working_dir
        modified:
          type: array
          items:
            type: string
        not_added:
          type: array
          items:
            type: string
        renamed:
          type: array
          items:
            type: object
            properties:
              from:
                type: string
              to:
                type: string
            required:
              - from
              - to
        staged:
          type: array
          items:
            type: string
      required:
        - ahead
        - behind
        - conflicted
        - created
        - current
        - deleted
        - files
        - modified
        - not_added
        - renamed
        - staged
    SearchEvent:
      allOf:
        - type: object
          properties:
            _raw:
              type: object
              additionalProperties: true
            _time:
              type: number
          required:
            - _raw
            - _time
    PreviewResponseBody:
      type: object
      properties:
        count:
          type: number
        events:
          type: array
          items:
            $ref: "#/components/schemas/SearchEvent"
        processingTimeMS:
          type: number
        useFormattedVisualization:
          type: boolean
      required:
        - count
        - events
        - processingTimeMS
        - useFormattedVisualization
    EventBreakerRuleFields:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
      required:
        - name
        - value
    ParserMode:
      type: string
      enum:
        - extract
        - reserialize
      x-speakeasy-unknown-values: allow
    RegexContainer:
      type: object
      properties:
        regex:
          type: string
      required:
        - regex
    EventBreakerRule:
      type: object
      properties:
        cleanFields:
          type: boolean
        condition:
          type: string
        delimiter:
          type: string
        delimiterRegex:
          type: string
        disabled:
          type: boolean
        escapeChar:
          type: string
        eventBreakerRegex:
          type: string
        fields:
          type: array
          items:
            $ref: "#/components/schemas/EventBreakerRuleFields"
        fieldsLineRegex:
          type: string
        headerLineRegex:
          type: string
        index:
          type: number
        jsonArrayField:
          type: string
        jsonExtractAll:
          type: boolean
        jsonTimeField:
          type: string
        maxEventBytes:
          type: number
        name:
          type: string
        nullFieldVal:
          type: string
        parentFieldsToCopy:
          type: array
          items:
            type: string
        parser:
          oneOf:
            - type: object
              properties:
                allowedKeyChars:
                  type: boolean
                allowedValueChars:
                  type: array
                  items:
                    type: string
                cleanFields:
                  type: array
                  items:
                    type: string
                delimChar:
                  type: string
                dstField:
                  type: string
                escapeChar:
                  type: string
                fieldFilterExpr:
                  type: string
                fields:
                  type: array
                  items:
                    type: string
                keep:
                  type: array
                  items:
                    type: string
                mode:
                  $ref: "#/components/schemas/ParserMode"
                nullValue:
                  type: string
                quoteChar:
                  type: string
                remove:
                  type: array
                  items:
                    type: string
                srcField:
                  type: string
                type:
                  type: string
                  enum:
                    - clf
                    - csv
                    - delim
                    - elff
                  x-speakeasy-unknown-values: allow
              required:
                - mode
                - srcField
                - type
            - type: object
              properties:
                dstField:
                  type: string
                mode:
                  $ref: "#/components/schemas/ParserMode"
                pattern:
                  type: string
                patternList:
                  type: array
                  items:
                    type: object
                    properties:
                      pattern:
                        type: string
                    required:
                      - pattern
                source:
                  type: string
                srcField:
                  type: string
                type:
                  type: string
                  enum:
                    - grok
                  x-speakeasy-unknown-values: allow
              required:
                - mode
                - srcField
                - type
            - type: object
              properties:
                cleanFields:
                  type: array
                  items:
                    type: string
                dstField:
                  type: string
                fieldFilterExpr:
                  type: string
                fields:
                  type: array
                  items:
                    type: string
                keep:
                  type: array
                  items:
                    type: string
                mode:
                  $ref: "#/components/schemas/ParserMode"
                remove:
                  type: array
                  items:
                    type: string
                srcField:
                  type: string
                type:
                  type: string
                  enum:
                    - json
                  x-speakeasy-unknown-values: allow
              required:
                - mode
                - srcField
                - type
            - type: object
              properties:
                allowedKeyChars:
                  type: boolean
                allowedValueChars:
                  type: array
                  items:
                    type: string
                cleanFields:
                  type: array
                  items:
                    type: string
                delimChar:
                  type: string
                dstField:
                  type: string
                escapeChar:
                  type: string
                fieldFilterExpr:
                  type: string
                fields:
                  type: array
                  items:
                    type: string
                keep:
                  type: array
                  items:
                    type: string
                mode:
                  $ref: "#/components/schemas/ParserMode"
                nullValue:
                  type: string
                quoteChar:
                  type: string
                remove:
                  type: array
                  items:
                    type: string
                srcField:
                  type: string
                type:
                  type: string
                  enum:
                    - kvp
                  x-speakeasy-unknown-values: allow
              required:
                - mode
                - srcField
                - type
            - allOf:
                - type: object
                  properties:
                    dstField:
                      type: string
                    mode:
                      $ref: "#/components/schemas/ParserMode"
                    srcField:
                      type: string
                  required:
                    - mode
                    - srcField
                - type: object
                  properties:
                    fieldNameExpression:
                      type: string
                    iterations:
                      type: number
                    overwrite:
                      type: boolean
                    regex:
                      type: string
                    regexList:
                      type: array
                      items:
                        $ref: "#/components/schemas/RegexContainer"
                    srcField:
                      type: string
                  required:
                    - regex
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - regex
                      x-speakeasy-unknown-values: allow
                  required:
                    - type
        parserEnabled:
          type: boolean
        quoteChar:
          type: string
        shouldUseDataRaw:
          type: boolean
        timeField:
          type: string
        timestamp:
          type: object
          properties:
            format:
              type: string
            length:
              type: number
            type:
              type: string
              enum:
                - auto
                - format
                - current
              x-speakeasy-unknown-values: allow
          required:
            - type
        timestampAnchorRegex:
          type: string
        timestampEarliest:
          type: string
        timestampLatest:
          type: string
        timestampTimezone:
          oneOf:
            - type: string
            - type: object
              properties:
                name:
                  type: string
                offsets:
                  type: array
                  items:
                    type: number
                untils:
                  type: array
                  items:
                    type: number
              required:
                - name
                - offsets
                - untils
        type:
          type: string
          enum:
            - regex
            - timestamp
            - json
            - csv
            - json_array
            - header
            - aws_cloudtrail
            - aws_vpcflow
          x-speakeasy-unknown-values: allow
      required:
        - condition
        - maxEventBytes
        - name
        - timestamp
        - timestampAnchorRegex
        - timestampTimezone
    DatatypePreviewInput:
      oneOf:
        - type: object
          properties:
            dataset:
              type: string
            type:
              type: string
              enum:
                - dataset
              x-speakeasy-unknown-values: allow
          required:
            - dataset
            - type
        - type: object
          properties:
            rawData:
              type: string
            type:
              type: string
              enum:
                - rawData
              x-speakeasy-unknown-values: allow
          required:
            - rawData
            - type
    DatatypePreviewRequestBody:
      type: object
      properties:
        eventBreakerRule:
          $ref: "#/components/schemas/EventBreakerRule"
        input:
          $ref: "#/components/schemas/DatatypePreviewInput"
      required:
        - input
    SearchHealthCheckStatus:
      oneOf:
        - type: object
          properties:
            reported_at:
              type: number
            status:
              type: string
              enum:
                - green
              x-speakeasy-unknown-values: allow
          required:
            - reported_at
            - status
        - type: object
          properties:
            reason:
              type: string
              enum:
                - QUEUE_NOT_HEALTHY
                - SERVICE_UNAVAILABLE
                - STATUS_CHECK_FAILED
              x-speakeasy-unknown-values: allow
            reported_at:
              type: number
            status:
              type: string
              enum:
                - red
              x-speakeasy-unknown-values: allow
          required:
            - reason
            - reported_at
            - status
    PreviewOptions:
      type: object
      properties:
        earliest:
          oneOf:
            - type: string
            - type: number
        latest:
          oneOf:
            - type: string
            - type: number
    PreviewRequestBody:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: "#/components/schemas/SearchEvent"
        options:
          $ref: "#/components/schemas/PreviewOptions"
        query:
          type: string
      required:
        - events
        - query
    SearchJobResultsJobInfo:
      type: object
      properties:
        id:
          type: string
        query:
          type: string
        earliest:
          oneOf:
            - type: string
            - type: number
        latest:
          oneOf:
            - type: string
            - type: number
        timeCreated:
          type: number
        timeStarted:
          type: number
        timeCompleted:
          type: number
        status:
          type: string
          enum:
            - failed
            - new
            - running
            - completed
            - canceled
            - queued
          x-speakeasy-unknown-values: allow
      required:
        - id
        - query
        - status
        - timeCreated
    SearchJobResults:
      type: object
      properties:
        isFinished:
          type: boolean
        job:
          $ref: "#/components/schemas/SearchJobResultsJobInfo"
        limit:
          type: number
        offset:
          type: number
        persistedEventCount:
          type: number
        totalEventCount:
          type: number
      required:
        - isFinished
        - job
        - offset
        - persistedEventCount
        - totalEventCount
    AMTrustPolicy:
      type: object
      properties:
        Statement:
          type: array
          items:
            type: object
            properties:
              Action:
                oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
              Condition:
                type: object
                properties:
                  StringEquals:
                    type: object
              Effect:
                type: string
              Principal:
                type: object
                properties:
                  AWS:
                    type: string
                required:
                  - AWS
            required:
              - Action
              - Effect
              - Principal
        Version:
          type: string
      required:
        - Statement
        - Version
    TrustPolicy:
      type: object
      properties:
        id:
          type: string
        policy:
          $ref: "#/components/schemas/AMTrustPolicy"
      required:
        - id
        - policy
    TimeSeriesPoint:
      type: object
      properties:
        endTime:
          type: number
        startTime:
          type: number
        value:
          type: number
      required:
        - endTime
        - startTime
        - value
    DatasetStatsResponse:
      type: object
      properties:
        byteCounts:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesPoint"
        eventCounts:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesPoint"
        maxEventTime:
          type: number
        minEventTime:
          type: number
        totalByteCount:
          type: number
        totalEventCount:
          type: number
      required:
        - byteCounts
        - eventCounts
        - maxEventTime
        - minEventTime
        - totalByteCount
        - totalEventCount
    DatasetUserStats:
      type: object
      properties:
        queryCount:
          type: number
        user:
          type: string
        userDisplayName:
          type: string
      required:
        - queryCount
        - user
    DatasetUsageStatsResponse:
      type: object
      properties:
        linkedDashboards:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
            required:
              - id
        linkedNotebooks:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
            required:
              - id
        queryCounts:
          type: array
          items:
            type: object
            properties:
              count:
                type: number
              startTime:
                type: number
            required:
              - count
              - startTime
        savedQueries:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
            required:
              - id
        topUsers:
          type: array
          items:
            $ref: "#/components/schemas/DatasetUserStats"
      required:
        - queryCounts
        - topUsers
    ValueCount:
      type: object
      properties:
        count:
          type: number
      required:
        - count
    FieldStatsResponse:
      type: object
      properties:
        fieldStats:
          type: array
          items:
            oneOf:
              - allOf:
                  - type: object
                    properties:
                      count:
                        type: number
                      name:
                        type: string
                      nullCount:
                        type: number
                      uniqueCount:
                        type: number
                    required:
                      - count
                      - name
                      - nullCount
                      - uniqueCount
                  - type: object
                    properties:
                      topValues:
                        type: array
                        items:
                          $ref: "#/components/schemas/ValueCount"
                      type:
                        type: string
                        enum:
                          - string
                        x-speakeasy-unknown-values: allow
                    required:
                      - topValues
                      - type
              - allOf:
                  - type: object
                    properties:
                      count:
                        type: number
                      name:
                        type: string
                      nullCount:
                        type: number
                      uniqueCount:
                        type: number
                    required:
                      - count
                      - name
                      - nullCount
                      - uniqueCount
                  - type: object
                    properties:
                      avg:
                        type: number
                      avgValues:
                        type: array
                        items:
                          $ref: "#/components/schemas/TimeSeriesPoint"
                      max:
                        type: number
                      min:
                        type: number
                      stdDev:
                        type: number
                      topValues:
                        type: array
                        items:
                          $ref: "#/components/schemas/ValueCount"
                      type:
                        type: string
                        enum:
                          - numeric
                        x-speakeasy-unknown-values: allow
                    required:
                      - avg
                      - avgValues
                      - max
                      - min
                      - stdDev
                      - topValues
                      - type
        totalEventCount:
          type: number
      required:
        - fieldStats
        - totalEventCount
    ContainerdMount:
      type: object
      properties:
        destination:
          type: string
        source:
          type: string
      required:
        - destination
        - source
    ContainerdRoot:
      type: object
      properties:
        path:
          type: string
      required:
        - path
    ContainerdContainer:
      type: object
      properties:
        mounts:
          type: array
          items:
            $ref: "#/components/schemas/ContainerdMount"
        root:
          $ref: "#/components/schemas/ContainerdRoot"
      required:
        - mounts
        - root
    ContainerdTask:
      type: object
      properties:
        process:
          type: object
          additionalProperties: true
    ContainerdInfo:
      type: object
      properties:
        container:
          $ref: "#/components/schemas/ContainerdContainer"
        image:
          type: object
          additionalProperties: true
        metrics:
          type: object
          additionalProperties: true
        namespace:
          type: object
          additionalProperties: true
        task:
          $ref: "#/components/schemas/ContainerdTask"
      required:
        - container
    DockerGraphDriverData:
      type: object
      properties:
        MergedDir:
          type: string
      required:
        - MergedDir
    DockerGraphDriver:
      type: object
      properties:
        Data:
          $ref: "#/components/schemas/DockerGraphDriverData"
    DockerMount:
      type: object
      properties:
        Destination:
          type: string
        Source:
          type: string
      required:
        - Destination
        - Source
    DockerInfo:
      type: object
      properties:
        Config:
          type: object
          additionalProperties: true
        GraphDriver:
          $ref: "#/components/schemas/DockerGraphDriver"
        LogPath:
          type: string
        Mounts:
          type: array
          items:
            $ref: "#/components/schemas/DockerMount"
        NetworkSettings:
          type: object
          additionalProperties: true
        Path:
          type: string
        State:
          type: object
          additionalProperties: true
        Stats:
          type: object
          additionalProperties: true
    ContainerPort:
      type: object
      properties:
        privatePort:
          type: number
        publicPort:
          type: number
      required:
        - privatePort
        - publicPort
    Container:
      type: object
      properties:
        command:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        containerd:
          $ref: "#/components/schemas/ContainerdInfo"
        created:
          type: number
        docker:
          $ref: "#/components/schemas/DockerInfo"
        id:
          type: string
        image:
          type: string
        ips:
          type: array
          items:
            type: string
        name:
          type: string
        ports:
          type: array
          items:
            $ref: "#/components/schemas/ContainerPort"
        status:
          type: string
        type:
          type: string
          enum:
            - docker
            - containerd
          x-speakeasy-unknown-values: allow
      required:
        - command
        - created
        - id
        - image
        - name
        - status
        - type
    FileProcessInfo:
      type: object
      properties:
        pid:
          type: number
        process:
          type: string
      required:
        - pid
        - process
    EdgeFile:
      type: object
      properties:
        filePath:
          type: string
        id:
          type: string
        modTime:
          type: number
        mode:
          type: string
        owner:
          type: number
        processInfo:
          type: array
          items:
            $ref: "#/components/schemas/FileProcessInfo"
        size:
          type: number
      required:
        - filePath
        - id
        - modTime
        - mode
        - owner
        - size
    Process:
      type: object
      properties:
        id:
          type: string
        pid:
          type: number
        ppid:
          type: number
      required:
        - id
        - pid
        - ppid
    Collector:
      $ref: "#/components/schemas/Function"
    Executor:
      $ref: "#/components/schemas/Function"
    ProjectConfig:
      type: object
      properties:
        consumers:
          type: object
        description:
          type: string
        destinations:
          type: array
          items:
            type: string
        id:
          type: string
        subscriptions:
          type: array
          items:
            type: string
      required:
        - destinations
        - id
        - subscriptions
    ProjectDestination:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
      required:
        - id
        - type
    Connection:
      type: object
      properties:
        output:
          type: string
        pipeline:
          type: string
      required:
        - output
    SubscriptionConsumer:
      type: object
      properties:
        connections:
          type: array
          items:
            $ref: "#/components/schemas/Connection"
        disabled:
          type: boolean
        type:
          type: string
    Subscription:
      type: object
      properties:
        consumer:
          $ref: "#/components/schemas/SubscriptionConsumer"
        description:
          type: string
        disabled:
          type: boolean
        filter:
          type: string
        id:
          type: string
        pipeline:
          type: string
      required:
        - id
        - pipeline
    LookupVersions:
      type: object
    HBLeaderInfo:
      type: object
      properties:
        host:
          type: string
        port:
          type: number
        servername:
          type: string
        tls:
          type: boolean
      required:
        - host
        - port
    HBCriblInfo:
      type: object
      properties:
        config:
          type: object
          properties:
            featuresRev:
              type: string
            hbPeriodSeconds:
              type: number
            logStreamEnv:
              type: string
            policyRev:
              type: string
            version:
              type: string
        deploymentId:
          type: string
        disableSNIRouting:
          type: boolean
        distMode:
          type: string
          enum:
            - edge
            - worker
            - single
            - master
            - managed-edge
            - outpost
            - search-supervisor
          x-speakeasy-unknown-values: allow
        edgeNodes:
          type: number
        group:
          type: string
        guid:
          type: string
        installType:
          type: string
        lookupVersions:
          $ref: "#/components/schemas/LookupVersions"
        master:
          $ref: "#/components/schemas/HBLeaderInfo"
        pid:
          type: number
        socksEnabled:
          type: boolean
        startTime:
          type: number
        tags:
          type: array
          items:
            type: string
        version:
          type: string
      required:
        - config
        - distMode
        - group
        - guid
        - startTime
        - tags
    HeartbeatMetadata:
      type: object
      properties:
        aws:
          type: object
          properties:
            enabled:
              type: boolean
            instanceId:
              type: string
            region:
              type: string
            tags:
              type: object
            type:
              type: string
            zone:
              type: string
          required:
            - enabled
            - instanceId
            - region
            - type
            - zone
        hostOs:
          type: object
          properties:
            addresses:
              type: array
              items:
                type: string
            enabled:
              type: boolean
            id:
              type: string
            version:
              type: string
          required:
            - addresses
            - enabled
            - id
            - version
        kube:
          type: object
          properties:
            enabled:
              type: boolean
            namespace:
              type: string
            node:
              type: string
            owner:
              type: object
              properties:
                kind:
                  type: string
                name:
                  type: string
              required:
                - kind
                - name
            pod:
              type: string
            source:
              type: string
          required:
            - enabled
            - namespace
            - node
            - pod
            - source
        os:
          type: object
          properties:
            addresses:
              type: array
              items:
                type: string
            enabled:
              type: boolean
            id:
              type: string
            version:
              type: string
          required:
            - addresses
            - enabled
            - id
            - version
    OutpostNodeInfo:
      type: object
      properties:
        guid:
          type: string
        host:
          type: string
      required:
        - guid
        - host
    NodeProvidedInfo:
      type: object
      properties:
        architecture:
          type: string
        aws:
          type: object
          properties:
            enabled:
              type: boolean
            instanceId:
              type: string
            region:
              type: string
            tags:
              type: object
            type:
              type: string
            zone:
              type: string
          required:
            - enabled
            - instanceId
            - region
            - type
            - zone
        conn_ip:
          type: string
        cpus:
          type: number
        cribl:
          $ref: "#/components/schemas/HBCriblInfo"
        env:
          type: object
          additionalProperties:
            type: string
        freeDiskSpace:
          type: number
        hostOs:
          type: object
          properties:
            addresses:
              type: array
              items:
                type: string
            enabled:
              type: boolean
            id:
              type: string
            version:
              type: string
          required:
            - addresses
            - enabled
            - id
            - version
        hostname:
          type: string
        isSaasWorker:
          type: boolean
        kube:
          type: object
          properties:
            enabled:
              type: boolean
            namespace:
              type: string
            node:
              type: string
            owner:
              type: object
              properties:
                kind:
                  type: string
                name:
                  type: string
              required:
                - kind
                - name
            pod:
              type: string
            source:
              type: string
          required:
            - enabled
            - namespace
            - node
            - pod
            - source
        localTime:
          type: number
        metadata:
          $ref: "#/components/schemas/HeartbeatMetadata"
        node:
          type: string
        os:
          oneOf:
            - type: object
              properties:
                addresses:
                  type: array
                  items:
                    type: string
                enabled:
                  type: boolean
                id:
                  type: string
                version:
                  type: string
              required:
                - addresses
                - enabled
                - id
                - version
            - type: object
              properties:
                addresses:
                  type: array
                  items:
                    type: string
              required:
                - addresses
        outpost:
          $ref: "#/components/schemas/OutpostNodeInfo"
        platform:
          type: string
        release:
          type: string
        totalDiskSpace:
          type: number
        totalmem:
          type: number
      required:
        - architecture
        - cpus
        - cribl
        - env
        - freeDiskSpace
        - hostname
        - node
        - platform
        - release
        - totalDiskSpace
        - totalmem
    NodeActiveUpgradeStatus:
      type: integer
      enum:
        - 0
        - 1
        - 2
      x-speakeasy-unknown-values: allow
    NodeFailedUpgradeStatus:
      type: integer
      enum:
        - 0
        - 1
      x-speakeasy-unknown-values: allow
    NodeSkippedUpgradeStatus:
      type: integer
      enum:
        - 0
        - 1
        - 2
        - 3
      x-speakeasy-unknown-values: allow
    NodeUpgradeState:
      type: integer
      enum:
        - 0
        - 1
        - 2
        - 3
      x-speakeasy-unknown-values: allow
    NodeUpgradeStatus:
      type: object
      properties:
        active:
          $ref: "#/components/schemas/NodeActiveUpgradeStatus"
        failed:
          $ref: "#/components/schemas/NodeFailedUpgradeStatus"
        skipped:
          $ref: "#/components/schemas/NodeSkippedUpgradeStatus"
        state:
          $ref: "#/components/schemas/NodeUpgradeState"
        timestamp:
          type: number
      required:
        - state
        - timestamp
    MasterWorkerEntry:
      type: object
      properties:
        deployable:
          type: boolean
        disconnected:
          type: boolean
        firstMsgTime:
          type: number
        group:
          type: string
        id:
          type: string
        info:
          $ref: "#/components/schemas/NodeProvidedInfo"
        lastMetrics:
          type: object
        lastMsgTime:
          type: number
        metadata:
          $ref: "#/components/schemas/HeartbeatMetadata"
        nodeUpgradeStatus:
          $ref: "#/components/schemas/NodeUpgradeStatus"
        status:
          type: string
        type:
          type: string
          enum:
            - info
            - req
            - resp
          x-speakeasy-unknown-values: allow
        workerProcesses:
          type: number
        workers:
          type: object
          properties:
            count:
              type: number
          required:
            - count
      required:
        - firstMsgTime
        - group
        - id
        - info
        - lastMsgTime
        - workerProcesses
    RestartResponse:
      type: object
      properties:
        id:
          type: string
        message:
          type: string
        status:
          type: string
          enum:
            - Restarting
            - Error
          x-speakeasy-unknown-values: allow
      required:
        - id
        - status
    OutpostUpgradeResponse:
      type: object
      properties:
        id:
          type: string
        message:
          type: string
        status:
          type: string
          enum:
            - Upgrading
            - Error
          x-speakeasy-unknown-values: allow
      required:
        - id
        - status
    RulesetId:
      type: object
      properties:
        id:
          type: string
      required:
        - id
    MappingRuleset:
      type: object
      additionalProperties: false
      required:
        - id
      properties:
        id:
          type: string
          title: ID
        conf:
          type: object
          additionalProperties: false
          properties:
            functions:
              title: Functions
              description: List of functions to pass data through
              type: array
              items:
                type: object
                additionalProperties: true
        active:
          type: boolean
    TeamAccessControlList:
      type: object
      properties:
        perms:
          type: array
          items:
            $ref: "#/components/schemas/ResourcePolicy"
        team:
          type: string
      required:
        - perms
        - team
    DistributedSummary:
      type: object
      properties:
        groups:
          type: object
          properties:
            count:
              type: number
            destinations:
              type: number
            packs:
              type: number
            pipelines:
              type: number
            quickConnects:
              type: number
            routes:
              type: number
            sources:
              type: number
          required:
            - count
            - destinations
            - packs
            - pipelines
            - quickConnects
            - routes
            - sources
        workers:
          type: object
          properties:
            alive:
              type: number
            confVersions:
              type: number
            count:
              type: number
            disconnectedCount:
              type: number
            groups:
              type: number
            softwareVersions:
              type: number
            unhealthy:
              type: number
          required:
            - alive
            - confVersions
            - count
            - disconnectedCount
            - groups
            - softwareVersions
            - unhealthy
      required:
        - groups
        - workers
    WorkerTypes:
      type: string
      enum:
        - worker
        - managed-edge
      x-speakeasy-unknown-values: allow
  examples:
    CreateGroupExamplesCloudWg:
      summary: Create a Worker Group in Cribl.Cloud
      description: Worker Group on Cribl.Cloud with estimated ingest rate of 2048 (24
        MB/s, 9 Worker Processes)
      value:
        id: goatCloudIanWg
        name: goatCloudIanWg
        cloud:
          provider: aws
          region: us-west-2
        workerRemoteAccess: true
        isFleet: false
        isSearch: false
        onPrem: false
        estimatedIngestRate: 2048
        provisioned: true
    CreateGroupExamplesOnPremWg:
      summary: Create a Worker Group in customer-managed deployment
      value:
        id: goatOnPremIanWg
        name: goatOnPremIanWg
        description: Worker group in customer-managed deployment
        workerRemoteAccess: true
        isFleet: false
        isSearch: false
        onPrem: true
    CreateGroupExamplesCloneWg:
      summary: Clone an on-prem Worker Group
      value:
        id: goatOnPremDollyWg
        name: goatOnPremDollyWg
        description: Worker Group cloned from goatOnPremIanWg with identical configuration
        workerRemoteAccess: true
        isFleet: false
        isSearch: false
        onPrem: true
        sourceGroupId: goatOnPremIanWg
    CreateGroupExamplesEdgeFleet:
      summary: Create Edge Fleet
      value:
        id: goatIanEdgeFleet
        name: goatIanEdgeFleet
        description: Create a new Edge Fleet
        workerRemoteAccess: true
        isFleet: true
        isSearch: false
        onPrem: true
    UpdateGroupExamplesScaleCloudWorkerGroup:
      summary: Scale a Cribl.Cloud Worker Group by updating estimated ingest rate
      value:
        id: goatCloudIanWg
        name: goatCloudIanWg
        description: Scaled Worker Group with estimated ingest rate of 4096 (48 MB/s, 21
          Worker Processes) for increased capacity
        cloud:
          provider: aws
          region: us-west-2
        workerRemoteAccess: true
        isFleet: false
        isSearch: false
        onPrem: false
        estimatedIngestRate: 4096
        provisioned: true
    LookupFileInfoExamplesCancelUpload:
      summary: Cancel a lookup file upload (use with cancel=true query parameter)
      value:
        filename: temp_upload_12345.csv
    PackInstallExamplesPackDispensary:
      summary: Install from the Pack Dispensary
      value:
        source: https://packs.cribl.io/dl/cribl-duo-rest-io/latest/cribl-duo-rest-io-latest.crbl
        force: true
        allowCustomFunctions: true
    PackInstallExamplesEmptyPack:
      summary: Create new empty Pack
      value:
        version: 0.0.1
        tags:
          streamtags: []
        exports: []
        displayName: testPackFoo
        id: testPackFoo
    PackInstallExamplesUploadedFile:
      summary: Install Pack from file upload
      value:
        source: cribl-search-missing-logs-1.0.1.Do7DH5I.crbl
        id: cribl-search-missing-logs
        allowCustomFunctions: false
    PackInstallExamplesURL:
      summary: Install Pack from URL
      value:
        source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl
        allowCustomFunctions: false
    PackInstallExamplesGitRepository:
      summary: Install Pack from Git repository
      value:
        source: git+https://github.com/criblio/cribl_ocsf_postprocessing
        allowCustomFunctions: false
    PackUpgradeExamplesUpgradeFromURL:
      summary: Upgrade Pack from URL
      value:
        source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl
    MappingRulesetActivateExamplesActivate:
      summary: Activate the default Mapping Ruleset
      value:
        id: default
    MappingRulesetCreateExamplesOSBasedMapping:
      summary: Map Edge Nodes based on their Operating System (Linux, Win32, macOS)
      value:
        id: os-based-mapping
        conf:
          functions:
            - filter: platform === "linux"
              id: eval
              description: Map Linux Edge Nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'linux_fleet'"
            - filter: platform === "win32"
              id: eval
              description: Map Windows Edge Nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'windows_fleet'"
            - filter: platform === "darwin"
              id: eval
              description: Map macOS Edge Nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'macos_fleet'"
            - filter: "!cribl.group"
              id: eval
              description: Default mapping for unmapped nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetCreateExamplesTagBasedMapping:
      summary: Map Edge Nodes using cribl.tags
      value:
        id: tag-based-mapping
        conf:
          functions:
            - filter: cribl.tags.includes("WinLaptop")
              id: eval
              description: Map Windows Laptop Edge Nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'laptop_fleet'"
            - filter: cribl.tags.includes("Production")
              id: eval
              description: Map Production Edge Nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'production_fleet'"
            - filter: "!cribl.group"
              id: eval
              description: Default mapping
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetCreateExamplesOutpostBasedMapping:
      summary: Map Edge Nodes connected to a specific Outpost ID or hostname
      value:
        id: outpost-mapping
        conf:
          functions:
            - filter: outpost.host === "5ab6c676be6a"
              id: eval
              description: Map Edge Nodes from Outpost A
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'outpost_a_fleet'"
            - filter: outpost.guid === "550e8400-e29b-41d4-a716-446655440000"
              id: eval
              description: Map Edge Nodes from Outpost B by GUID
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'outpost_b_fleet'"
            - filter: "!cribl.group"
              id: eval
              description: Default mapping
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetCreateExamplesComplexMapping:
      summary: Map Edge Nodes using complex filters based on IP, CPU, memory, and
        environment
      value:
        id: complex-mapping
        conf:
          functions:
            - filter: (conn_ip.startsWith("10.10.42.") && cpus > 6) ||
                env.CRIBL_HOME.match("DMZ")
              id: eval
              description: Map high-performance nodes in specific network or DMZ
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'high_perf_fleet'"
            - filter: platform === "linux" && memory > 16000 &&
                cribl.tags.includes("Database")
              id: eval
              description: Map Linux nodes with high memory for database workloads
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'database_fleet'"
            - filter: "!cribl.group"
              id: eval
              description: Default mapping
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetCreateExamplesAWSEC2InstanceMapping:
      summary: Map Edge Nodes using AWS EC2 instance tags
      value:
        id: aws-ec2-mapping
        conf:
          functions:
            - filter: aws?.tags?.Environment === "Production"
              id: eval
              description: Map Production EC2 instances
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'aws_prod_fleet'"
            - filter: aws?.tags?.Team === "DevOps"
              id: eval
              description: Map DevOps team EC2 instances
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'devops_fleet'"
            - filter: "!cribl.group"
              id: eval
              description: Default mapping
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetCreateExamplesContainerBasedMapping:
      summary: Map Edge Nodes running in containers based on host characteristics
      value:
        id: container-mapping
        conf:
          functions:
            - filter: hostOs?.platform === "linux" && hostOs?.cpu_count > 4
              id: eval
              description: Map containerized nodes on high-CPU Linux hosts
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'container_high_cpu_fleet'"
            - filter: hostOs?.id
              id: eval
              description: Map all containerized Edge Nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'container_fleet'"
            - filter: "!cribl.group"
              id: eval
              description: Default mapping for non-containerized nodes
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetCreateExamplesDefaultRuleset:
      summary: Routes all unmapped Edge Nodes to the default_fleet
      value:
        id: simple-default-mappings
        conf:
          functions:
            - filter: "!cribl.group"
              id: eval
              description: Simple default Mapping Ruleset
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetUpdateExamplesUpdateComplexRule:
      summary: Modify an existing ruleset with a complex, multi-condition filter
      value:
        id: complex-mapping
        conf:
          functions:
            - filter: (conn_ip.startsWith("10.10.42.") && cpus > 6) ||
                env.CRIBL_HOME.match("DMZ")
              id: eval
              description: Map high-performance nodes in specific network or DMZ
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'high_perf_fleet'"
            - filter: "!cribl.group"
              id: eval
              description: Default mapping
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
    MappingRulesetUpdateExamplesEnableDisabledRule:
      summary: Change an existing ruleset flag to enable it
      value:
        id: default
        conf:
          functions:
            - filter: "!cribl.group"
              id: eval
              description: Default Mappings
              disabled: false
              final: true
              conf:
                add:
                  - name: groupId
                    value: "'default_fleet'"
        active: true
security:
  - bearerAuth: []
tags:
  - name: ai-settings
    description: Actions related to Ai Settings
  - name: appscope-configs
    description: Actions related to Appscope Configs
  - name: auth
    description: Actions related to authentication. Do not use the /auth endpoints
      in Cribl.Cloud deployments. Instead, follow the instructions at
      https://docs.cribl.io/stream/api-tutorials/#criblcloud to authenticate for
      Cribl.Cloud.
  - name: authorize
    description: Actions related to Authorize
  - name: banners
    description: Actions related to Banners
  - name: certificates
    description: Actions related to Certificates
  - name: changelog
    description: Actions related to Changelog
  - name: click-house
    description: Actions related to ClickHouse
  - name: clui
    description: Actions related to CLUI
  - name: collectors
    description: Actions related to Collectors
  - name: conditions
    description: Actions related to Conditions
  - name: consent
    description: Actions related to Consent
  - name: dashboardCategories
    description: Actions related to DashboardCategories
  - name: dashboards
    description: Actions related to Dashboards
  - name: database-connections
    description: Actions related to Database Connections
  - name: datasets
    description: Actions related to Datasets
  - name: datatypes
    description: Actions related to Datatypes
  - name: destinations
    description: Actions related to Destinations
  - name: diag
    description: Actions related to diagnostics
  - name: distributed
    description: Actions related to Distributed
  - name: edge
    description: Actions enabled in Edge
  - name: edgeAppScopeProcesses
    description: Actions related to Edge AppScope processes
  - name: edgeContainers
    description: Actions related to Edge containers
  - name: edgeEvents
    description: Actions related to EdgeEvents
  - name: edgeLs
    description: Actions related to Edge listing
  - name: edgeProcesses
    description: Actions related to Edge processes
  - name: event_breaker_rules
    description: Actions related to Event Breaker rules
  - name: events
    description: Actions related to Events
  - name: executors
    description: Actions related to Executors
  - name: expressions
    description: Actions related to expressions
  - name: features
    description: Actions related to Features
  - name: functions
    description: Actions related to functions
  - name: git
    description: Actions related to Git
  - name: globalVariables
    description: Actions related to Global Variables
  - name: grokfiles
    description: Actions related to Grok files
  - name: groups
    description: Actions related to Groups
  - name: health
    description: Actions related to REST server health
  - name: hmac-functions
    description: Actions related to HMAC functions
  - name: insights
    description: Actions related to Insights
  - name: iometrics
    description: Actions related to source/destination metrics
  - name: jobs
    description: Actions related to Jobs
  - name: keys
    description: Actions related to encryption keys
  - name: kube-logs
    description: Actions related to Kube Logs
  - name: kube-proxy
    description: Actions related to Kube Proxy
  - name: lake
    description: Actions related to Lake
  - name: licenses
    description: Actions related to licenses. The <code>/licenses</code> endpoints
      do not apply to Cribl.Cloud deployments.
  - name: logger
    description: Actions related to Logger
  - name: logging
    description: Actions related to logging
  - name: lookups
    description: Actions related to lookups
  - name: macros
    description: Actions related to Macros
  - name: mappings
    description: Actions related to Mappings
  - name: messages
    description: Actions related to messages
  - name: metrics
    description: Actions related to metrics
  - name: notebooks
    description: Actions related to Notebooks
  - name: notification-targets
    description: Actions related to Notification Targets
  - name: notifications
    description: Actions related to Notifications
  - name: onlyOnPrem
    description: Actions only available for onprem deployments and do not apply to
      Cribl.Cloud deployments
  - name: outpost
    description: Actions related to Outpost
  - name: packs
    description: Actions related to Packs
  - name: parquetschemas
    description: Actions related to Parquet schemas
  - name: parsers
    description: Actions related to parsers
  - name: pipelines
    description: Actions related to Pipelines
  - name: policies
    description: Actions related to Policies
  - name: preview
    description: Actions related to data preview
  - name: processes
    description: Actions related to Processes
  - name: profiler
    description: Actions related to Profiler
  - name: projects
    description: Actions related to Projects
  - name: protobuflibraries
    description: Actions related to Protobuf libraries
  - name: query
    description: Actions related to Query
  - name: regexes
    description: Actions related to regular expressions
  - name: roles
    description: Actions related to Roles
  - name: routes
    description: Actions related to Routes
  - name: samples
    description: Actions related to samples
  - name: saved-jobs
    description: Actions related to Saved Jobs
  - name: savedQueries
    description: Actions related to saved queries
  - name: schemas
    description: Actions related to Schemas
  - name: scripts
    description: Actions related to scripts
  - name: sds-rules
    description: Actions related to Sds Rules
  - name: sds-rulesets
    description: Actions related to Sds Rulesets
  - name: search
    description: Actions related to Search
  - name: secrets
    description: Actions related to Secrets
  - name: security
    description: Actions related to Security
  - name: sources
    description: Actions related to Sources
  - name: subscriptions
    description: Actions related to Subscriptions
  - name: system
    description: Actions related to system settings
  - name: teams
    description: Actions related to Teams
  - name: trust-policies
    description: Actions related to Trust Policies
  - name: uiState
    description: Actions related to UiState
  - name: usage-groups
    description: Actions related to Usage Groups
  - name: users
    description: Actions related to users. The <code>/system/users</code> endpoints
      do not apply to Cribl.Cloud deployments. Instead use
      <code>/products/{product}/users</code>
  - name: versioning
    description: Actions related to Versioning
  - name: workers
    description: Actions related to Workers
paths:
  /system/banners:
    get:
      operationId: listBannerMessage
      x-speakeasy-name-override: list
      tags:
        - banners
      summary: Get a list of BannerMessage objects
      description: Get a list of BannerMessage objects
      responses:
        "200":
          description: a list of BannerMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BannerMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createBannerMessage
      x-speakeasy-name-override: create
      tags:
        - banners
      summary: Create BannerMessage
      description: Create BannerMessage
      requestBody:
        description: New BannerMessage object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BannerMessage"
      responses:
        "200":
          description: a list of BannerMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BannerMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/banners/{id}:
    get:
      operationId: getBannerMessageById
      x-speakeasy-name-override: get
      tags:
        - banners
      summary: Get BannerMessage by ID
      description: Get BannerMessage by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of BannerMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BannerMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateBannerMessageById
      x-speakeasy-name-override: update
      tags:
        - banners
      summary: Update BannerMessage
      description: Update BannerMessage
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: BannerMessage object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BannerMessage"
      responses:
        "200":
          description: a list of BannerMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BannerMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteBannerMessageById
      x-speakeasy-name-override: delete
      tags:
        - banners
      summary: Delete BannerMessage
      description: Delete BannerMessage
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of BannerMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BannerMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/certificates:
    get:
      operationId: listCertificate
      x-speakeasy-name-override: list
      tags:
        - certificates
      summary: Get a list of Certificate objects
      description: Get a list of Certificate objects
      responses:
        "200":
          description: a list of Certificate objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Certificate"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createCertificate
      x-speakeasy-name-override: create
      tags:
        - certificates
      summary: Create Certificate
      description: Create Certificate
      requestBody:
        description: New Certificate object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Certificate"
      responses:
        "200":
          description: a list of Certificate objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Certificate"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/certificates/{id}:
    get:
      operationId: getCertificateById
      x-speakeasy-name-override: get
      tags:
        - certificates
      summary: Get Certificate by ID
      description: Get Certificate by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Certificate objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Certificate"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateCertificateById
      x-speakeasy-name-override: update
      tags:
        - certificates
      summary: Update Certificate
      description: Update Certificate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Certificate object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Certificate"
      responses:
        "200":
          description: a list of Certificate objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Certificate"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteCertificateById
      x-speakeasy-name-override: delete
      tags:
        - certificates
      summary: Delete Certificate
      description: Delete Certificate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Certificate objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Certificate"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /settings/features/{id}:
    get:
      operationId: getFeaturesEntryById
      tags:
        - features
      summary: Get feature by id (i.e. 'type-name`)
      description: Get feature by id (i.e. 'type-name`)
      deprecated: false
      responses:
        "200":
          description: a list of FeaturesEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/FeaturesEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Feature id
  /settings/features:
    get:
      operationId: getFeaturesEntry
      tags:
        - features
      summary: List all features
      description: List all features
      deprecated: false
      responses:
        "200":
          description: a list of FeaturesEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/FeaturesEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /master/groups:
    post:
      operationId: createGroups
      tags:
        - groups
      summary: Create a Fleet or Worker Group
      description: Create a Fleet or Worker Group
      deprecated: false
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: GroupCreateRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GroupCreateRequest"
            examples:
              CreateGroupExamplesCloudWg:
                $ref: "#/components/examples/CreateGroupExamplesCloudWg"
              CreateGroupExamplesOnPremWg:
                $ref: "#/components/examples/CreateGroupExamplesOnPremWg"
              CreateGroupExamplesCloneWg:
                $ref: "#/components/examples/CreateGroupExamplesCloneWg"
              CreateGroupExamplesEdgeFleet:
                $ref: "#/components/examples/CreateGroupExamplesEdgeFleet"
    get:
      operationId: getGroups
      tags:
        - groups
      summary: Get a list of ConfigGroup objects
      description: Get a list of ConfigGroup objects
      deprecated: false
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: fields
          in: query
          required: false
          schema:
            type: string
          description: "fields to add to results: git.commit, git.localChanges, git.log"
        - name: product
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: filter to specific product
  /master/groups/{id}:
    delete:
      operationId: deleteGroupsById
      tags:
        - groups
      x-speakeasy-group: groups
      summary: Delete a Worker Group or Edge Fleet
      description: Delete the specified Worker Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to delete.
    get:
      operationId: getGroupsById
      tags:
        - groups
      x-speakeasy-group: groups
      summary: Get a Worker Group or Edge Fleet
      description: Get the specified Worker Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get.
        - name: fields
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated list of additional properties to include in the
            response. Available values are <code>git.commit</code>,
            <code>git.localChanges</code>, and <code>git.log</code>.
    patch:
      operationId: updateGroupsById
      tags:
        - groups
      summary: Update a Worker Group or Edge Fleet
      description: Update the specified Worker Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: ConfigGroup object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConfigGroup"
            examples:
              UpdateGroupExamplesScaleCloudWorkerGroup:
                $ref: "#/components/examples/UpdateGroupExamplesScaleCloudWorkerGroup"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to update.
  /master/groups/{id}/acl:
    get:
      operationId: getGroupsAclById
      tags:
        - groups
      x-speakeasy-group: groups.acl
      summary: Get the Access Control List for a Worker Group or Edge Fleet
      description: Get the Access Control List (ACL) for the specified Worker Group or
        Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            ACL for.
        - name: type
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/RbacResource"
          description: Filter for limiting the response to ACL entries for the specified
            RBAC resource type.
  /master/groups/{id}/acl/apply:
    post:
      operationId: createConfigGroupAclApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Create
      description: Add/remove accesses to ConfigGroup for users
      summary: Modify ConfigGroup ACL
      tags:
        - groups
  /master/groups/{id}/acl/teams:
    get:
      operationId: getConfigGroupAclTeamsById
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Get
      description: List accesses to ConfigGroup granted to Teams
      summary: Get ConfigGroup Teams
      tags:
        - groups
  /master/groups/{id}/acl/teams/apply:
    post:
      operationId: createConfigGroupAclTeamsApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Create
      description: Add/remove accesses to ConfigGroup for Teams
      summary: Modify ConfigGroup Teams ACL
      tags:
        - groups
  /master/groups/{id}/configVersion:
    get:
      operationId: getGroupsConfigVersionById
      tags:
        - groups
      summary: Get the configuration version for a Worker Group or Edge Fleet
      description: Get the configuration version for the specified Worker Group or
        Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            configuration version for.
  /master/groups/{id}/deploy:
    patch:
      operationId: updateGroupsDeployById
      tags:
        - groups
      summary: Deploy commits to a Worker Group or Edge Fleet
      description: Deploy commits to the specified Worker Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: DeployRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeployRequest"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the target Worker Group or Edge Fleet for
            commit deployment.
  /system/keys:
    get:
      operationId: listKeyMetadataEntity
      x-speakeasy-name-override: list
      tags:
        - keys
      summary: Get a list of KeyMetadataEntity objects
      description: Get a list of KeyMetadataEntity objects
      responses:
        "200":
          description: a list of KeyMetadataEntity objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KeyMetadataEntity"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createKeyMetadataEntity
      x-speakeasy-name-override: create
      tags:
        - keys
      summary: Create KeyMetadataEntity
      description: Create KeyMetadataEntity
      requestBody:
        description: New KeyMetadataEntity object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/KeyMetadataEntity"
      responses:
        "200":
          description: a list of KeyMetadataEntity objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KeyMetadataEntity"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/keys/{id}:
    get:
      operationId: getKeyMetadataEntityById
      x-speakeasy-name-override: get
      tags:
        - keys
      summary: Get KeyMetadataEntity by ID
      description: Get KeyMetadataEntity by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of KeyMetadataEntity objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KeyMetadataEntity"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateKeyMetadataEntityById
      x-speakeasy-name-override: update
      tags:
        - keys
      summary: Update KeyMetadataEntity
      description: Update KeyMetadataEntity
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: KeyMetadataEntity object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/KeyMetadataEntity"
      responses:
        "200":
          description: a list of KeyMetadataEntity objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KeyMetadataEntity"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteKeyMetadataEntityById
      x-speakeasy-name-override: delete
      tags:
        - keys
      summary: Delete KeyMetadataEntity
      description: Delete KeyMetadataEntity
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of KeyMetadataEntity objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KeyMetadataEntity"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/messages:
    get:
      operationId: listBulletinMessage
      x-speakeasy-name-override: list
      tags:
        - messages
      summary: Get a list of BulletinMessage objects
      description: Get a list of BulletinMessage objects
      responses:
        "200":
          description: a list of BulletinMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BulletinMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createBulletinMessage
      x-speakeasy-name-override: create
      tags:
        - messages
      summary: Create BulletinMessage
      description: Create BulletinMessage
      requestBody:
        description: New BulletinMessage object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BulletinMessage"
      responses:
        "200":
          description: a list of BulletinMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BulletinMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/messages/{id}:
    get:
      operationId: getBulletinMessageById
      x-speakeasy-name-override: get
      tags:
        - messages
      summary: Get BulletinMessage by ID
      description: Get BulletinMessage by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of BulletinMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BulletinMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteBulletinMessageById
      x-speakeasy-name-override: delete
      tags:
        - messages
      summary: Delete BulletinMessage
      description: Delete BulletinMessage
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of BulletinMessage objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BulletinMessage"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /notification-targets:
    get:
      operationId: listNotificationTarget
      x-speakeasy-name-override: list
      tags:
        - notification-targets
      summary: Get a list of NotificationTarget objects
      description: Get a list of NotificationTarget objects
      responses:
        "200":
          description: a list of NotificationTarget objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/NotificationTarget"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createNotificationTarget
      x-speakeasy-name-override: create
      tags:
        - notification-targets
      summary: Create NotificationTarget
      description: Create NotificationTarget
      requestBody:
        description: New NotificationTarget object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NotificationTarget"
      responses:
        "200":
          description: a list of NotificationTarget objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/NotificationTarget"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /notification-targets/{id}:
    get:
      operationId: getNotificationTargetById
      x-speakeasy-name-override: get
      tags:
        - notification-targets
      summary: Get NotificationTarget by ID
      description: Get NotificationTarget by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of NotificationTarget objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/NotificationTarget"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateNotificationTargetById
      x-speakeasy-name-override: update
      tags:
        - notification-targets
      summary: Update NotificationTarget
      description: Update NotificationTarget
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: NotificationTarget object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NotificationTarget"
      responses:
        "200":
          description: a list of NotificationTarget objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/NotificationTarget"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteNotificationTargetById
      x-speakeasy-name-override: delete
      tags:
        - notification-targets
      summary: Delete NotificationTarget
      description: Delete NotificationTarget
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of NotificationTarget objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/NotificationTarget"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /notifications:
    get:
      operationId: listNotification
      x-speakeasy-name-override: list
      tags:
        - notifications
      summary: Get a list of Notification objects
      description: Get a list of Notification objects
      responses:
        "200":
          description: a list of Notification objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Notification"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createNotification
      x-speakeasy-name-override: create
      tags:
        - notifications
      summary: Create Notification
      description: Create Notification
      requestBody:
        description: New Notification object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Notification"
      responses:
        "200":
          description: a list of Notification objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Notification"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /notifications/{id}:
    get:
      operationId: getNotificationById
      x-speakeasy-name-override: get
      tags:
        - notifications
      summary: Get Notification by ID
      description: Get Notification by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Notification objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Notification"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateNotificationById
      x-speakeasy-name-override: update
      tags:
        - notifications
      summary: Update Notification
      description: Update Notification
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Notification object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Notification"
      responses:
        "200":
          description: a list of Notification objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Notification"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteNotificationById
      x-speakeasy-name-override: delete
      tags:
        - notifications
      summary: Delete Notification
      description: Delete Notification
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Notification objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Notification"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/policies:
    get:
      operationId: listPolicyRule
      x-speakeasy-name-override: list
      tags:
        - policies
      summary: Get a list of PolicyRule objects
      description: Get a list of PolicyRule objects
      responses:
        "200":
          description: a list of PolicyRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PolicyRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createPolicyRule
      x-speakeasy-name-override: create
      tags:
        - policies
      summary: Create PolicyRule
      description: Create PolicyRule
      requestBody:
        description: New PolicyRule object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PolicyRule"
      responses:
        "200":
          description: a list of PolicyRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PolicyRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/policies/{id}:
    get:
      operationId: getPolicyRuleById
      x-speakeasy-name-override: get
      tags:
        - policies
      summary: Get PolicyRule by ID
      description: Get PolicyRule by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of PolicyRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PolicyRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updatePolicyRuleById
      x-speakeasy-name-override: update
      tags:
        - policies
      summary: Update PolicyRule
      description: Update PolicyRule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: PolicyRule object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PolicyRule"
      responses:
        "200":
          description: a list of PolicyRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PolicyRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deletePolicyRuleById
      x-speakeasy-name-override: delete
      tags:
        - policies
      summary: Delete PolicyRule
      description: Delete PolicyRule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of PolicyRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PolicyRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/roles:
    get:
      operationId: listRole
      x-speakeasy-name-override: list
      tags:
        - roles
      summary: Get a list of Role objects
      description: Get a list of Role objects
      responses:
        "200":
          description: a list of Role objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Role"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createRole
      x-speakeasy-name-override: create
      tags:
        - roles
      summary: Create Role
      description: Create Role
      requestBody:
        description: New Role object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Role"
      responses:
        "200":
          description: a list of Role objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Role"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/roles/{id}:
    get:
      operationId: getRoleById
      x-speakeasy-name-override: get
      tags:
        - roles
      summary: Get Role by ID
      description: Get Role by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Role objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Role"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateRoleById
      x-speakeasy-name-override: update
      tags:
        - roles
      summary: Update Role
      description: Update Role
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Role object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Role"
      responses:
        "200":
          description: a list of Role objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Role"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteRoleById
      x-speakeasy-name-override: delete
      tags:
        - roles
      summary: Delete Role
      description: Delete Role
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Role objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Role"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/scripts:
    get:
      operationId: listScript
      x-speakeasy-name-override: list
      tags:
        - scripts
      summary: Get a list of Script objects
      description: Get a list of Script objects
      responses:
        "200":
          description: a list of Script objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ScriptLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createScript
      x-speakeasy-name-override: create
      tags:
        - scripts
      summary: Create Script
      description: Create Script
      requestBody:
        description: New Script object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ScriptLibEntry"
      responses:
        "200":
          description: a list of Script objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ScriptLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/scripts/{id}:
    get:
      operationId: getScriptById
      x-speakeasy-name-override: get
      tags:
        - scripts
      summary: Get Script by ID
      description: Get Script by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Script objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ScriptLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateScriptById
      x-speakeasy-name-override: update
      tags:
        - scripts
      summary: Update Script
      description: Update Script
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Script object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ScriptLibEntry"
      responses:
        "200":
          description: a list of Script objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ScriptLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteScriptById
      x-speakeasy-name-override: delete
      tags:
        - scripts
      summary: Delete Script
      description: Delete Script
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Script objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ScriptLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/instance:
    get:
      operationId: listInstanceSettingsSchema
      x-speakeasy-name-override: list
      tags:
        - system
      summary: Get a list of InstanceSettingsSchema objects
      description: Get a list of InstanceSettingsSchema objects
      responses:
        "200":
          description: a list of InstanceSettingsSchema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/InstanceSettingsSchema"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/instance/{id}: {}
  /system/teams:
    post:
      operationId: createTeam
      x-speakeasy-name-override: create
      tags:
        - teams
      summary: Create Team
      description: Create Team
      requestBody:
        description: New Team object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Team"
      responses:
        "200":
          description: a list of Team objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Team"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    get:
      operationId: getTeam
      tags:
        - teams
      summary: Get a list of Team objects
      description: Get a list of Team objects
      deprecated: false
      responses:
        "200":
          description: a list of Team objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Team"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/ProductsExtended"
          description: filter teams by product
  /system/teams/{id}:
    get:
      operationId: getTeamById
      x-speakeasy-name-override: get
      tags:
        - teams
      summary: Get Team by ID
      description: Get Team by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Team objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Team"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateTeamById
      x-speakeasy-name-override: update
      tags:
        - teams
      summary: Update Team
      description: Update Team
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Team object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Team"
      responses:
        "200":
          description: a list of Team objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Team"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteTeamById
      x-speakeasy-name-override: delete
      tags:
        - teams
      summary: Delete Team
      description: Delete Team
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Team objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Team"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/teams/{id}/acl:
    get:
      operationId: getTeamAclById
      tags:
        - teams
      summary: Get Teams's Access Control List
      description: Get Teams's Access Control List
      deprecated: false
      responses:
        "200":
          description: a list of ResourcePolicy objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ResourcePolicy"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Team name
        - name: type
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/RbacResource"
          description: resource type by which to filter access levels
  /system/teams/users/{id}/roles:
    get:
      operationId: getTeamRolesById
      tags:
        - teams
      summary: Get user's product roles
      description: Get user's product roles
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: user id
  /system/teams/{id}/users:
    get:
      operationId: getTeamUsersById
      tags:
        - teams
      summary: Get users on a team
      description: Get users on a team
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Team Name
    post:
      operationId: createTeamUsersById
      tags:
        - teams
      summary: Update existing users on a team – admin use only
      description: Update existing users on a team – admin use only
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: MembershipSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MembershipSchema"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Team name
  /system/users:
    get:
      operationId: listUser
      x-speakeasy-name-override: list
      tags:
        - users
        - onlyOnPrem
      summary: Get a list of User objects
      description: Get a list of User objects
      responses:
        "200":
          description: a list of User objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/User"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createUser
      x-speakeasy-name-override: create
      tags:
        - users
        - onlyOnPrem
      summary: Create User
      description: Create User
      requestBody:
        description: New User object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/User"
      responses:
        "200":
          description: a list of User objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/User"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/users/{id}:
    get:
      operationId: getUserById
      x-speakeasy-name-override: get
      tags:
        - users
        - onlyOnPrem
      summary: Get User by ID
      description: Get User by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of User objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/User"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateUserById
      x-speakeasy-name-override: update
      tags:
        - users
        - onlyOnPrem
      summary: Update User properties – admin use only
      description: Update User properties – admin use only
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: User Id
      requestBody:
        description: UserProfile object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserProfile"
      responses:
        "200":
          description: a list of UserProfile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserProfile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deleteUserById
      x-speakeasy-name-override: delete
      tags:
        - users
        - onlyOnPrem
      summary: Delete User
      description: Delete User
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of User objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/User"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/users/{id}/info:
    patch:
      operationId: updateUserInfoById
      tags:
        - users
        - onlyOnPrem
      summary: Update User except for their roles
      description: Update User except for their roles
      deprecated: false
      responses:
        "200":
          description: a list of User objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/User"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: UserInfo object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserInfo"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: User Id
  /products/lake/lakes/{lakeId}/datasets:
    patch:
      operationId: updateCriblLakeDatasetByLakeId
      tags:
        - lake
      x-speakeasy-group: lakeDatasets
      x-speakeasy-name-override: bulkUpdate
      summary: Updates a list of datasets in the specified Lake
      description: Updates a list of datasets in the specified Lake
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeDataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeDataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CriblLakeDataset object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CriblLakeDataset"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: lake id that contains the Datasets
    post:
      operationId: createCriblLakeDatasetByLakeId
      tags:
        - lake
      x-speakeasy-group: lakeDatasets
      x-speakeasy-name-override: create
      summary: Create a Lake Dataset
      description: Create a new Lake Dataset in the specified Lake.
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeDataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeDataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CriblLakeDataset object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CriblLakeDataset"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake to create the Lake Dataset in.
    get:
      operationId: getCriblLakeDatasetByLakeId
      tags:
        - lake
      x-speakeasy-group: lakeDatasets
      x-speakeasy-name-override: list
      summary: List all Lake Datasets
      description: Get a list of all Lake Datasets in the specified Lake.
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeDataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeDataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake that contains the Lake Datasets to
            list.
        - name: storageLocationId
          in: query
          required: false
          schema:
            type: string
          description: Filter datasets by storage location ID. Use <code>default</code>
            for default storage location.
        - name: format
          in: query
          required: false
          schema:
            type: string
          description: Filter datasets by format. Set to <code>ddss</code> to return only
            DDSS datasets.
        - name: excludeDDSS
          in: query
          required: false
          schema:
            type: boolean
          description: Exclude DDSS format datasets from the response.
        - name: excludeDeleted
          in: query
          required: false
          schema:
            type: boolean
          description: Exclude deleted datasets from the response.
        - name: excludeInternal
          in: query
          required: false
          schema:
            type: boolean
          description: Exclude internal datasets (those with IDs starting with
            <code>cribl_</code>) from the response.
        - name: excludeBYOS
          in: query
          required: false
          schema:
            type: boolean
          description: Exclude BYOS (Bring Your Own Storage) datasets from the response.
  /products/lake/lakes/{lakeId}/datasets/{id}:
    delete:
      operationId: deleteCriblLakeDatasetByLakeIdAndId
      tags:
        - lake
      x-speakeasy-group: lakeDatasets
      x-speakeasy-name-override: delete
      summary: Delete a Lake Dataset
      description: Delete the specified Lake Dataset in the specified Lake
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeDataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeDataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake that contains the Lake Dataset to
            delete.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake Dataset to delete.
    get:
      operationId: getCriblLakeDatasetByLakeIdAndId
      tags:
        - lake
      x-speakeasy-group: lakeDatasets
      x-speakeasy-name-override: get
      summary: Get a Lake Dataset
      description: Get the specified Lake Dataset in the specified Lake.
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeDataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeDataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake that contains the Lake Dataset to
            get.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake Dataset to get.
    patch:
      operationId: updateCriblLakeDatasetByLakeIdAndId
      tags:
        - lake
      x-speakeasy-group: lakeDatasets
      x-speakeasy-name-override: update
      summary: Update a Lake Dataset
      description: Update the specified Lake Dataset in the specified Lake.
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeDataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeDataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CriblLakeDatasetUpdate object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CriblLakeDatasetUpdate"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake that contains the Lake Dataset to
            update.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Lake Dataset to update.
  /products/lake/lakes/{lakeId}/storage-locations:
    post:
      operationId: createCriblLakeStorageLocationByLakeId
      tags:
        - lake
      summary: Create a Storage Location in the specified Lake
      description: Create a Storage Location in the specified Lake
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeStorageLocation objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeStorageLocation"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CriblLakeStorageLocation object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CriblLakeStorageLocation"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: lake id that contains the Storage Locations
    get:
      operationId: getCriblLakeStorageLocationByLakeId
      tags:
        - lake
      summary: Get the list of Storage Locations contained in the specified Lake
      description: Get the list of Storage Locations contained in the specified Lake
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeStorageLocation objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeStorageLocation"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: lake id that contains the Storage Locations
  /products/lake/lakes/{lakeId}/storage-locations/{id}:
    delete:
      operationId: deleteCriblLakeStorageLocationByLakeIdAndId
      tags:
        - lake
      summary: Delete a Storage Location in the specified Lake
      description: Delete a Storage Location in the specified Lake
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeStorageLocation objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeStorageLocation"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: lake id that contains the Storage Locations
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: storage location id to delete
    get:
      operationId: getCriblLakeStorageLocationByLakeIdAndId
      tags:
        - lake
      summary: Get a Storage Location in the specified Lake
      description: Get a Storage Location in the specified Lake
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeStorageLocation objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeStorageLocation"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: lake id that contains the Storage Locations
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: storage location id to get
    patch:
      operationId: updateCriblLakeStorageLocationByLakeIdAndId
      tags:
        - lake
      summary: Update a Storage Location in the specified Lake
      description: Update a Storage Location in the specified Lake
      deprecated: false
      responses:
        "200":
          description: a list of CriblLakeStorageLocation objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CriblLakeStorageLocation"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CriblLakeStorageLocation object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CriblLakeStorageLocation"
      parameters:
        - name: lakeId
          in: path
          required: true
          schema:
            type: string
          description: lake id that contains the Storage Locations
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: storage location id to update
  /search/dashboard-categories:
    get:
      operationId: listDashboardCategory
      x-speakeasy-name-override: list
      tags:
        - dashboardCategories
      summary: Get a list of DashboardCategory objects
      description: Get a list of DashboardCategory objects
      responses:
        "200":
          description: a list of DashboardCategory objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DashboardCategory"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createDashboardCategory
      x-speakeasy-name-override: create
      tags:
        - dashboardCategories
      summary: Create DashboardCategory
      description: Create DashboardCategory
      requestBody:
        description: New DashboardCategory object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DashboardCategory"
      responses:
        "200":
          description: a list of DashboardCategory objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DashboardCategory"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/dashboard-categories/{id}:
    get:
      operationId: getDashboardCategoryById
      x-speakeasy-name-override: get
      tags:
        - dashboardCategories
      summary: Get DashboardCategory by ID
      description: Get DashboardCategory by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of DashboardCategory objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DashboardCategory"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateDashboardCategoryById
      x-speakeasy-name-override: update
      tags:
        - dashboardCategories
      summary: Update DashboardCategory
      description: Update DashboardCategory
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: DashboardCategory object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DashboardCategory"
      responses:
        "200":
          description: a list of DashboardCategory objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DashboardCategory"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteDashboardCategoryById
      x-speakeasy-name-override: delete
      tags:
        - dashboardCategories
      summary: Delete DashboardCategory
      description: Delete DashboardCategory
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of DashboardCategory objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DashboardCategory"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/datatypes:
    get:
      operationId: listDataTypeDescriptor
      x-speakeasy-name-override: list
      tags:
        - datatypes
      summary: Get a list of DataTypeDescriptor objects
      description: Get a list of DataTypeDescriptor objects
      responses:
        "200":
          description: a list of DataTypeDescriptor objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataTypeDescriptor"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createDataTypeDescriptor
      x-speakeasy-name-override: create
      tags:
        - datatypes
      summary: Create DataTypeDescriptor
      description: Create DataTypeDescriptor
      requestBody:
        description: New DataTypeDescriptor object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DataTypeDescriptor"
      responses:
        "200":
          description: a list of DataTypeDescriptor objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataTypeDescriptor"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/datatypes/{id}:
    get:
      operationId: getDataTypeDescriptorById
      x-speakeasy-name-override: get
      tags:
        - datatypes
      summary: Get DataTypeDescriptor by ID
      description: Get DataTypeDescriptor by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of DataTypeDescriptor objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataTypeDescriptor"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateDataTypeDescriptorById
      x-speakeasy-name-override: update
      tags:
        - datatypes
      summary: Update DataTypeDescriptor
      description: Update DataTypeDescriptor
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: DataTypeDescriptor object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DataTypeDescriptor"
      responses:
        "200":
          description: a list of DataTypeDescriptor objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataTypeDescriptor"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteDataTypeDescriptorById
      x-speakeasy-name-override: delete
      tags:
        - datatypes
      summary: Delete DataTypeDescriptor
      description: Delete DataTypeDescriptor
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of DataTypeDescriptor objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataTypeDescriptor"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/notebooks/{id}/activity:
    get:
      operationId: getNotebookActivityById
      tags:
        - notebooks
      summary: Get notebook activity history
      description: Get notebook activity history
      deprecated: false
      responses:
        "200":
          description: a list of NotebookActivityResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/NotebookActivityResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Notebook ID
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: "Maximum number of activity events to retrieve (default: 50, max:
            1000)"
        - name: offset
          in: query
          required: false
          schema:
            type: string
          description: 'Offset for pagination (format:
            "filePath:rotationIdx:offset:reverseRead")'
        - name: et
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the earliest event
        - name: lt
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the latest event
        - name: filter
          in: query
          required: false
          schema:
            type: string
          description: Filter expression
  /search/usage-groups:
    get:
      operationId: listUsageGroup
      x-speakeasy-name-override: list
      tags:
        - usage-groups
      summary: Get a list of UsageGroup objects
      description: Get a list of UsageGroup objects
      responses:
        "200":
          description: a list of UsageGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UsageGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createUsageGroup
      x-speakeasy-name-override: create
      tags:
        - usage-groups
      summary: Create UsageGroup
      description: Create UsageGroup
      requestBody:
        description: New UsageGroup object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UsageGroup"
      responses:
        "200":
          description: a list of UsageGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UsageGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/usage-groups/{id}:
    get:
      operationId: getUsageGroupById
      x-speakeasy-name-override: get
      tags:
        - usage-groups
      summary: Get UsageGroup by ID
      description: Get UsageGroup by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of UsageGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UsageGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateUsageGroupById
      x-speakeasy-name-override: update
      tags:
        - usage-groups
      summary: Update UsageGroup
      description: Update UsageGroup
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: UsageGroup object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UsageGroup"
      responses:
        "200":
          description: a list of UsageGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UsageGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteUsageGroupById
      x-speakeasy-name-override: delete
      tags:
        - usage-groups
      summary: Delete UsageGroup
      description: Delete UsageGroup
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of UsageGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UsageGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/dataset-provider-types:
    get:
      operationId: listDatasetProviderType
      x-speakeasy-group: search.datasets.providers.types
      x-speakeasy-name-override: list
      tags:
        - datasets
      summary: Get a list of DatasetProviderType objects
      description: Get a list of DatasetProviderType objects
      responses:
        "200":
          description: a list of DatasetProviderType objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProviderType"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createDatasetProviderType
      x-speakeasy-group: search.datasets.providers.types
      x-speakeasy-name-override: create
      tags:
        - datasets
      summary: Create DatasetProviderType
      description: Create DatasetProviderType
      requestBody:
        description: New DatasetProviderType object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatasetProviderType"
      responses:
        "200":
          description: a list of DatasetProviderType objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProviderType"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/dataset-provider-types/{id}:
    get:
      operationId: getDatasetProviderTypeById
      x-speakeasy-group: search.datasets.providers.types
      x-speakeasy-name-override: get
      tags:
        - datasets
      summary: Get DatasetProviderType by ID
      description: Get DatasetProviderType by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of DatasetProviderType objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProviderType"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateDatasetProviderTypeById
      x-speakeasy-group: search.datasets.providers.types
      x-speakeasy-name-override: update
      tags:
        - datasets
      summary: Update DatasetProviderType
      description: Update DatasetProviderType
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: DatasetProviderType object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatasetProviderType"
      responses:
        "200":
          description: a list of DatasetProviderType objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProviderType"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteDatasetProviderTypeById
      x-speakeasy-group: search.datasets.providers.types
      x-speakeasy-name-override: delete
      tags:
        - datasets
      summary: Delete DatasetProviderType
      description: Delete DatasetProviderType
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of DatasetProviderType objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProviderType"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/dataset-providers:
    get:
      operationId: listDatasetProvider
      x-speakeasy-group: search.datasets.providers
      x-speakeasy-name-override: list
      tags:
        - datasets
      summary: Get a list of DatasetProvider objects
      description: Get a list of DatasetProvider objects
      responses:
        "200":
          description: a list of DatasetProvider objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProvider"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createDatasetProvider
      x-speakeasy-group: search.datasets.providers
      x-speakeasy-name-override: create
      tags:
        - datasets
      summary: Create DatasetProvider
      description: Create DatasetProvider
      requestBody:
        description: New DatasetProvider object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatasetProvider"
      responses:
        "200":
          description: a list of DatasetProvider objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProvider"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/dataset-providers/{id}:
    get:
      operationId: getDatasetProviderById
      x-speakeasy-group: search.datasets.providers
      x-speakeasy-name-override: get
      tags:
        - datasets
      summary: Get DatasetProvider by ID
      description: Get DatasetProvider by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of DatasetProvider objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProvider"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateDatasetProviderById
      x-speakeasy-group: search.datasets.providers
      x-speakeasy-name-override: update
      tags:
        - datasets
      summary: Update DatasetProvider
      description: Update DatasetProvider
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: DatasetProvider object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatasetProvider"
      responses:
        "200":
          description: a list of DatasetProvider objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProvider"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteDatasetProviderById
      x-speakeasy-group: search.datasets.providers
      x-speakeasy-name-override: delete
      tags:
        - datasets
      summary: Delete DatasetProvider
      description: Delete DatasetProvider
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of DatasetProvider objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatasetProvider"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/datasets:
    get:
      operationId: listDataset
      x-speakeasy-group: search.datasets
      x-speakeasy-name-override: list
      tags:
        - datasets
      summary: Get a list of Dataset objects
      description: Get a list of Dataset objects
      responses:
        "200":
          description: a list of Dataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Dataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createDataset
      x-speakeasy-group: search.datasets
      x-speakeasy-name-override: create
      tags:
        - datasets
      summary: Create Dataset
      description: Create Dataset
      requestBody:
        description: New Dataset object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Dataset"
      responses:
        "200":
          description: a list of Dataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Dataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/datasets/{id}:
    get:
      operationId: getDatasetById
      x-speakeasy-group: search.datasets
      x-speakeasy-name-override: get
      tags:
        - datasets
      summary: Get Dataset by ID
      description: Get Dataset by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Dataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Dataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateDatasetById
      x-speakeasy-group: search.datasets
      x-speakeasy-name-override: update
      tags:
        - datasets
      summary: Update Dataset
      description: Update Dataset
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Dataset object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Dataset"
      responses:
        "200":
          description: a list of Dataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Dataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteDatasetById
      x-speakeasy-group: search.datasets
      x-speakeasy-name-override: delete
      tags:
        - datasets
      summary: Delete Dataset
      description: Delete Dataset
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Dataset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Dataset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/datasets/{id}/acl:
    get:
      operationId: getDatasetAclById
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Get
      description: List accesses to Dataset granted to users
      summary: Get Dataset ACL
      tags:
        - datasets
  /search/datasets/{id}/acl/apply:
    post:
      operationId: createDatasetAclApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Create
      description: Add/remove accesses to Dataset for users
      summary: Modify Dataset ACL
      tags:
        - datasets
  /search/datasets/{id}/acl/teams:
    get:
      operationId: getDatasetAclTeamsById
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Get
      description: List accesses to Dataset granted to Teams
      summary: Get Dataset Teams
      tags:
        - datasets
  /search/datasets/{id}/acl/teams/apply:
    post:
      operationId: createDatasetAclTeamsApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Create
      description: Add/remove accesses to Dataset for Teams
      summary: Modify Dataset Teams ACL
      tags:
        - datasets
  /lib/appscope-configs:
    get:
      operationId: listAppscopeLibEntry
      x-speakeasy-name-override: list
      tags:
        - appscope-configs
      summary: Get a list of AppscopeLibEntry objects
      description: Get a list of AppscopeLibEntry objects
      responses:
        "200":
          description: a list of AppscopeLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppscopeLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createAppscopeLibEntry
      x-speakeasy-name-override: create
      tags:
        - appscope-configs
      summary: Create AppscopeLibEntry
      description: Create AppscopeLibEntry
      requestBody:
        description: New AppscopeLibEntry object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AppscopeLibEntry"
      responses:
        "200":
          description: a list of AppscopeLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppscopeLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/appscope-configs/{id}:
    get:
      operationId: getAppscopeLibEntryById
      x-speakeasy-name-override: get
      tags:
        - appscope-configs
      summary: Get AppscopeLibEntry by ID
      description: Get AppscopeLibEntry by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of AppscopeLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppscopeLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateAppscopeLibEntryById
      x-speakeasy-name-override: update
      tags:
        - appscope-configs
      summary: Update AppscopeLibEntry
      description: Update AppscopeLibEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: AppscopeLibEntry object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AppscopeLibEntry"
      responses:
        "200":
          description: a list of AppscopeLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppscopeLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteAppscopeLibEntryById
      x-speakeasy-name-override: delete
      tags:
        - appscope-configs
      summary: Delete AppscopeLibEntry
      description: Delete AppscopeLibEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of AppscopeLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppscopeLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/grok:
    get:
      operationId: listGrokFile
      x-speakeasy-name-override: list
      tags:
        - grokfiles
      summary: Get a list of GrokFile objects
      description: Get a list of GrokFile objects
      responses:
        "200":
          description: a list of GrokFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GrokFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createGrokFile
      x-speakeasy-name-override: create
      tags:
        - grokfiles
      summary: Create GrokFile
      description: Create GrokFile
      requestBody:
        description: New GrokFile object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GrokFile"
      responses:
        "200":
          description: a list of GrokFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GrokFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/grok/{id}:
    get:
      operationId: getGrokFileById
      x-speakeasy-name-override: get
      tags:
        - grokfiles
      summary: Get GrokFile by ID
      description: Get GrokFile by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of GrokFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GrokFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateGrokFileById
      x-speakeasy-name-override: update
      tags:
        - grokfiles
      summary: Update GrokFile
      description: Update GrokFile
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: GrokFile object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GrokFile"
      responses:
        "200":
          description: a list of GrokFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GrokFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteGrokFileById
      x-speakeasy-name-override: delete
      tags:
        - grokfiles
      summary: Delete GrokFile
      description: Delete GrokFile
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of GrokFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GrokFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/jobs:
    get:
      operationId: listSavedJob
      x-speakeasy-name-override: list
      tags:
        - saved-jobs
      summary: Get a list of SavedJob objects
      description: Get a list of SavedJob objects
      responses:
        "200":
          description: a list of SavedJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSavedJob
      x-speakeasy-name-override: create
      tags:
        - saved-jobs
      summary: Create SavedJob
      description: Create SavedJob
      requestBody:
        description: New SavedJob object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SavedJob"
      responses:
        "200":
          description: a list of SavedJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/jobs/{id}:
    get:
      operationId: getSavedJobById
      x-speakeasy-name-override: get
      tags:
        - saved-jobs
      summary: Get SavedJob by ID
      description: Get SavedJob by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of SavedJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSavedJobById
      x-speakeasy-name-override: update
      tags:
        - saved-jobs
      summary: Update SavedJob
      description: Update SavedJob
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: SavedJob object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SavedJob"
      responses:
        "200":
          description: a list of SavedJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSavedJobById
      x-speakeasy-name-override: delete
      tags:
        - saved-jobs
      summary: Delete SavedJob
      description: Delete SavedJob
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of SavedJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/lookups:
    get:
      operationId: listLookupFile
      x-speakeasy-name-override: list
      tags:
        - lookups
      summary: Get a list of LookupFile objects
      description: Get a list of LookupFile objects
      responses:
        "200":
          description: a list of LookupFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LookupFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createLookupFile
      x-speakeasy-name-override: create
      tags:
        - lookups
      summary: Create LookupFile
      description: Create LookupFile
      requestBody:
        description: New LookupFile object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LookupFile"
      responses:
        "200":
          description: a list of LookupFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LookupFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    put:
      operationId: updateLookupFile
      tags:
        - lookups
      summary: Upload LookupFile
      description: Upload LookupFile
      deprecated: false
      responses:
        "200":
          description: LookupFileInfoResponse object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LookupFileInfoResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: LookupFileInfo object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LookupFileInfo"
            examples:
              LookupFileInfoExamplesCancelUpload:
                $ref: "#/components/examples/LookupFileInfoExamplesCancelUpload"
          text/csv:
            schema:
              type: string
              format: binary
              description: CSV lookup file
      parameters:
        - name: filename
          in: query
          required: true
          schema:
            type: string
          description: Name of the lookup file to upload
        - name: cancel
          in: query
          required: false
          schema:
            type: boolean
          description: Cancel the file upload operation
  /system/lookups/{id}:
    get:
      operationId: getLookupFileById
      x-speakeasy-name-override: get
      tags:
        - lookups
      summary: Get LookupFile by ID
      description: Get LookupFile by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of LookupFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LookupFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateLookupFileById
      x-speakeasy-name-override: update
      tags:
        - lookups
      summary: Update LookupFile
      description: Update LookupFile
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: LookupFile object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LookupFile"
      responses:
        "200":
          description: a list of LookupFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LookupFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteLookupFileById
      x-speakeasy-name-override: delete
      tags:
        - lookups
      summary: Delete LookupFile
      description: Delete LookupFile
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of LookupFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LookupFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/lookups/{id}/clone:
    put:
      operationId: updateLookupFileCloneById
      tags:
        - lookups
      summary: Clone a lookup from one context to another
      description: Clone a lookup from one context to another
      deprecated: false
      responses:
        "200":
          description: a list of LookupFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LookupFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: LookupCloneBody object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LookupCloneBody"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: id
  /lib/parsers:
    get:
      operationId: listParser
      x-speakeasy-name-override: list
      tags:
        - parsers
      summary: Get a list of Parser objects
      description: Get a list of Parser objects
      responses:
        "200":
          description: a list of Parser objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ParserLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createParser
      x-speakeasy-name-override: create
      tags:
        - parsers
      summary: Create Parser
      description: Create Parser
      requestBody:
        description: New Parser object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ParserLibEntry"
      responses:
        "200":
          description: a list of Parser objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ParserLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/parsers/{id}:
    get:
      operationId: getParserById
      x-speakeasy-name-override: get
      tags:
        - parsers
      summary: Get Parser by ID
      description: Get Parser by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Parser objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ParserLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateParserById
      x-speakeasy-name-override: update
      tags:
        - parsers
      summary: Update Parser
      description: Update Parser
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Parser object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ParserLibEntry"
      responses:
        "200":
          description: a list of Parser objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ParserLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteParserById
      x-speakeasy-name-override: delete
      tags:
        - parsers
      summary: Delete Parser
      description: Delete Parser
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Parser objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ParserLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/protobuf-libraries:
    get:
      operationId: listProtobufLibraryConfig
      x-speakeasy-name-override: list
      tags:
        - protobuflibraries
      summary: Show list of Protobuf encodings for a given Library
      description: Show list of Protobuf encodings for a given Library
      responses:
        "200":
          description: a list of ProtobufEncodingConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProtobufEncodingConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: onlyWithEncodings
          in: query
          required: true
          schema:
            type: string
          description: onlyWithEncodings
  /lib/protobuf-libraries/{id}:
    get:
      operationId: getProtobufLibraryConfigById
      x-speakeasy-name-override: get
      tags:
        - protobuflibraries
      summary: Show Library by Id
      description: Show Library by Id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Library Id
      responses:
        "200":
          description: a list of ProtobufLibraryConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProtobufLibraryConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /lib/protobuf-libraries/{id}/encodings/{encid}:
    get:
      operationId: getProtobufLibraryConfigEncodingsByIdAndEncId
      tags:
        - protobuflibraries
      summary: Show Protobuf library encodings by encoding id
      description: Show Protobuf library encodings by encoding id
      deprecated: false
      responses:
        "200":
          description: a list of ProtobufEncodingConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProtobufEncodingConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Library id
        - name: encid
          in: path
          required: true
          schema:
            type: string
          description: Encoding id
  /lib/protobuf-libraries/{id}/encodings:
    get:
      operationId: getProtobufLibraryConfigEncodingsById
      tags:
        - protobuflibraries
      summary: Show list of Protobuf encodings for a given Library
      description: Show list of Protobuf encodings for a given Library
      deprecated: false
      responses:
        "200":
          description: a list of ProtobufEncodingConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProtobufEncodingConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Library id
  /lib/regex:
    get:
      operationId: listRegexLibEntry
      x-speakeasy-name-override: list
      tags:
        - regexes
      summary: Get a list of RegexLibEntry objects
      description: Get a list of RegexLibEntry objects
      responses:
        "200":
          description: a list of RegexLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RegexLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createRegexLibEntry
      x-speakeasy-name-override: create
      tags:
        - regexes
      summary: Create RegexLibEntry
      description: Create RegexLibEntry
      requestBody:
        description: New RegexLibEntry object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RegexLibEntry"
      responses:
        "200":
          description: a list of RegexLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RegexLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/regex/{id}:
    get:
      operationId: getRegexLibEntryById
      x-speakeasy-name-override: get
      tags:
        - regexes
      summary: Get RegexLibEntry by ID
      description: Get RegexLibEntry by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of RegexLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RegexLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateRegexLibEntryById
      x-speakeasy-name-override: update
      tags:
        - regexes
      summary: Update RegexLibEntry
      description: Update RegexLibEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: RegexLibEntry object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RegexLibEntry"
      responses:
        "200":
          description: a list of RegexLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RegexLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteRegexLibEntryById
      x-speakeasy-name-override: delete
      tags:
        - regexes
      summary: Delete RegexLibEntry
      description: Delete RegexLibEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of RegexLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RegexLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/sds-rules:
    get:
      operationId: listSensitiveDataRule
      x-speakeasy-name-override: list
      tags:
        - sds-rules
      summary: Get a list of SensitiveDataRule objects
      description: Get a list of SensitiveDataRule objects
      responses:
        "200":
          description: a list of SensitiveDataRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSensitiveDataRule
      x-speakeasy-name-override: create
      tags:
        - sds-rules
      summary: Create SensitiveDataRule
      description: Create SensitiveDataRule
      requestBody:
        description: New SensitiveDataRule object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SensitiveDataRule"
      responses:
        "200":
          description: a list of SensitiveDataRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/sds-rules/{id}:
    get:
      operationId: getSensitiveDataRuleById
      x-speakeasy-name-override: get
      tags:
        - sds-rules
      summary: Get SensitiveDataRule by ID
      description: Get SensitiveDataRule by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of SensitiveDataRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSensitiveDataRuleById
      x-speakeasy-name-override: update
      tags:
        - sds-rules
      summary: Update SensitiveDataRule
      description: Update SensitiveDataRule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: SensitiveDataRule object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SensitiveDataRule"
      responses:
        "200":
          description: a list of SensitiveDataRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSensitiveDataRuleById
      x-speakeasy-name-override: delete
      tags:
        - sds-rules
      summary: Delete SensitiveDataRule
      description: Delete SensitiveDataRule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of SensitiveDataRule objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRule"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/sds-rulesets:
    get:
      operationId: listSensitiveDataRuleset
      x-speakeasy-name-override: list
      tags:
        - sds-rulesets
      summary: Get a list of SensitiveDataRuleset objects
      description: Get a list of SensitiveDataRuleset objects
      responses:
        "200":
          description: a list of SensitiveDataRuleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/sds-rulesets/{id}:
    get:
      operationId: getSensitiveDataRulesetById
      x-speakeasy-name-override: get
      tags:
        - sds-rulesets
      summary: Get SensitiveDataRuleset by ID
      description: Get SensitiveDataRuleset by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of SensitiveDataRuleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSensitiveDataRulesetById
      x-speakeasy-name-override: delete
      tags:
        - sds-rulesets
      summary: Delete SensitiveDataRuleset
      description: Delete SensitiveDataRuleset
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of SensitiveDataRuleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SensitiveDataRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/samples:
    get:
      operationId: listDataSample
      x-speakeasy-name-override: list
      tags:
        - samples
      summary: Get a list of DataSample objects
      description: Get a list of DataSample objects
      responses:
        "200":
          description: a list of DataSample objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataSample"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createDataSample
      x-speakeasy-name-override: create
      tags:
        - samples
      summary: Create DataSample
      description: Create DataSample
      requestBody:
        description: New DataSample object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DataSample"
      responses:
        "200":
          description: a list of DataSample objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataSample"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/samples/{id}:
    get:
      operationId: getDataSampleById
      x-speakeasy-name-override: get
      tags:
        - samples
      summary: Get DataSample by ID
      description: Get DataSample by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of DataSample objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataSample"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateDataSampleById
      x-speakeasy-name-override: update
      tags:
        - samples
      summary: Update DataSample
      description: Update DataSample
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: DataSample object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DataSample"
      responses:
        "200":
          description: a list of DataSample objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataSample"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteDataSampleById
      x-speakeasy-name-override: delete
      tags:
        - samples
      summary: Delete DataSample
      description: Delete DataSample
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of DataSample objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DataSample"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/samples/{id}/content:
    get:
      operationId: getDataSampleContentById
      tags:
        - samples
      summary: Get sample content by ID
      description: Get sample content by ID
      deprecated: false
      responses:
        "200":
          description: a list of SampleContent objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SampleContent"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Sample ID
        - name: alwaysReset
          in: query
          required: false
          schema:
            type: string
          description: boolean on whether Sampler should always reset _time attribute
  /search/dashboards:
    get:
      operationId: listSearchDashboard
      x-speakeasy-name-override: list
      tags:
        - dashboards
      summary: Get a list of SearchDashboard objects
      description: Get a list of SearchDashboard objects
      responses:
        "200":
          description: a list of SearchDashboard objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchDashboard"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSearchDashboard
      x-speakeasy-name-override: create
      tags:
        - dashboards
      summary: Create SearchDashboard
      description: Create SearchDashboard
      requestBody:
        description: New SearchDashboard object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchDashboard"
      responses:
        "200":
          description: a list of SearchDashboard objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchDashboard"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/dashboards/{id}:
    get:
      operationId: getSearchDashboardById
      x-speakeasy-name-override: get
      tags:
        - dashboards
      summary: Get SearchDashboard by ID
      description: Get SearchDashboard by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of SearchDashboard objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchDashboard"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSearchDashboardById
      x-speakeasy-name-override: update
      tags:
        - dashboards
      summary: Update SearchDashboard
      description: Update SearchDashboard
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: SearchDashboard object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchDashboard"
      responses:
        "200":
          description: a list of SearchDashboard objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchDashboard"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSearchDashboardById
      x-speakeasy-name-override: delete
      tags:
        - dashboards
      summary: Delete SearchDashboard
      description: Delete SearchDashboard
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of SearchDashboard objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchDashboard"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/dashboards/{id}/acl:
    get:
      operationId: getSearchDashboardAclById
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Get
      description: List accesses to SearchDashboard granted to users
      summary: Get SearchDashboard ACL
      tags:
        - dashboards
  /search/dashboards/{id}/acl/apply:
    post:
      operationId: createSearchDashboardAclApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Create
      description: Add/remove accesses to SearchDashboard for users
      summary: Modify SearchDashboard ACL
      tags:
        - dashboards
  /search/dashboards/{id}/acl/teams:
    get:
      operationId: getSearchDashboardAclTeamsById
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Get
      description: List accesses to SearchDashboard granted to Teams
      summary: Get SearchDashboard Teams
      tags:
        - dashboards
  /search/dashboards/{id}/acl/teams/apply:
    post:
      operationId: createSearchDashboardAclTeamsApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Create
      description: Add/remove accesses to SearchDashboard for Teams
      summary: Modify SearchDashboard Teams ACL
      tags:
        - dashboards
  /search/macros:
    get:
      operationId: listSearchMacro
      x-speakeasy-name-override: list
      tags:
        - macros
      summary: Get a list of SearchMacro objects
      description: Get a list of SearchMacro objects
      responses:
        "200":
          description: a list of SearchMacro objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchMacro"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSearchMacro
      x-speakeasy-name-override: create
      tags:
        - macros
      summary: Create SearchMacro
      description: Create SearchMacro
      requestBody:
        description: New SearchMacro object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchMacro"
      responses:
        "200":
          description: a list of SearchMacro objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchMacro"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/macros/{id}:
    get:
      operationId: getSearchMacroById
      x-speakeasy-name-override: get
      tags:
        - macros
      summary: Get SearchMacro by ID
      description: Get SearchMacro by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of SearchMacro objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchMacro"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSearchMacroById
      x-speakeasy-name-override: update
      tags:
        - macros
      summary: Update SearchMacro
      description: Update SearchMacro
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: SearchMacro object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchMacro"
      responses:
        "200":
          description: a list of SearchMacro objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchMacro"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSearchMacroById
      x-speakeasy-name-override: delete
      tags:
        - macros
      summary: Delete SearchMacro
      description: Delete SearchMacro
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of SearchMacro objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchMacro"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/saved:
    get:
      operationId: listSavedQuery
      x-speakeasy-name-override: list
      tags:
        - savedQueries
      summary: Get a list of SavedQuery objects
      description: Get a list of SavedQuery objects
      responses:
        "200":
          description: a list of SavedQuery objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedQuery"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSavedQuery
      x-speakeasy-name-override: create
      tags:
        - savedQueries
      summary: Create SavedQuery
      description: Create SavedQuery
      requestBody:
        description: New SavedQuery object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SavedQuery"
      responses:
        "200":
          description: a list of SavedQuery objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedQuery"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/saved/{id}:
    get:
      operationId: getSavedQueryById
      x-speakeasy-name-override: get
      tags:
        - savedQueries
      summary: Get SavedQuery by ID
      description: Get SavedQuery by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of SavedQuery objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedQuery"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSavedQueryById
      x-speakeasy-name-override: update
      tags:
        - savedQueries
      summary: Update SavedQuery
      description: Update SavedQuery
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: SavedQuery object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SavedQuery"
      responses:
        "200":
          description: a list of SavedQuery objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedQuery"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSavedQueryById
      x-speakeasy-name-override: delete
      tags:
        - savedQueries
      summary: Delete SavedQuery
      description: Delete SavedQuery
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of SavedQuery objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SavedQuery"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/jobs:
    get:
      operationId: listSearchJob
      x-speakeasy-name-override: list
      tags:
        - search
      summary: Get a list of SearchJob objects
      description: Get a list of SearchJob objects
      responses:
        "200":
          description: a list of SearchJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSearchJob
      x-speakeasy-name-override: create
      tags:
        - search
      summary: Create a Search Job
      description: Create a new search job to execute a Cribl search query.
      requestBody:
        description: CreateSearchJobSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateSearchJobSchema"
      responses:
        "200":
          description: A list containing the created search job object
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /search/jobs/{id}:
    get:
      operationId: getSearchJobById
      x-speakeasy-name-override: get
      tags:
        - search
      summary: Get SearchJob by ID
      description: Get SearchJob by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of SearchJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSearchJobById
      x-speakeasy-name-override: update
      tags:
        - search
      summary: Update a Search Job
      description: Update the specified search job. Only status and isPrivate fields
        can be updated.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
      requestBody:
        description: UpdateSearchJobSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateSearchJobSchema"
      responses:
        "200":
          description: A list containing the updated search job object
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deleteSearchJobById
      x-speakeasy-name-override: delete
      tags:
        - search
      summary: Delete SearchJob
      description: Delete SearchJob
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of SearchJob objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchJob"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/jobs/{id}/dispatch-executors:
    post:
      operationId: createSearchJobDispatchExecutorsById
      tags:
        - search
      summary: internal endpoint, dispatch search *id* to worker nodes filtered by
        worker node filter using RPC
      description: internal endpoint, dispatch search *id* to worker nodes filtered by
        worker node filter using RPC
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /search/jobs/{id}/settings:
    get:
      operationId: getSearchJobSettingsById
      tags:
        - search
      summary: Get search job settings
      description: Get search job settings
      deprecated: false
      responses:
        "200":
          description: SearchJobSettings object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchJobSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
    post:
      operationId: createSearchJobSettingsById
      tags:
        - search
      summary: Save search job settings
      description: Save search job settings
      deprecated: false
      responses:
        "200":
          description: SearchJobSettings object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchJobSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /search/jobs/{id}/status:
    get:
      operationId: getSearchJobStatusById
      tags:
        - search
      summary: Get job status
      description: Get job status
      deprecated: false
      responses:
        "200":
          description: StatusResponse object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StatusResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /search/jobs/{id}/timeline:
    get:
      operationId: getSearchJobTimelineById
      tags:
        - search
      summary: Get search timeline
      description: Get search timeline
      deprecated: false
      responses:
        "200":
          description: SearchTimeline object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchTimeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /search/jobs/{id}/field-summaries:
    get:
      operationId: getSearchJobFieldSummariesById
      tags:
        - search
      summary: List field summaries
      description: List field summaries
      deprecated: false
      responses:
        "200":
          description: FieldSummaries object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FieldSummaries"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /search/jobs/{id}/logs:
    get:
      operationId: getSearchJobLogsById
      tags:
        - search
      summary: Get search logs
      description: Get search logs
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /lib/database-connections:
    get:
      operationId: listDatabaseConnectionConfig
      x-speakeasy-name-override: list
      tags:
        - database-connections
      summary: Get a list of DatabaseConnection objects
      description: Get a list of DatabaseConnection objects
      responses:
        "200":
          description: a list of DatabaseConnectionConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatabaseConnectionConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: databaseType
          in: query
          required: false
          schema:
            type: string
          description: type of database connection
    post:
      operationId: createDatabaseConnectionConfig
      x-speakeasy-name-override: create
      tags:
        - database-connections
      summary: Create DatabaseConnectionConfig
      description: Create DatabaseConnectionConfig
      requestBody:
        description: New DatabaseConnectionConfig object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatabaseConnectionConfig"
      responses:
        "200":
          description: a list of DatabaseConnectionConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatabaseConnectionConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/database-connections/{id}:
    get:
      operationId: getDatabaseConnectionConfigById
      x-speakeasy-name-override: get
      tags:
        - database-connections
      summary: Get DatabaseConnectionConfig by ID
      description: Get DatabaseConnectionConfig by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of DatabaseConnectionConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatabaseConnectionConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateDatabaseConnectionConfigById
      x-speakeasy-name-override: update
      tags:
        - database-connections
      summary: Update DatabaseConnectionConfig
      description: Update DatabaseConnectionConfig
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: DatabaseConnectionConfig object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatabaseConnectionConfig"
      responses:
        "200":
          description: a list of DatabaseConnectionConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatabaseConnectionConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteDatabaseConnectionConfigById
      x-speakeasy-name-override: delete
      tags:
        - database-connections
      summary: Delete DatabaseConnectionConfig
      description: Delete DatabaseConnectionConfig
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of DatabaseConnectionConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatabaseConnectionConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/database-connections/test:
    post:
      operationId: createLibDatabaseConnectionsTest
      tags:
        - database-connections
      summary: Test a database connection given a type and connectionString
      description: Test a database connection given a type and connectionString
      deprecated: false
      responses:
        "200":
          description: a list of DatabaseConnectionTestResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DatabaseConnectionTestResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: DatabaseConnectionTest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatabaseConnectionTest"
  /lib/breakers:
    get:
      operationId: listEventBreakerRuleset
      x-speakeasy-name-override: list
      tags:
        - event_breaker_rules
      summary: Get a list of Event Breaker Ruleset objects
      description: Get a list of Event Breaker Ruleset objects
      responses:
        "200":
          description: a list of Event Breaker Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EventBreakerRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createEventBreakerRuleset
      x-speakeasy-name-override: create
      tags:
        - event_breaker_rules
      summary: Create Event Breaker Ruleset
      description: Create Event Breaker Ruleset
      requestBody:
        description: New Event Breaker Ruleset object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EventBreakerRuleset"
      responses:
        "200":
          description: a list of Event Breaker Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EventBreakerRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/breakers/{id}:
    get:
      operationId: getEventBreakerRulesetById
      x-speakeasy-name-override: get
      tags:
        - event_breaker_rules
      summary: Get Event Breaker Ruleset by ID
      description: Get Event Breaker Ruleset by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Event Breaker Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EventBreakerRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateEventBreakerRulesetById
      x-speakeasy-name-override: update
      tags:
        - event_breaker_rules
      summary: Update Event Breaker Ruleset
      description: Update Event Breaker Ruleset
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Event Breaker Ruleset object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EventBreakerRuleset"
      responses:
        "200":
          description: a list of Event Breaker Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EventBreakerRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteEventBreakerRulesetById
      x-speakeasy-name-override: delete
      tags:
        - event_breaker_rules
      summary: Delete Event Breaker Ruleset
      description: Delete Event Breaker Ruleset
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Event Breaker Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EventBreakerRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/vars:
    get:
      operationId: listGlobalVariable
      x-speakeasy-name-override: list
      tags:
        - globalVariables
      summary: List all GlobalVars with references
      description: List all GlobalVars with references
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: with
          in: query
          required: false
          schema:
            type: string
          description: Pass "refs" to include references to fields the variable is used in
    post:
      operationId: createGlobalVariable
      x-speakeasy-name-override: create
      tags:
        - globalVariables
      summary: Create Global Variable
      description: Create Global Variable
      requestBody:
        description: New Global Variable object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GlobalVar"
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/vars/{id}:
    get:
      operationId: getGlobalVariableById
      x-speakeasy-name-override: get
      tags:
        - globalVariables
      summary: Get Global Variable by ID
      description: Get Global Variable by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateGlobalVariableById
      x-speakeasy-name-override: update
      tags:
        - globalVariables
      summary: Update Global Variable
      description: Update Global Variable
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Global Variable object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GlobalVar"
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteGlobalVariableById
      x-speakeasy-name-override: delete
      tags:
        - globalVariables
      summary: Delete Global Variable
      description: Delete Global Variable
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /p/{pack}/lib/vars:
    get:
      operationId: getGlobalVariableLibVarsByPack
      x-speakeasy-name-override: list
      tags:
        - globalVariables
      summary: List all GlobalVars with references within a Pack
      description: List all GlobalVars with references within the specified Pack.
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: with
          in: query
          required: false
          schema:
            type: string
          description: Pass "refs" to include references to fields the variable is used in
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
      x-speakeasy-group: packs.globalVariables
    post:
      operationId: createGlobalVariableLibVarsByPack
      x-speakeasy-name-override: create
      tags:
        - globalVariables
      summary: Create Global Variable within a Pack
      description: Create Global Variable within the specified Pack.
      requestBody:
        description: New Global Variable object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GlobalVar"
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.globalVariables
      parameters:
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to POST
  /p/{pack}/lib/vars/{id}:
    get:
      operationId: getGlobalVariableLibVarsByPackAndId
      x-speakeasy-name-override: get
      tags:
        - globalVariables
      summary: Get Global Variable by ID within a Pack
      description: Get Global Variable by ID within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.globalVariables
    patch:
      operationId: updateGlobalVariableLibVarsByPackAndId
      x-speakeasy-name-override: update
      tags:
        - globalVariables
      summary: Update Global Variable within a Pack
      description: Update Global Variable within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to PATCH
      requestBody:
        description: Global Variable object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GlobalVar"
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.globalVariables
    delete:
      operationId: deleteGlobalVariableLibVarsByPackAndId
      x-speakeasy-name-override: delete
      tags:
        - globalVariables
      summary: Delete Global Variable within a Pack
      description: Delete Global Variable within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to DELETE
      responses:
        "200":
          description: a list of Global Variable objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GlobalVar"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.globalVariables
  /lib/hmac-functions:
    get:
      operationId: listHmacFunction
      x-speakeasy-name-override: list
      tags:
        - hmac-functions
      summary: Get a list of HmacFunction objects
      description: Get a list of HmacFunction objects
      responses:
        "200":
          description: a list of HmacFunction objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/HmacFunction"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createHmacFunction
      x-speakeasy-name-override: create
      tags:
        - hmac-functions
      summary: Create HmacFunction
      description: Create HmacFunction
      requestBody:
        description: New HmacFunction object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HmacFunction"
      responses:
        "200":
          description: a list of HmacFunction objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/HmacFunction"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/hmac-functions/{id}:
    get:
      operationId: getHmacFunctionById
      x-speakeasy-name-override: get
      tags:
        - hmac-functions
      summary: Get HmacFunction by ID
      description: Get HmacFunction by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of HmacFunction objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/HmacFunction"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateHmacFunctionById
      x-speakeasy-name-override: update
      tags:
        - hmac-functions
      summary: Update HmacFunction
      description: Update HmacFunction
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: HmacFunction object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HmacFunction"
      responses:
        "200":
          description: a list of HmacFunction objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/HmacFunction"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteHmacFunctionById
      x-speakeasy-name-override: delete
      tags:
        - hmac-functions
      summary: Delete HmacFunction
      description: Delete HmacFunction
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of HmacFunction objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/HmacFunction"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/inputs:
    get:
      operationId: listInput
      x-speakeasy-group: sources
      x-speakeasy-name-override: list
      tags:
        - sources
      summary: List all Sources
      description: Get a list of all Sources.
      responses:
        "200":
          description: a list of Source objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Input"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    post:
      operationId: createInput
      x-speakeasy-group: sources
      x-speakeasy-name-override: create
      tags:
        - sources
      summary: Create a Source
      description: Create a new Source.
      requestBody:
        description: Input object
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: "#/components/schemas/Input"
                - type: object
                  required:
                    - id
              $ref: "#/components/schemas/Input"
      responses:
        "200":
          description: a list of Source objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Input"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/inputs/{id}:
    get:
      operationId: getInputById
      x-speakeasy-group: sources
      x-speakeasy-name-override: get
      tags:
        - sources
      summary: Get a Source
      description: Get the specified Source.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Source to get.
      responses:
        "200":
          description: a list of Source objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Input"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    patch:
      operationId: updateInputById
      x-speakeasy-group: sources
      x-speakeasy-name-override: update
      tags:
        - sources
      summary: Update a Source
      description: Update the specified Source.</br></br>Provide a complete
        representation of the Source that you want to update in the request
        body. This endpoint does not support partial updates. Cribl removes any
        omitted fields when updating the Source.</br></br>Confirm that the
        configuration in your request body is correct before sending the
        request. If the configuration is incorrect, the updated Source might not
        function as expected.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Source to update.
      requestBody:
        description: Input object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Input"
      responses:
        "200":
          description: a list of Source objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Input"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deleteInputById
      x-speakeasy-group: sources
      x-speakeasy-name-override: delete
      tags:
        - sources
      summary: Delete a Source
      description: Delete the specified Source.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Source to delete.
      responses:
        "200":
          description: a list of Source objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Input"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/inputs/{id}/hectoken:
    post:
      operationId: createInputHecTokenById
      tags:
        - sources
      x-speakeasy-group: sources.hecTokens
      x-speakeasy-name-override: create
      summary: Add an HEC token and optional metadata to a Splunk HEC Source
      description: Add an HEC token and optional metadata to the specified Splunk HEC
        Source.
      deprecated: false
      responses:
        "200":
          description: a list of InputSplunkHec objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/InputSplunkHec"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: AddHecTokenRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddHecTokenRequest"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Splunk HEC Source.
  /system/inputs/{id}/pq:
    delete:
      operationId: deleteInputPqById
      tags:
        - sources
      x-speakeasy-group: sources.pq
      x-speakeasy-name-override: clear
      summary: Clear the persistent queue for a Source
      description: Clear the persistent queue (PQ) for the specified Source.
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Source to clear the PQ for.
    get:
      operationId: getInputPqById
      tags:
        - sources
      x-speakeasy-group: sources.pq
      x-speakeasy-name-override: get
      summary: Get information about the latest job to clear the persistent queue for
        a Source
      description: Get information about the latest job to clear the persistent queue
        (PQ) for the specified Source.
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Source to get PQ job information for.
  /system/inputs/{id}/hectoken/{token}:
    patch:
      operationId: updateInputHecTokenByIdAndToken
      tags:
        - sources
      x-speakeasy-group: sources.hecTokens
      x-speakeasy-name-override: update
      summary: Update metadata for an HEC token for a Splunk HEC Source
      description: Update the metadata for the specified HEC token for the specified
        Splunk HEC Source.
      deprecated: false
      responses:
        "200":
          description: a list of InputSplunkHec objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/InputSplunkHec"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: UpdateHecTokenRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateHecTokenRequest"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Splunk HEC Source.
        - name: token
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the HEC token to update.
  /system/iometrics:
    get:
      operationId: listIoMetricsEntry
      x-speakeasy-name-override: list
      tags:
        - iometrics
      summary: Get a list of IoMetricsEntry objects
      description: Get a list of IoMetricsEntry objects
      responses:
        "200":
          description: a list of IoMetricsEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/IoMetricsEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/iometrics/{id}:
    get:
      operationId: getIoMetricsEntryById
      x-speakeasy-name-override: get
      tags:
        - iometrics
      summary: Get IoMetricsEntry by ID
      description: Get IoMetricsEntry by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of IoMetricsEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/IoMetricsEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateIoMetricsEntryById
      x-speakeasy-name-override: update
      tags:
        - iometrics
      summary: Update IoMetricsEntry
      description: Update IoMetricsEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: IoMetricsEntry object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/IoMetricsEntry"
      responses:
        "200":
          description: a list of IoMetricsEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/IoMetricsEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteIoMetricsEntryById
      x-speakeasy-name-override: delete
      tags:
        - iometrics
      summary: Delete IoMetricsEntry
      description: Delete IoMetricsEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of IoMetricsEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/IoMetricsEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/outputs:
    get:
      operationId: listOutput
      x-speakeasy-group: destinations
      x-speakeasy-name-override: list
      tags:
        - destinations
      summary: List all Destinations
      description: Get a list of all Destinations.
      responses:
        "200":
          description: a list of Destination objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Output"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    post:
      operationId: createOutput
      x-speakeasy-group: destinations
      x-speakeasy-name-override: create
      tags:
        - destinations
      summary: Create a Destination
      description: Create a new Destination.
      requestBody:
        description: Output object
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: "#/components/schemas/Output"
                - type: object
                  required:
                    - id
              $ref: "#/components/schemas/Output"
      responses:
        "200":
          description: a list of Destination objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Output"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/outputs/{id}:
    get:
      operationId: getOutputById
      x-speakeasy-group: destinations
      x-speakeasy-name-override: get
      tags:
        - destinations
      summary: Get a Destination
      description: Get the specified Destination.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Destination to get.
      responses:
        "200":
          description: a list of Destination objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Output"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    patch:
      operationId: updateOutputById
      x-speakeasy-group: destinations
      x-speakeasy-name-override: update
      tags:
        - destinations
      summary: Update a Destination
      description: Update the specified Destination.</br></br>Provide a complete
        representation of the Destination that you want to update in the request
        body. This endpoint does not support partial updates. Cribl removes any
        omitted fields when updating the Destination.</br></br>Confirm that the
        configuration in your request body is correct before sending the
        request. If the configuration is incorrect, the updated Destination
        might not function as expected.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Destination to update.
      requestBody:
        description: Output object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Output"
      responses:
        "200":
          description: a list of Destination objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Output"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deleteOutputById
      x-speakeasy-group: destinations
      x-speakeasy-name-override: delete
      tags:
        - destinations
      summary: Delete a Destination
      description: Delete the specified Destination.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Destination to delete.
      responses:
        "200":
          description: a list of Destination objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Output"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/outputs/{id}/pq:
    delete:
      operationId: deleteOutputPqById
      tags:
        - destinations
      x-speakeasy-group: destinations.pq
      x-speakeasy-name-override: clear
      summary: Clear the persistent queue for a Destination
      description: Clear the persistent queue (PQ) for the specified Destination.
      deprecated: false
      responses:
        "201":
          description: A list of job ids for the background job that clears the persistent
            queue
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Destination to clear the PQ for.
    get:
      operationId: getOutputPqById
      tags:
        - destinations
      x-speakeasy-group: destinations.pq
      x-speakeasy-name-override: get
      summary: Get information about the latest job to clear the persistent queue for
        a Destination
      description: Get information about the latest job to clear the persistent queue
        (PQ) for the specified Destination.
      deprecated: false
      responses:
        "200":
          description: a list of JobInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/JobInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Destination to get PQ job information for.
  /system/outputs/{id}/samples:
    get:
      operationId: getOutputSamplesById
      tags:
        - destinations
      x-speakeasy-group: destinations.samples
      x-speakeasy-name-override: get
      summary: Get sample event data for a Destination
      description: Get sample event data for the specified Destination to validate the
        configuration or test connectivity.
      deprecated: false
      responses:
        "200":
          description: a list of OutputSamplesResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/OutputSamplesResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Destination to get sample event data for.
  /system/outputs/{id}/test:
    post:
      operationId: createOutputTestById
      tags:
        - destinations
      x-speakeasy-group: destinations.samples
      x-speakeasy-name-override: create
      summary: Send sample event data to a Destination
      description: Send sample event data to the specified Destination to validate the
        configuration or test connectivity.
      deprecated: false
      responses:
        "200":
          description: a list of OutputTestResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/OutputTestResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: OutputTestRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OutputTestRequest"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Destination to send sample event data to.
  /lib/parquet-schemas:
    get:
      operationId: listSchema
      x-speakeasy-name-override: list
      tags:
        - parquetschemas
      summary: Get a list of Schema objects
      description: Get a list of Schema objects
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSchema
      x-speakeasy-name-override: create
      tags:
        - parquetschemas
      summary: Create Schema
      description: Create Schema
      requestBody:
        description: New Schema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SchemaLibEntry"
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/parquet-schemas/{id}:
    get:
      operationId: getSchemaById
      x-speakeasy-name-override: get
      tags:
        - parquetschemas
      summary: Get Schema by ID
      description: Get Schema by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSchemaById
      x-speakeasy-name-override: update
      tags:
        - parquetschemas
      summary: Update Schema
      description: Update Schema
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Schema object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SchemaLibEntry"
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSchemaById
      x-speakeasy-name-override: delete
      tags:
        - parquetschemas
      summary: Delete Schema
      description: Delete Schema
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /pipelines:
    get:
      operationId: listPipeline
      x-speakeasy-group: pipelines
      x-speakeasy-name-override: list
      tags:
        - pipelines
      summary: List all Pipelines
      description: Get a list of all Pipelines.
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    post:
      operationId: createPipeline
      x-speakeasy-group: pipelines
      x-speakeasy-name-override: create
      tags:
        - pipelines
      summary: Create a Pipeline
      description: Create a new Pipeline.
      requestBody:
        description: Pipeline object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pipeline"
      responses:
        "200":
          description: a list of Pipelines objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /pipelines/{id}:
    get:
      operationId: getPipelineById
      x-speakeasy-group: pipelines
      x-speakeasy-name-override: get
      tags:
        - pipelines
      summary: Get a Pipeline
      description: Get the specified Pipeline.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to get.
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    patch:
      operationId: updatePipelineById
      x-speakeasy-group: pipelines
      x-speakeasy-name-override: update
      tags:
        - pipelines
      summary: Update a Pipeline
      description: Update the specified Pipeline.</br></br>Provide a complete
        representation of the Pipeline that you want to update in the request
        body. This endpoint does not support partial updates. Cribl removes any
        omitted fields when updating the Pipeline.</br></br>Confirm that the
        configuration in your request body is correct before sending the
        request. If the configuration is incorrect, the updated Pipeline might
        not function as expected.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to update.
      requestBody:
        description: Pipeline object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pipeline"
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deletePipelineById
      x-speakeasy-group: pipelines
      x-speakeasy-name-override: delete
      tags:
        - pipelines
      summary: Delete a Pipeline
      description: Delete the specified Pipeline.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to delete.
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /p/{pack}/pipelines:
    get:
      operationId: getPipelineByPack
      x-speakeasy-group: packs.pipelines
      x-speakeasy-name-override: list
      tags:
        - pipelines
      summary: List all Pipelines within a Pack
      description: Get a list of all Pipelines within the specified Pack.
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
    post:
      operationId: createPipelineByPack
      x-speakeasy-group: packs.pipelines
      x-speakeasy-name-override: create
      tags:
        - pipelines
      summary: Create a Pipeline within a Pack
      description: Create a new Pipeline within the specified Pack.
      requestBody:
        description: Pipeline object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pipeline"
      responses:
        "200":
          description: a list of Pipelines objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to POST
  /p/{pack}/pipelines/{id}:
    get:
      operationId: getPipelineByPackAndId
      x-speakeasy-group: packs.pipelines
      x-speakeasy-name-override: get
      tags:
        - pipelines
      summary: Get a Pipeline within a Pack
      description: Get the specified Pipeline within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to get.
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    patch:
      operationId: updatePipelineByPackAndId
      x-speakeasy-group: packs.pipelines
      x-speakeasy-name-override: update
      tags:
        - pipelines
      summary: Update a Pipeline within a Pack
      description: Update the specified Pipeline within the specified
        Pack.</br></br>Provide a complete representation of the Pipeline that
        you want to update in the request body. This endpoint does not support
        partial updates. Cribl removes any omitted fields when updating the
        Pipeline.</br></br>Confirm that the configuration in your request body
        is correct before sending the request. If the configuration is
        incorrect, the updated Pipeline might not function as expected.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to update.
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to PATCH
      requestBody:
        description: Pipeline object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pipeline"
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deletePipelineByPackAndId
      x-speakeasy-group: packs.pipelines
      x-speakeasy-name-override: delete
      tags:
        - pipelines
      summary: Delete a Pipeline within a Pack
      description: Delete the specified Pipeline within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to delete.
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to DELETE
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/projects/{projectId}/pipelines:
    get:
      operationId: getPipelineByProjectId
      x-speakeasy-group: projects.pipelines
      x-speakeasy-name-override: list
      tags:
        - pipelines
      summary: List all Pipelines within a Project
      description: Get a list of all Pipelines within the specified Project.
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: projectId ID to GET
    post:
      operationId: createPipelineByProjectId
      x-speakeasy-group: projects.pipelines
      x-speakeasy-name-override: create
      tags:
        - pipelines
      summary: Create a Pipeline within a Project
      description: Create a new Pipeline within the specified Project.
      requestBody:
        description: Pipeline object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pipeline"
      responses:
        "200":
          description: a list of Pipelines objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: projectId ID to POST
  /system/projects/{projectId}/pipelines/{id}:
    get:
      operationId: getPipelineByProjectIdAndId
      x-speakeasy-group: projects.pipelines
      x-speakeasy-name-override: get
      tags:
        - pipelines
      summary: Get a Pipeline within a Project
      description: Get the specified Pipeline within the specified Project.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to get.
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: projectId ID to GET
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    patch:
      operationId: updatePipelineByProjectIdAndId
      x-speakeasy-group: projects.pipelines
      x-speakeasy-name-override: update
      tags:
        - pipelines
      summary: Update a Pipeline within a Project
      description: Update the specified Pipeline within the specified
        Project.</br></br>Provide a complete representation of the Pipeline that
        you want to update in the request body. This endpoint does not support
        partial updates. Cribl removes any omitted fields when updating the
        Pipeline.</br></br>Confirm that the configuration in your request body
        is correct before sending the request. If the configuration is
        incorrect, the updated Pipeline might not function as expected.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to update.
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: projectId ID to PATCH
      requestBody:
        description: Pipeline object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pipeline"
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deletePipelineByProjectIdAndId
      x-speakeasy-group: projects.pipelines
      x-speakeasy-name-override: delete
      tags:
        - pipelines
      summary: Delete a Pipeline within a Project
      description: Delete the specified Pipeline within the specified Project.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pipeline to delete.
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: projectId ID to DELETE
      responses:
        "200":
          description: a list of Pipeline objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Pipeline"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/profiler:
    get:
      operationId: listProfilerItem
      x-speakeasy-name-override: list
      tags:
        - profiler
      summary: Get a list of ProfilerItem objects
      description: Get a list of ProfilerItem objects
      responses:
        "200":
          description: a list of ProfilerItem objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProfilerItem"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createProfilerItem
      x-speakeasy-name-override: create
      tags:
        - profiler
      summary: Create ProfilerItem
      description: Create ProfilerItem
      requestBody:
        description: New ProfilerItem object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProfilerItem"
      responses:
        "200":
          description: a list of ProfilerItem objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProfilerItem"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/profiler/{id}:
    get:
      operationId: getProfilerItemById
      x-speakeasy-name-override: get
      tags:
        - profiler
      summary: Get ProfilerItem by ID
      description: Get ProfilerItem by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of ProfilerItem objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProfilerItem"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateProfilerItemById
      x-speakeasy-name-override: update
      tags:
        - profiler
      summary: Update ProfilerItem
      description: Update ProfilerItem
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: ProfilerItem object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProfilerItem"
      responses:
        "200":
          description: a list of ProfilerItem objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProfilerItem"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteProfilerItemById
      x-speakeasy-name-override: delete
      tags:
        - profiler
      summary: Delete ProfilerItem
      description: Delete ProfilerItem
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of ProfilerItem objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProfilerItem"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /routes:
    get:
      operationId: listRoutes
      x-speakeasy-group: routes
      x-speakeasy-name-override: list
      tags:
        - routes
      summary: List all Routes
      description: Get a list of all Routes.
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /routes/{id}:
    get:
      operationId: getRoutesById
      x-speakeasy-group: routes
      x-speakeasy-name-override: get
      tags:
        - routes
      summary: Get a Routing table
      description: Get the specified Routing table.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Routing table to get. The supported
            value is <code>default</code>.
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    patch:
      operationId: updateRoutesById
      x-speakeasy-group: routes
      x-speakeasy-name-override: update
      tags:
        - routes
      summary: Update a Route
      description: Update a Route in the specified Routing table.</br></br>Provide a
        complete representation of the Routing table, including the Route that
        you want to update, in the request body. This endpoint does not support
        partial updates. Cribl removes any omitted Routes and fields when
        updating.</br></br>Confirm that the configuration in your request body
        is correct before sending the request. If the configuration is
        incorrect, the Routing table might not function as expected.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Routing table that contains the Route to
            update. The supported value is <code>default</code>.
      requestBody:
        description: Routes object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Routes"
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /routes/{id}/append:
    post:
      operationId: createRoutesAppendById
      tags:
        - routes
      x-speakeasy-group: routes
      x-speakeasy-name-override: append
      summary: Add a Route to the end of the Routing table
      description: Add a Route to the end of the specified Routing table.
      deprecated: false
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: RouteDefinitions object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RouteDefinitions"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Routing table to add the Route to. The
            supported value is <code>default</code>.
  /p/{pack}/routes:
    get:
      operationId: getRoutesByPack
      x-speakeasy-group: packs.routes
      x-speakeasy-name-override: list
      tags:
        - routes
      summary: List all Routes within a Pack
      description: Get a list of all Routes within the specified Pack.
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
  /p/{pack}/routes/{id}:
    get:
      operationId: getRoutesByPackAndId
      x-speakeasy-group: packs.routes
      x-speakeasy-name-override: get
      tags:
        - routes
      summary: Get a Routing table within a Pack
      description: Get the specified Routing table within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Routing table to get. The supported
            value is <code>default</code>.
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    patch:
      operationId: updateRoutesByPackAndId
      x-speakeasy-group: packs.routes
      x-speakeasy-name-override: update
      tags:
        - routes
      summary: Update a Route within a Pack
      description: Update the specified Route within the specified
        Pack.</br></br>Provide a complete representation of the Routing table,
        including the Route that you want to update, in the request body. This
        endpoint does not support partial updates. Cribl removes any omitted
        Routes and fields when updating.</br></br>Confirm that the configuration
        in your request body is correct before sending the request. If the
        configuration is incorrect, the Routing table might not function as
        expected.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Routing table that contains the Route to
            update. The supported value is <code>default</code>.
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to PATCH
      requestBody:
        description: Routes object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Routes"
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /p/{pack}/routes/{id}/append:
    post:
      operationId: createRoutesAppendByPackAndId
      tags:
        - routes
      x-speakeasy-group: packs.routes
      x-speakeasy-name-override: append
      summary: Add a Route to the end of the Routing table within a Pack
      description: Add a Route to the end of the specified Routing table within the
        specified Pack.
      deprecated: false
      responses:
        "200":
          description: a list of Routes objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Routes"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: RouteDefinitions object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RouteDefinitions"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Routing table to add the Route to. The
            supported value is <code>default</code>.
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to POST
  /lib/schemas:
    get:
      operationId: listLibSchemas
      x-speakeasy-name-override: list
      tags:
        - schemas
      summary: Get a list of Schema objects
      description: Get a list of Schema objects
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createLibSchemas
      x-speakeasy-name-override: create
      tags:
        - schemas
      summary: Create Schema
      description: Create Schema
      requestBody:
        description: New Schema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SchemaLibEntry"
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /lib/schemas/{id}:
    get:
      operationId: getLibSchemasById
      x-speakeasy-name-override: get
      tags:
        - schemas
      summary: Get Schema by ID
      description: Get Schema by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateLibSchemasById
      x-speakeasy-name-override: update
      tags:
        - schemas
      summary: Update Schema
      description: Update Schema
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Schema object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SchemaLibEntry"
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteLibSchemasById
      x-speakeasy-name-override: delete
      tags:
        - schemas
      summary: Delete Schema
      description: Delete Schema
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /p/{pack}/lib/schemas:
    get:
      operationId: getSchemaLibByPack
      x-speakeasy-name-override: list
      tags:
        - schemas
      summary: Get a list of Schema objects within a Pack
      description: Get a list of Schema objects within the specified Pack.
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.schemas
      parameters:
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
    post:
      operationId: createSchemaLibByPack
      x-speakeasy-name-override: create
      tags:
        - schemas
      summary: Create Schema within a Pack
      description: Create Schema within the specified Pack.
      requestBody:
        description: New Schema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SchemaLibEntry"
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.schemas
      parameters:
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to POST
  /p/{pack}/lib/schemas/{id}:
    get:
      operationId: getSchemaLibByPackAndId
      x-speakeasy-name-override: get
      tags:
        - schemas
      summary: Get Schema by ID within a Pack
      description: Get Schema by ID within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.schemas
    patch:
      operationId: updateSchemaLibByPackAndId
      x-speakeasy-name-override: update
      tags:
        - schemas
      summary: Update Schema within a Pack
      description: Update Schema within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to PATCH
      requestBody:
        description: Schema object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SchemaLibEntry"
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.schemas
    delete:
      operationId: deleteSchemaLibByPackAndId
      x-speakeasy-name-override: delete
      tags:
        - schemas
      summary: Delete Schema within a Pack
      description: Delete Schema within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to DELETE
      responses:
        "200":
          description: a list of Schema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SchemaLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.schemas
  /system/secrets:
    get:
      operationId: listRestSecret
      x-speakeasy-name-override: list
      tags:
        - secrets
      summary: Get a list of RestSecret objects
      description: Get a list of RestSecret objects
      responses:
        "200":
          description: a list of RestSecret objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RestSecret"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createRestSecret
      x-speakeasy-name-override: create
      tags:
        - secrets
      summary: Create RestSecret
      description: Create RestSecret
      requestBody:
        description: New RestSecret object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RestSecret"
      responses:
        "200":
          description: a list of RestSecret objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RestSecret"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/secrets/{id}:
    get:
      operationId: getRestSecretById
      x-speakeasy-name-override: get
      tags:
        - secrets
      summary: Get RestSecret by ID
      description: Get RestSecret by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of RestSecret objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RestSecret"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateRestSecretById
      x-speakeasy-name-override: update
      tags:
        - secrets
      summary: Update RestSecret
      description: Update RestSecret
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: RestSecret object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RestSecret"
      responses:
        "200":
          description: a list of RestSecret objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RestSecret"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteRestSecretById
      x-speakeasy-name-override: delete
      tags:
        - secrets
      summary: Delete RestSecret
      description: Delete RestSecret
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of RestSecret objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RestSecret"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/status/inputs:
    get:
      operationId: listInputStatus
      x-speakeasy-group: sources.status
      x-speakeasy-name-override: list
      tags:
        - sources
      summary: Get a list of Source Status objects
      description: Get a list of Source Status objects
      responses:
        "200":
          description: a list of Source Status objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/InputStatus"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/status/inputs/{id}:
    get:
      operationId: getInputStatusById
      x-speakeasy-group: sources.status
      x-speakeasy-name-override: get
      tags:
        - sources
      summary: Get Source Status by ID
      description: Get Source Status by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Source Status objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/InputStatus"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/status/outputs:
    get:
      operationId: listOutputStatus
      x-speakeasy-group: destinations.status
      x-speakeasy-name-override: list
      tags:
        - destinations
      summary: Get a list of Destination Status objects
      description: Get a list of Destination Status objects
      responses:
        "200":
          description: a list of Destination Status objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/OutputStatus"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/status/outputs/{id}:
    get:
      operationId: getOutputStatusById
      x-speakeasy-group: destinations.status
      x-speakeasy-name-override: get
      tags:
        - destinations
      summary: Get Destination Status by ID
      description: Get Destination Status by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Destination Status objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/OutputStatus"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/appscope/processes:
    post:
      operationId: createEdgeAppscopeProcesses
      tags:
        - edgeAppScopeProcesses
      summary: Attach AppScope to a process running on the edge host
      description: Attach AppScope to a process running on the edge host
      deprecated: false
      responses:
        "200":
          description: a list of AppScopeProcess objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppScopeProcess"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: pid
          in: query
          required: true
          schema:
            type: string
          description: config string required
    get:
      operationId: getEdgeAppscopeProcesses
      tags:
        - edgeAppScopeProcesses
      summary: Get a detailed list of scoped processes running on the edge host
      description: Get a detailed list of scoped processes running on the edge host
      deprecated: false
      responses:
        "200":
          description: a list of AppScopeProcess objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppScopeProcess"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/appscope/processes/{pid}:
    delete:
      operationId: deleteEdgeAppscopeProcessesByPid
      tags:
        - edgeAppScopeProcesses
      summary: Detach AppScope from a process running on the edge host
      description: Detach AppScope from a process running on the edge host
      deprecated: false
      responses:
        "200":
          description: a list of AppScopeProcess objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppScopeProcess"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: pid
          in: path
          required: true
          schema:
            type: string
          description: config string required
    get:
      operationId: getEdgeAppscopeProcessesByPid
      tags:
        - edgeAppScopeProcesses
      summary: Get details of a scoped process running on the edge host
      description: Get details of a scoped process running on the edge host
      deprecated: false
      responses:
        "200":
          description: a list of AppScopeProcess objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppScopeProcess"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: pid
          in: path
          required: true
          schema:
            type: string
          description: pid
    put:
      operationId: updateEdgeAppscopeProcessesByPid
      tags:
        - edgeAppScopeProcesses
      summary: Update AppScope configuration for a process running on the edge host
      description: Update AppScope configuration for a process running on the edge host
      deprecated: false
      responses:
        "200":
          description: a list of AppScopeProcess objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AppScopeProcess"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: pid
          in: path
          required: true
          schema:
            type: string
          description: config string required
  /edge/events/collectors:
    get:
      operationId: getEdgeEventsCollectors
      tags:
        - edgeEvents
      summary: Get list of configured collectors
      description: Get list of configured collectors
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/events/query:
    get:
      operationId: getEdgeEventsQuery
      tags:
        - events
      summary: Get events generated by a specified source
      description: Get events generated by a specified source
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: Files
          in: query
          required: false
          schema:
            type: string
          description: Optional parameter, when provided the files and provided offsets
            are used to look for events.
        - name: source
          in: query
          required: false
          schema:
            type: string
          description: The type of source events to search in the format {type}/{subtype}
            i.e system_state/hostsfile, system_state/routes, etc...
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of log lines to retrieve starting from offset.
        - name: et
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the earliest event (includes rolled files
            present on disk)
        - name: lt
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the latest event (includes rolled files present
            on disk)
        - name: filter
          in: query
          required: false
          schema:
            type: string
          description: Filter
  /edge/fileinspect:
    get:
      operationId: getEdgeFileinspect
      tags:
        - edge
      summary: Get details about a file on the edge host.
      description: Get details about a file on the edge host.
      deprecated: false
      responses:
        "200":
          description: a list of EdgeFileInspectResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EdgeFileInspectResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/ls{path}:
    get:
      operationId: getEdgeLsByPath
      tags:
        - edgeLs
      summary: Get a directory listing of the given path
      description: Get a directory listing of the given path
      deprecated: false
      responses:
        "200":
          description: a list of FilesystemEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/FilesystemEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: path
          in: path
          required: true
          schema:
            type: string
          description: Defaults to empty for the root directory
  /products/edge/map/query:
    post:
      operationId: createProductsEdgeMapQuery
      tags:
        - edge
      summary: Data for the Map View for Edge Fleets (Leader only)
      description: Data for the Map View for Edge Fleets (Leader only)
      deprecated: false
      responses:
        "200":
          description: a list of EdgeMapQueryResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EdgeMapQueryResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/metadata:
    get:
      operationId: getEdgeMetadata
      tags:
        - edge
      summary: Get the host's metadata structure
      description: Get the host's metadata structure
      deprecated: false
      responses:
        "200":
          description: a list of Metadata objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Metadata"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/file/ingest:
    post:
      operationId: createEdgeFileIngest
      tags:
        - edge
      summary: Ingest a specified file through a specified pipeline to a specified
        destination or send to routes.
      description: Ingest a specified file through a specified pipeline to a specified
        destination or send to routes.
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: filePath
          in: query
          required: false
          schema:
            type: string
          description: Absolute path to file to ingest.
        - name: pipelineId
          in: query
          required: false
          schema:
            type: string
          description: Id of the pipeline to use.
        - name: outputId
          in: query
          required: false
          schema:
            type: string
          description: Destination to send events to.
        - name: preProcessingPipelineId
          in: query
          required: false
          schema:
            type: string
          description: Id to the pre-processing pipeline to use for routes.
        - name: sendToRoutes
          in: query
          required: false
          schema:
            type: string
          description: boolean condition required on whether to send events to routes.
        - name: breakerRuleSet
          in: query
          required: false
          schema:
            type: string
          description: Breaker rules to use on the file.
  /edge/file/sample:
    get:
      operationId: getEdgeFileSample
      tags:
        - edge
      summary: Get some number of bytes from the file at the given path
      description: Get some number of bytes from the file at the given path
      deprecated: false
      responses:
        "200":
          description: a list of SampleFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SampleFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: path
          in: query
          required: true
          schema:
            type: string
          description: The path to the file to sample
        - name: bytesRequested
          in: query
          required: false
          schema:
            type: number
          description: The number of bytes to return;   this value could be constrained by
            system limits.
  /edge/kube-logs:
    post:
      operationId: createEdgeKubeLogs
      tags:
        - kube-logs
      summary: Make a request to the K8s API logs endpoint
      description: Make a request to the K8s API logs endpoint
      deprecated: false
      responses:
        "200":
          description: a list of object objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/kube-proxy:
    get:
      operationId: getEdgeKubeProxy
      tags:
        - kube-proxy
      summary: Make a GET request to the K8s API
      description: Make a GET request to the K8s API
      deprecated: false
      responses:
        "200":
          description: a list of object objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: path
          in: query
          required: false
          schema:
            type: string
          description: string optional
  /auth/authorization-code/callback:
    get:
      operationId: getAuthAuthorizationCodeCallback
      tags:
        - auth
      summary: API call that the IDP should use for an authorization code callback
      parameters:
        - in: query
          description: Authorization Code
          name: code
          schema:
            type: string
        - in: query
          name: state
          schema:
            type: string
      responses:
        "200":
          description: Authorization success
        "401":
          description: Unauthorized
  /auth/metadata:
    get:
      operationId: getAuthMetadata
      summary: Obtain metadata which Cribl Stream/Edge uses when acting as a Service
        Provider
      tags:
        - auth
      responses:
        "200":
          description: Service Provider metadata
          content:
            text/xml:
              schema:
                type: string
        "401":
          description: Unauthorized
  /auth/logout:
    post:
      operationId: logout
      summary: Log current user out
      tags:
        - auth
      responses:
        "200":
          description: Log out success
        "401":
          description: Unauthorized
  /auth/slo/callback:
    post:
      operationId: createAuthSloCallback
      tags:
        - auth
      summary: API call that the IDP should use for a logout request
      requestBody:
        description: Logout request object
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                SAMLResponse:
                  description: Logout request object
                  type: string
                RelayState:
                  type: string
      responses:
        "200":
          description: Logout success
        "400":
          description: Bad Request
        "401":
          description: Unauthorized
        "429":
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request
              schema:
                type: integer
                example: 60
    get:
      operationId: getAuthSloCallback
      tags:
        - auth
      summary: Accepts a logout request from an IDP and logs out the user
      parameters:
        - in: query
          description: Logout request object
          name: SAMLResponse
          schema:
            type: string
        - in: query
          name: RelayState
          schema:
            type: string
      responses:
        "200":
          description: Logout success
        "400":
          description: Bad Request
        "401":
          description: Unauthorized
        "429":
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request
              schema:
                type: integer
                example: 60
  /auth/slo:
    get:
      operationId: getAuthSlo
      summary: Redirect user to IDP with logout request
      tags:
        - auth
      responses:
        "200":
          description: SLO redirect info
        "400":
          description: Bad Request
        "401":
          description: Unauthorized
  /auth/sso/callback:
    post:
      operationId: createAuthSsoCallback
      tags:
        - auth
      summary: API call that the IDP should use for an authentication request
      requestBody:
        description: Authentication request object
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                SAMLResponse:
                  description: Authentication request object
                  type: string
                RelayState:
                  type: string
      responses:
        "200":
          description: Authentication success
        "400":
          description: Bad Request
        "401":
          description: Unauthorized
        "429":
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request
              schema:
                type: integer
                example: 60
    get:
      operationId: getAuthSsoCallback
      tags:
        - auth
      summary: Accepts an authentication request from an IDP and authenticates the user
      parameters:
        - in: query
          description: Authentication request object
          name: SAMLResponse
          schema:
            type: string
        - in: query
          name: RelayState
          schema:
            type: string
      responses:
        "200":
          description: Authentication success
        "400":
          description: Bad Request
        "401":
          description: Unauthorized
        "429":
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request
              schema:
                type: integer
                example: 60
  /auth/sso:
    get:
      operationId: getAuthSso
      summary: Obtain redirect information
      description: Obtain information needed to redirect users to the configured SSO
        IDP for authentication.
      tags:
        - auth
      responses:
        "200":
          description: Redirect info
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RedirectInfo"
        "401":
          description: Unauthorized
  /auth/groups:
    get:
      operationId: getAuthGroups
      tags:
        - auth
      summary: List the external authentication system's groups
      description: List the external authentication system's groups
      deprecated: false
      responses:
        "200":
          description: a list of CrudEntityBase objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CrudEntityBase"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /auth/multi-factor:
    get:
      operationId: getAuthMultiFactor
      tags:
        - auth
      summary: Get PIV configuration
      description: Get PIV configuration
      deprecated: false
      responses:
        "200":
          description: a list of MultiFactorAuthSchema objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MultiFactorAuthSchema"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /auth/users/{id}/token:
    delete:
      operationId: deleteAuthUsersTokenById
      tags:
        - auth
      summary: Invalidate token(s) for user *id*
      description: Invalidate token(s) for user *id*
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID of user to invalidate
        - name: ttl
          in: query
          required: false
          schema:
            type: string
          description: TTL of the token being invalidated
  /auth/login:
    post:
      operationId: createAuthLogin
      tags:
        - auth
      x-speakeasy-group: auth.tokens
      x-speakeasy-name-override: get
      summary: Log in and fetch an authentication token
      description: This endpoint is unavailable on Cribl.Cloud.Instead, follow the
        instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud
        to get an Auth token for Cribl.Cloud.
      deprecated: false
      security: []
      responses:
        "200":
          description: Authentication token
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthToken"
        "401":
          description: Invalid credentials or authentication failed
        "429":
          description: Rate limit exceeded
          headers:
            retry-after:
              description: Number of seconds the client should wait before retrying the
                request
              schema:
                type: integer
                example: 60
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: LoginInfo object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LoginInfo"
  /auth/users/{id}/invalidation:
    delete:
      operationId: deleteAuthUsersInvalidationById
      tags:
        - auth
      summary: Remove invalidation for user ID
      description: Remove invalidation for user ID
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID of user to reenable
  /authorize/policy:
    get:
      operationId: getAuthorizePolicy
      tags:
        - authorize
      summary: get the client's authorization policy
      description: get the client's authorization policy
      deprecated: false
      responses:
        "200":
          description: a list of AuthPolicyEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AuthPolicyEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /authorize/roles:
    get:
      operationId: getAuthorizeRoles
      tags:
        - authorize
      summary: get the client's roles
      description: get the client's roles
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/capture:
    post:
      operationId: createSystemCapture
      tags:
        - preview
      summary: Capture live incoming data
      description: Capture live incoming data
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CaptureParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CaptureParams"
  /system/projects/{projectId}/capture:
    post:
      operationId: createSystemProjectsCaptureByProjectId
      tags:
        - preview
      summary: Capture live incoming data from a particular project and subscription
        at the destination
      description: Capture live incoming data from a particular project and
        subscription at the destination
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CaptureParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CaptureParams"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project ID
  /system/projects/{projectId}/subscriptions/{subscriptionId}/capture:
    post:
      operationId: createSystemProjectsSubscriptionsCaptureByProjectIdAndSubscriptionId
      tags:
        - preview
      summary: Capture live incoming data from a particular project and subscription
        at the subscription
      description: Capture live incoming data from a particular project and
        subscription at the subscription
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CaptureParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CaptureParams"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project Id
        - name: subscriptionId
          in: path
          required: true
          schema:
            type: string
          description: SubscriptionId Id
  /changelog/viewed:
    get:
      operationId: getChangelogViewed
      tags:
        - changelog
      summary: Get changelog viewed state
      description: Get changelog viewed state
      deprecated: false
      responses:
        "200":
          description: a list of ChangelogState objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ChangelogState"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateChangelogViewed
      tags:
        - system
      summary: Update changelog viewed state
      description: Update changelog viewed state
      deprecated: false
      responses:
        "200":
          description: a list of ChangelogState objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ChangelogState"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /output/click-house/describe-table:
    post:
      operationId: createOutputClickHouseDescribeTable
      tags:
        - click-house
      summary: Retrieve the description of the configured ClickHouse table
      description: Retrieve the description of the configured ClickHouse table
      deprecated: false
      responses:
        "200":
          description: a list of ClickHouseDescriptionResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ClickHouseDescriptionResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: CHOutConfig object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CHOutConfig"
  /clui:
    get:
      operationId: getClui
      tags:
        - clui
      summary: Get CLUI search results
      description: Get CLUI search results
      deprecated: false
      responses:
        "200":
          description: a list of CluiItem objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/CluiItem"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          description: Search query
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get
            results from. Required in Distributed deployments. Omit in
            Single-instance deployments.
  /master/bundles/{group}/{version}:
    get:
      operationId: getConfigBundlesByGroupAndVersion
      summary: Download config bundle (used by remote nodes)
      tags:
        - distributed
      parameters:
        - name: group
          in: path
          required: true
          schema:
            type: string
        - name: version
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Get contents of a config bundle
          content:
            application/tar+gzip:
              schema:
                type: string
                format: binary
        "400":
          description: Invalid path
        "404":
          description: File is missing
  /master/bundles/{group}/lookups/{context}/{file}:
    get:
      operationId: getConfigBundlesByGroupAndContextAndFile
      summary: Download lookup bundle (used by remote nodes)
      tags:
        - distributed
      parameters:
        - name: group
          in: path
          required: true
          schema:
            type: string
        - name: context
          in: path
          required: true
          schema:
            type: string
        - name: file
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Get contents of a lookup bundle
          content:
            application/tar+gzip:
              schema:
                type: string
                format: binary
        "400":
          description: Invalid path
        "404":
          description: File is missing
  /system/distributed/upgrade/cancel/{group}:
    post:
      operationId: createSystemDistributedUpgradeCancelByGroup
      tags:
        - system
      summary: Cancel a running group upgrade
      description: Cancel a running group upgrade
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: group
          in: path
          required: true
          schema:
            type: string
          description: id of the group
  /system/distributed/upgrade/stage/{group}:
    post:
      operationId: createSystemDistributedUpgradeStageByGroup
      tags:
        - system
      summary: Stage distributed group upgrade
      description: Stage distributed group upgrade
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: distributedUpgrade object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DistributedUpgradeRequest"
      parameters:
        - name: group
          in: path
          required: true
          schema:
            type: string
          description: Group to upgrade
  /system/distributed/upgrade/{group}:
    post:
      operationId: createSystemDistributedUpgradeByGroup
      tags:
        - system
      summary: Execute distributed group upgrade
      description: Execute distributed group upgrade
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: distributedUpgrade object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DistributedUpgradeRequest"
      parameters:
        - name: group
          in: path
          required: true
          schema:
            type: string
          description: Group to upgrade
  /system/distributed/upgrade/download/{file}:
    get:
      operationId: getSystemDistributedUpgradeDownloadByFile
      tags:
        - system
      summary: Get the previously downloaded Cribl package
      description: Get the previously downloaded Cribl package
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: file
          in: path
          required: true
          schema:
            type: string
          description: Name of the file to be downloaded
  /lib/expression:
    post:
      operationId: createLibExpression
      tags:
        - expressions
      summary: Evaluate JavaScript expression
      description: Evaluate JavaScript expression
      deprecated: false
      responses:
        "200":
          description: a list of ExprLibEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ExprLibEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /conditions:
    get:
      operationId: listCondition
      x-speakeasy-name-override: list
      tags:
        - conditions
      summary: Get a list of Condition objects
      description: Get a list of Condition objects
      responses:
        "200":
          description: a list of Condition objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Condition"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /conditions/{id}:
    get:
      operationId: getConditionById
      x-speakeasy-name-override: get
      tags:
        - conditions
      summary: Get Condition by ID
      description: Get Condition by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Condition objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Condition"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /health:
    get:
      operationId: getHealth
      tags:
        - health
      x-speakeasy-group: health
      x-speakeasy-name-override: get
      summary: Retrieve health status of the server
      description: Get the current health status of the server.
      deprecated: false
      security: []
      responses:
        "200":
          description: Healthy status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthServerStatus"
        "420":
          description: Server is shutting down or in standby mode
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthServerStatus"
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /health/workers:
    get:
      operationId: getHealthWorkers
      tags:
        - health
      summary: Provides health info of worker processes
      description: Get the health status of worker processes.
      deprecated: false
      responses:
        "200":
          description: Healthy status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthyWorkerStatus"
        "401":
          description: Unauthorized
        "420":
          description: Down status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DownWorkerStatus"
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /insights/metrics/query:
    post:
      operationId: createInsightsMetricsQuery
      tags:
        - insights
      summary: Retrieve the latest metric values, optionally aggregated, for multiple
        time series
      description: Retrieve the latest metric values, optionally aggregated, for
        multiple time series
      deprecated: false
      responses:
        "200":
          description: InsightsQueryResponse object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InsightsQueryResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: InsightsQueryRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/InsightsQueryRequest"
  /jobs/{id}/results:
    get:
      operationId: getJobResultsById
      tags:
        - jobs
      summary: Get results for a discover job by instance id
      description: Get results for a discover job by instance id
      responses:
        "200":
          description: Get results for a discover job by instance id
          content:
            application/x-ndjson:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job instance id
  /jobs/{id}/cancel:
    patch:
      operationId: updateJobsCancelById
      tags:
        - jobs
      summary: Cancel a job by instance id
      description: Cancel a job by instance id
      deprecated: false
      responses:
        "200":
          description: a list of JobState objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/JobState"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job instance id
  /jobs:
    post:
      operationId: createJobs
      tags:
        - jobs
      summary: Run or schedule a job
      description: Run or schedule a job
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: SavedJob object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SavedJob"
    get:
      operationId: getJobs
      tags:
        - jobs
      summary: Get info on jobs
      description: Get info on jobs
      deprecated: false
      responses:
        "200":
          description: a list of JobInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  offset:
                    type: integer
                    description: pagination offset
                  limit:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    description: the pre-limited items in the list of results
                    items:
                      $ref: "#/components/schemas/JobInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: offset
          in: query
          required: false
          schema:
            type: integer
          description: Pagination offset
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of items to return
        - name: runType
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/JobRunTypes"
          description: Filter by job run type
        - name: state
          in: query
          required: false
          schema:
            type: string
          description: Filter by current job state, e.g. "running"
        - name: id
          in: query
          required: false
          schema:
            type: string
          description: Filter by job id, e.g. "id=1608713335.3&id=1608713326.1"
        - name: collectorId
          in: query
          required: false
          schema:
            type: string
          description: Filter by collector id, e.g. "collectorId=Prometheus-in"
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: Filter by worker group id, e.g. "defaultHybrid"
  /jobs/{id}:
    delete:
      operationId: deleteJobsById
      tags:
        - jobs
      summary: Remove job from job inspector by instance id
      description: Remove job from job inspector by instance id
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job instance id
    get:
      operationId: getJobsById
      tags:
        - jobs
      summary: Get job info by instance id
      description: Get job info by instance id
      deprecated: false
      responses:
        "200":
          description: a list of JobInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/JobInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job instance id
  /jobs/{id}/keep:
    patch:
      operationId: updateJobsKeepById
      tags:
        - jobs
      summary: prevent job from being deleted automatically
      description: prevent job from being deleted automatically
      deprecated: false
      responses:
        "200":
          description: a list of JobInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/JobInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job Instance id
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: Group ID
  /jobs/{id}/pause:
    patch:
      operationId: updateJobsPauseById
      tags:
        - jobs
      summary: Pause a job by instance id
      description: Pause a job by instance id
      deprecated: false
      responses:
        "200":
          description: a list of JobState objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/JobState"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job instance id
  /jobs/{id}/resume:
    patch:
      operationId: updateJobsResumeById
      tags:
        - jobs
      summary: Resume a job by instance id
      description: Resume a job by instance id
      deprecated: false
      responses:
        "200":
          description: a list of JobState objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/JobState"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job instance id
  /jobs/{id}/results/{group}:
    get:
      operationId: getJobsResultsByIdAndGroup
      tags:
        - jobs
      summary: Get results for a discover job by instance id
      description: Get results for a discover job by instance id
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Instance id of the job to get results for
        - name: maxFiles
          in: query
          required: false
          schema:
            type: number
          description: Maximum files to get job results
        - name: group
          in: path
          required: true
          schema:
            type: string
          description: Group the job belongs to
  /jobs/{id}/errors/{group}:
    get:
      operationId: getJobsErrorsByIdAndGroup
      tags:
        - jobs
      summary: Get Task errors for a job by id
      description: Get Task errors for a job by id
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "404":
          description: Job or task errors not found
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Instance id of the job to get results for
        - name: group
          in: path
          required: true
          schema:
            type: string
          description: Group the job belongs to
  /jobs/{id}/errors:
    get:
      operationId: getJobsErrorsById
      tags:
        - jobs
      summary: Get Task errors for a job by id
      description: Get Task errors for a job by id
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Instance id of the job to get results for
  /security/kms/config:
    get:
      operationId: getSecurityKmsConfig
      tags:
        - security
      summary: Get Cribl KMS config
      description: Get Cribl KMS config
      deprecated: false
      responses:
        "200":
          description: a list of KMSProviderConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KMSProviderConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSecurityKmsConfig
      tags:
        - security
      summary: Update Cribl KMS config
      description: Update Cribl KMS config
      deprecated: false
      responses:
        "200":
          description: a list of KMSProviderConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KMSProviderConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: KMSProviderConfig object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/KMSProviderConfig"
  /security/kms/health:
    get:
      operationId: getSecurityKmsHealth
      tags:
        - security
      summary: Get Cribl KMS health
      description: Get Cribl KMS health
      deprecated: false
      responses:
        "200":
          description: a list of KMSHealth objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/KMSHealth"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/licenses:
    get:
      operationId: listLicense
      x-speakeasy-name-override: list
      tags:
        - licenses
      summary: Get a list of License objects
      description: Get a list of License objects
      responses:
        "200":
          description: a list of License objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/License"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createLicense
      x-speakeasy-name-override: create
      tags:
        - licenses
      summary: Add a license to your deployment
      description: Add a license to your deployment
      requestBody:
        description: LicenseRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LicenseRequest"
      responses:
        "200":
          description: a list of License objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/License"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/licenses/{id}:
    get:
      operationId: getLicenseById
      x-speakeasy-name-override: get
      tags:
        - licenses
      summary: Get License by ID
      description: Get License by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of License objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/License"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteLicenseById
      x-speakeasy-name-override: delete
      tags:
        - licenses
      summary: Delete License
      description: Delete License
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of License objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/License"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/licenses/usage:
    get:
      operationId: getLicense
      tags:
        - licenses
      summary: Get license usage metrics, aggregated by day, up to last 90 days
      description: Get license usage metrics, aggregated by day, up to last 90 days
      deprecated: false
      responses:
        "200":
          description: a list of UsageMetricsExtended objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UsageMetricsExtended"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/logger:
    get:
      operationId: listLoggerConfig
      x-speakeasy-name-override: list
      tags:
        - logger
      summary: Get a list of LoggerConfig objects
      description: Get a list of LoggerConfig objects
      responses:
        "200":
          description: a list of LoggerConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LoggerConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/logger/{id}:
    get:
      operationId: getLoggerConfigById
      x-speakeasy-name-override: get
      tags:
        - logger
      summary: Get LoggerConfig by ID
      description: Get LoggerConfig by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of LoggerConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LoggerConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateLoggerConfigById
      x-speakeasy-name-override: update
      tags:
        - logger
      summary: Update LoggerConfig
      description: Update LoggerConfig
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: LoggerConfig object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LoggerConfig"
      responses:
        "200":
          description: a list of LoggerConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LoggerConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteLoggerConfigById
      x-speakeasy-name-override: delete
      tags:
        - logger
      summary: Delete LoggerConfig
      description: Delete LoggerConfig
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of LoggerConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LoggerConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/jobs/logs/{id}/{groupId}:
    get:
      operationId: getSystemJobsLogsByIdAndGroupId
      tags:
        - logging
      summary: Get contents of the log file
      description: Get contents of the log file
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Job id
        - name: groupId
          in: path
          required: true
          schema:
            type: string
          description: Group ID
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of log lines to retrieve starting from offset.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
          description: Offset in the current log file to fetch the log events from.
        - name: endOffset
          in: query
          required: false
          schema:
            type: integer
          description: in the current log file to fetch the log events upto.
        - name: et
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the earliest event (includes rolled files
            present on disk)
        - name: lt
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the latest event (includes rolled files present
            on disk)
        - name: filter
          in: query
          required: false
          schema:
            type: string
          description: Filter
  /system/logs/{id}:
    get:
      operationId: getSystemLogsById
      tags:
        - logging
      summary: Get contents of the log file
      description: Get contents of the log file
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Log ID
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of log lines to retrieve starting from offset.
        - name: endOffset
          in: query
          required: false
          schema:
            type: integer
          description: in the current log file to fetch the log events upto.
        - name: et
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the earliest event (includes rolled files
            present on disk)
        - name: lt
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the latest event (includes rolled files present
            on disk)
        - name: filter
          in: query
          required: false
          schema:
            type: string
          description: Filter
  /system/logs:
    get:
      operationId: getSystemLogs
      tags:
        - logging
      summary: Get a list of log files
      description: Get a list of log files
      deprecated: false
      responses:
        "200":
          description: a list of LogFileInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/LogFileInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/logs/search:
    get:
      operationId: getSystemLogsSearch
      tags:
        - logging
      summary: Get contents of the log file
      description: Get contents of the log file
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: type
          in: query
          required: true
          schema:
            type: string
          description: type of logs request single multi group
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: id of the group to query
        - name: files
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
          description: file or files to query
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of log lines to retrieve starting from offset.
        - name: et
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the earliest event (includes rolled files
            present on disk)
        - name: lt
          in: query
          required: false
          schema:
            type: integer
          description: Epoch timestamp of the latest event (includes rolled files present
            on disk)
        - name: filter
          in: query
          required: false
          schema:
            type: string
          description: Filter
  /packs:
    post:
      operationId: createPacks
      tags:
        - packs
      x-speakeasy-group: packs
      x-speakeasy-name-override: install
      summary: Install a Pack
      description: Install a Pack.<br><br>To install an uploaded Pack, provide the
        <code>source</code> value from the <code>PUT /packs</code> response as
        the <code>source</code> parameter in the request body.<br><br>To install
        a Pack by importing from a URL, provide the direct URL location of the
        <code>.crbl</code> file for the Pack as the <code>source</code>
        parameter in the request body.<br><br>To install a Pack by importing
        from a Git repository, provide <code>git+<repo-url></code> as the
        <code>source</code> parameter in the request body.<br><br>If you do not
        include the <code>source</code> parameter in the request body, an empty
        Pack is created.
      deprecated: false
      responses:
        "200":
          description: a list of PackInstallInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PackInstallInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: packRequestBody object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PackRequestBody"
            examples:
              PackInstallExamplesPackDispensary:
                $ref: "#/components/examples/PackInstallExamplesPackDispensary"
              PackInstallExamplesEmptyPack:
                $ref: "#/components/examples/PackInstallExamplesEmptyPack"
              PackInstallExamplesUploadedFile:
                $ref: "#/components/examples/PackInstallExamplesUploadedFile"
              PackInstallExamplesURL:
                $ref: "#/components/examples/PackInstallExamplesURL"
              PackInstallExamplesGitRepository:
                $ref: "#/components/examples/PackInstallExamplesGitRepository"
    get:
      operationId: getPacks
      tags:
        - packs
      x-speakeasy-group: packs
      x-speakeasy-name-override: list
      summary: List all Packs
      description: Get a list of all Packs.
      deprecated: false
      responses:
        "200":
          description: a list of PackInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PackInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: with
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated list of additional properties to include in the
            response. When set, the response includes a count of the specified
            properties in the Pack. Available values are <code>inputs</code> and
            <code>outputs</code>.
    put:
      operationId: updatePacks
      tags:
        - packs
      x-speakeasy-group: packs
      x-speakeasy-name-override: upload
      summary: Upload a Pack file
      description: Upload a Pack file. Returns the <code>source</code> ID needed to
        install the Pack with <code>POST /packs source</code>, which you must
        call separately.
      deprecated: false
      responses:
        "200":
          description: Pack file uploaded successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UploadPackResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
              description: Pack file upload
      parameters:
        - name: filename
          in: query
          required: true
          schema:
            type: string
          description: Filename of the Pack file to upload.
  /packs/{id}:
    delete:
      operationId: deletePacksById
      tags:
        - packs
      x-speakeasy-group: packs
      x-speakeasy-name-override: delete
      summary: Uninstall a Pack
      description: Uninstall the specified Pack.
      deprecated: false
      responses:
        "200":
          description: a list of PackInstallInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PackInstallInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pack to uninstall.
    get:
      operationId: getPacksById
      tags:
        - packs
      x-speakeasy-group: packs
      x-speakeasy-name-override: get
      summary: Get a Pack
      description: Get the specified Pack.
      deprecated: false
      responses:
        "200":
          description: a list of PackInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PackInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pack to get.
    patch:
      operationId: updatePacksById
      tags:
        - packs
      x-speakeasy-group: packs
      x-speakeasy-name-override: update
      summary: Upgrade a Pack
      description: Upgrade the specified Pack.</br></br>If the Pack includes any
        user–modified versions of default Cribl Knowledge resources such as
        lookups, copy the modified files locally for safekeeping before
        upgrading the Pack.Copy the modified files back to the upgraded Pack
        after you install it with <code>POST /packs</code> to overwrite the
        default versions in the Pack.</br></br>After you upgrade the Pack,
        update any Routes, Pipelines, Sources, and Destinations that use the
        previous Pack version so that they reference the upgraded Pack.
      deprecated: false
      responses:
        "200":
          description: a list of PackInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PackInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: PackUpgradeRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PackUpgradeRequest"
            examples:
              PackUpgradeExamplesUpgradeFromURL:
                $ref: "#/components/examples/PackUpgradeExamplesUpgradeFromURL"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Pack to upgrade.
  /packs/__clone__:
    post:
      operationId: createPacksClone
      tags:
        - packs
      summary: Clone Pack
      description: Clone Pack
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: PackClone object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PackClone"
  /packs/{id}/refs:
    get:
      operationId: getPacksRefsById
      tags:
        - packs
      summary: Returns all entities that reference objects from outside of the pack
      description: Returns all entities that reference objects from outside of the pack
      deprecated: false
      responses:
        "200":
          description: a list of ReferencingEntity objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ReferencingEntity"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Pack name
  /packs/{id}/export:
    get:
      operationId: getPacksExportById
      tags:
        - packs
      summary: Export Pack
      description: Export Pack
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Pack name
        - name: mode
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/PackExportModeTypes"
          description: 'Export mode. Note: "merge_safe" is deprecated and will be removed
            in v5.0.0. Use "merge" instead.'
        - name: filename
          in: query
          required: false
          schema:
            type: string
          description: Filename of the exported Pack
  /packs/{id}/publish:
    post:
      operationId: createPacksPublishById
      tags:
        - packs
      summary: Publish Pack back to its repository
      description: Publish Pack back to its repository
      deprecated: false
      responses:
        "200":
          description: a list of PublishPackResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PublishPackResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Pack name
  /preview:
    post:
      operationId: createPreview
      tags:
        - preview
      summary: Sends sample events through a pipeline and returns the results
      description: Sends sample events through a pipeline and returns the results
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: PreviewDataParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PreviewDataParams"
  /system/projects/{projectId}/preview:
    post:
      operationId: createSystemProjectsPreviewByProjectId
      tags:
        - preview
      summary: Sends sample events through a pipeline and returns the results within a
        Project
      description: Sends sample events through a Pipeline for specified Project and
        returns the results
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: PreviewDataParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PreviewDataParams"
      x-speakeasy-group: projects.preview
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: projectId ID to POST
  /system/processes:
    get:
      operationId: getSystemProcesses
      tags:
        - processes
      summary: Get a list of processes under management
      description: Get a list of processes under management
      deprecated: false
      responses:
        "200":
          description: a list of ProcessEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProcessEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /products/{product}/users/{id}/acl:
    get:
      operationId: getProductsUsersAclByProductAndId
      tags:
        - users
      summary: Get user's Access Control List
      description: Get user's Access Control List
      deprecated: false
      responses:
        "200":
          description: a list of ResourcePolicy objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ResourcePolicy"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsAll"
          description: product by which to filter members
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: user id
        - name: type
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/RbacResource"
          description: resource type by which to filter access levels
  /products/{product}/users:
    get:
      operationId: getProductsUsersByProduct
      tags:
        - users
      summary: Get Users belonging to a product
      description: Get Users belonging to a product
      deprecated: false
      responses:
        "200":
          description: a list of User objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/User"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsAll"
          description: product by which to filter members
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: filter to specific group by groupId
  /products/{product}/users/__cache__:
    delete:
      operationId: deleteProductsUsersCacheByProduct
      tags:
        - users
      summary: Invalidate the members cache for a given product in SaaS deployment.
      description: Invalidate the members cache for a given product in SaaS deployment.
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsAll"
          description: product by which to filter members
  /system/projects/{projectId}/version/commit:
    post:
      operationId: createSystemProjectsVersionCommitByProjectId
      tags:
        - versioning
      summary: Commit project changes.
      description: Commit project changes.
      deprecated: false
      responses:
        "200":
          description: a list of GitCommitSummary objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitCommitSummary"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: ProjectGitCommitParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProjectGitCommitParams"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project Id
  /system/projects/{projectId}/version/count:
    get:
      operationId: getSystemProjectsVersionCountByProjectId
      tags:
        - versioning
      summary: get the count of files of changed
      description: get the count of files of changed
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project ID
        - name: ID
          in: query
          required: false
          schema:
            type: string
          description: Commit ID
  /system/projects/{projectId}/version/diff:
    get:
      operationId: getSystemProjectsVersionDiffByProjectId
      tags:
        - versioning
      summary: get the textual diff for given commit
      description: get the textual diff for given commit
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project Id
        - name: commit
          in: query
          required: false
          schema:
            type: string
          description: Commit hash (default is HEAD)
        - name: filename
          in: query
          required: false
          schema:
            type: string
          description: Filename
        - name: diffLineLimit
          in: query
          required: false
          schema:
            type: number
          description: Limit maximum lines in the diff
  /system/projects/{projectId}/version/files:
    get:
      operationId: getSystemProjectsVersionFilesByProjectId
      tags:
        - versioning
      summary: get the files changed
      description: get the files changed
      deprecated: false
      responses:
        "200":
          description: a list of GitFilesResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitFilesResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project ID
        - name: ID
          in: query
          required: false
          schema:
            type: string
          description: Commit ID
  /system/projects/{projectId}/version/revert:
    post:
      operationId: createSystemProjectsVersionRevertByProjectId
      tags:
        - versioning
      summary: Revert project changes.
      description: Revert project changes.
      deprecated: false
      responses:
        "200":
          description: a list of GitRevertResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitRevertResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: GitRevertParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GitRevertParams"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project Id
  /system/projects/{projectId}/version/show:
    get:
      operationId: getSystemProjectsVersionShowByProjectId
      tags:
        - versioning
      summary: Show project changes.
      description: Show project changes.
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project Id
        - name: ID
          in: query
          required: false
          schema:
            type: string
          description: Commit ID
        - name: filename
          in: query
          required: false
          schema:
            type: string
          description: Filename
        - name: diffLineLimit
          in: query
          required: false
          schema:
            type: number
          description: Limit maximum lines in the diff
  /system/diag/download:
    get:
      operationId: getDiagBundle
      summary: Returns a diag bundle as a tar.gz archive
      tags:
        - diag
      responses:
        "200":
          description: A tar.gz file consisting all configuration files and recent logs
          content:
            application/tar+gzip:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
  /system/info:
    get:
      operationId: getSystemInfo
      tags:
        - diag
      summary: Get basic system information
      description: Get basic system information
      deprecated: false
      responses:
        "200":
          description: a list of SystemInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SystemInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/diag:
    get:
      operationId: getSystemDiag
      tags:
        - diag
      summary: Get list of existing diag bundles
      description: Get list of existing diag bundles
      deprecated: false
      responses:
        "200":
          description: a list of Diag objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Diag"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteSystemDiag
      tags:
        - diag
      summary: Remove diag bundle
      description: Remove diag bundle
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: path
          in: query
          required: true
          schema:
            type: string
          description: Diag bundle path
  /system/diag/send:
    post:
      operationId: createSystemDiagSend
      tags:
        - diag
      summary: Send a diag bundle (tar.gz archive) to Cribl
      description: Send a diag bundle (tar.gz archive) to Cribl
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: SendDiagBundle object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SendDiagBundle"
  /system/metrics/enum:
    post:
      operationId: createSystemMetricsEnum
      tags:
        - metrics
      summary: Enumerate all internal system metrics
      description: Enumerate all internal system metrics
      deprecated: false
      responses:
        "200":
          description: a list of MetricNameInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MetricNameInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: SystemMetricsEnum object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SystemMetricsEnum"
  /system/metrics:
    get:
      operationId: getSystemMetrics
      tags:
        - metrics
      summary: Query raw internal system metrics
      description: Query raw internal system metrics
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: wp
          in: query
          required: false
          schema:
            type: string
          description: worker process to query, this would work only on a worker node
        - name: numBuckets
          in: query
          required: false
          schema:
            type: number
          description: buckets in the past to include in the query results
        - name: earliest
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: number
          description: earliest time to query against
        - name: latest
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: number
          description: latest time to query against
        - name: metricNameFilter
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
          description: can be a regex or an array of metric names
        - name: filterExpr
          in: query
          required: false
          schema:
            type: string
          description: a js expression to apply against the metrics returned (can filter
            dimensions)
        - name: namespace
          in: query
          required: false
          schema:
            type: string
          description: metric store namespace to retrieve data from
  /system/metrics/query:
    post:
      operationId: createSystemMetricsQuery
      tags:
        - metrics
      summary: Aggregate raw internal system metrics
      description: Aggregate raw internal system metrics
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: MetricsAggOpts object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MetricsAggOpts"
  /system/settings/reload:
    post:
      operationId: reloadSettings
      summary: Reload Cribl settings from the filesystem
      tags:
        - system
      responses:
        "200":
          description: Success
        "500":
          description: Internal error
  /system/settings/restart:
    post:
      operationId: triggerRestart
      summary: Restart Cribl server
      tags:
        - system
      responses:
        "200":
          description: Success
        "500":
          description: Internal error
  /system/settings/auth:
    get:
      operationId: getSystemSettingsAuth
      tags:
        - system
      summary: Get authentication settings
      description: Get authentication settings
      deprecated: false
      responses:
        "200":
          description: a list of AuthConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AuthConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSystemSettingsAuth
      tags:
        - system
      summary: Update authentication settings
      description: Update authentication settings
      deprecated: false
      responses:
        "200":
          description: a list of AuthConfig objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/AuthConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/settings/conf:
    get:
      operationId: getSystemSettingsConf
      tags:
        - system
      summary: Get Cribl system settings
      description: Get Cribl system settings
      deprecated: false
      responses:
        "200":
          description: a list of SystemSettingsConf objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SystemSettingsConf"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSystemSettingsConf
      tags:
        - system
      summary: Update Cribl system settings
      description: Update Cribl system settings
      deprecated: false
      responses:
        "200":
          description: a list of SystemSettings objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SystemSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: SystemSettingsConf object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SystemSettingsConf"
  /system/settings/git-settings:
    get:
      operationId: getSystemSettingsGitSettings
      tags:
        - git
      summary: Get git settings
      description: Get git settings
      deprecated: false
      responses:
        "200":
          description: a list of GitSettings objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSystemSettingsGitSettings
      tags:
        - git
      summary: Update git settings
      description: Update git settings
      deprecated: false
      responses:
        "200":
          description: a list of GitSettings objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/settings/search-limits:
    get:
      operationId: getSystemSettingsSearchLimits
      tags:
        - system
      summary: Get search limits
      description: Get search limits
      deprecated: false
      responses:
        "200":
          description: a list of SearchSettings objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/settings:
    get:
      operationId: getSystemSettings
      tags:
        - system
      summary: "Get Cribl system settings. Deprecated: use specific endpoints
        /system/limits, /system/job-limits, /system/redis-cache-limits,
        /system/services-limits, /system/settings/git-settings, and
        /system/settings/conf respectively"
      description: "Get Cribl system settings. Deprecated: use specific endpoints
        /system/limits, /system/job-limits, /system/redis-cache-limits,
        /system/services-limits, /system/settings/git-settings, and
        /system/settings/conf respectively"
      deprecated: true
      responses:
        "200":
          description: a list of SystemSettings objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SystemSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSystemSettings
      tags:
        - system
      summary: "Update Cribl system settings. Deprecated: use specific endpoints
        /system/limits, /system/job-limits, /system/settings/git-settings,
        /system/settings/auth and /system/settings/conf respectively"
      description: "Update Cribl system settings. Deprecated: use specific endpoints
        /system/limits, /system/job-limits, /system/settings/git-settings,
        /system/settings/auth and /system/settings/conf respectively"
      deprecated: true
      responses:
        "200":
          description: a list of SystemSettings objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SystemSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/settings/cribl:
    get:
      operationId: getSystemSettingsCribl
      tags:
        - system
      summary: Get public settings visible to any logged user
      description: Get public settings visible to any logged user
      deprecated: false
      responses:
        "200":
          description: a list of PublicSettings objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PublicSettings"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/settings/upgrade:
    get:
      operationId: getSystemSettingsUpgrade
      tags:
        - system
      summary: Get a list of Cribl versions available for upgrade
      description: Get a list of Cribl versions available for upgrade
      deprecated: false
      responses:
        "200":
          description: a list of UpgradeResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UpgradeResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/settings/upgrade/{version}:
    post:
      operationId: createSystemSettingsUpgradeByVersion
      tags:
        - system
      summary: Upgrade Cribl to a given version
      description: Upgrade Cribl to a given version
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: version
          in: path
          required: true
          schema:
            type: string
          description: Version number
  /system/settings/upgrade-from-package:
    post:
      operationId: createSystemSettingsUpgradeFromPackage
      tags:
        - system
      summary: Upgrade master node with the provided package
      description: Upgrade master node with the provided package
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: upgradeMaster object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpgradeMasterRequest"
  /ui/{key}:
    get:
      operationId: getUiByKey
      tags:
        - uiState
      summary: Get UI state by key
      description: Get UI state by key
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: string
          description: UI state key
    patch:
      operationId: updateUiByKey
      tags:
        - uiState
      summary: Update UI state by key
      description: Update UI state by key
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: UI State Patch object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UiStatePatch"
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: string
          description: UI state key
  /version/branch:
    get:
      operationId: getVersionBranch
      tags:
        - versioning
      x-speakeasy-group: versions.branches
      x-speakeasy-name-override: list
      summary: List all branches in the Git repository used for Cribl configuration
      description: Get a list of all branches in the Git repository used for Cribl
        configuration.
      deprecated: false
      responses:
        "200":
          description: a list of BranchInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/BranchInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /version/commit:
    post:
      operationId: createVersionCommit
      tags:
        - versioning
      x-speakeasy-group: versions.commits
      x-speakeasy-name-override: create
      summary: Create a new commit for pending changes to the Cribl configuration
      description: Create a new commit for pending changes to the Cribl configuration.
        Any merge conflicts indicated in the response must be resolved using
        Git.</br></br>To commit only a subset of configuration changes, specify
        the files to include in the commit in the <code>files</code> array.
      deprecated: false
      responses:
        "200":
          description: a list of GitCommitSummary objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitCommitSummary"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: GitCommitParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GitCommitParams"
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to create a
            new commit for.
  /version/count:
    get:
      operationId: getVersionCount
      tags:
        - versioning
      x-speakeasy-group: versions.commits.files
      x-speakeasy-name-override: count
      summary: Get a count of files that changed since a commit
      description: Get a count of the files that changed since a commit. Default is
        the latest commit (HEAD).
      deprecated: false
      responses:
        "200":
          description: a list of GitCountResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitCountResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            count for.
        - name: ID
          in: query
          required: false
          schema:
            type: string
          description: The Git commit hash to use as the starting point for the count.
  /version/current-branch:
    get:
      operationId: getVersionCurrentBranch
      tags:
        - versioning
      x-speakeasy-group: versions.branches
      x-speakeasy-name-override: get
      summary: Get the name of the Git branch that the Cribl configuration is checked
        out to
      description: Get the name of the Git branch that the Cribl configuration is
        checked out to. Useful for verifying the active configuration branch.
      deprecated: false
      responses:
        "200":
          description: CurrentBranchResult object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CurrentBranchResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /version/diff:
    get:
      operationId: getVersionDiff
      tags:
        - versioning
      x-speakeasy-group: versions.commits
      x-speakeasy-name-override: diff
      summary: Get the diff for a commit
      description: Get the diff for a commit. Default is the latest commit (HEAD).
      deprecated: false
      responses:
        "200":
          description: a list of GitDiffResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitDiffResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: commit
          in: query
          required: false
          schema:
            type: string
          description: The Git commit hash to get the diff for.
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            diff for.
        - name: filename
          in: query
          required: false
          schema:
            type: string
          description: The relative path of the file to get the diff for.
        - name: diffLineLimit
          in: query
          required: false
          schema:
            type: number
          description: Number of lines of the diff to return. Default is 1000. Set to
            <code>0</code> to return the full diff, regardless of the number of
            lines.
  /version/files:
    get:
      operationId: getVersionFiles
      tags:
        - versioning
      x-speakeasy-group: versions.commits.files
      x-speakeasy-name-override: list
      summary: Get the names and statuses of files that changed since a commit
      description: Get the names and statuses of files that changed since a commit.
        Default is the latest commit (HEAD).
      deprecated: false
      responses:
        "200":
          description: a list of GitFilesResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitFilesResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get file
            names and status for.
        - name: ID
          in: query
          required: false
          schema:
            type: string
          description: The Git commit hash to use as the starting point for the request.
  /version/info:
    get:
      operationId: getVersionInfo
      tags:
        - versioning
      x-speakeasy-group: versions.configs
      x-speakeasy-name-override: get
      summary: Get the configuration and status for the Git integration
      description: Get the configuration and versioning status for the Git integration
        for the Cribl configuration.
      deprecated: false
      responses:
        "200":
          description: a list of GitInfo objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitInfo"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /version:
    get:
      operationId: getVersion
      tags:
        - versioning
      x-speakeasy-group: versions.commits
      x-speakeasy-name-override: list
      summary: List the commit history
      description: List the commit history.</br></br>Analogous to <code>git log</code>
        for the Cribl configuration, allowing you to audit and review changes
        over time.
      deprecated: false
      responses:
        "200":
          description: a list of GitLogResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitLogResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            commit history for.
        - name: count
          in: query
          required: false
          schema:
            type: number
          description: Maximum number of commits to return in the response for this request.
  /version/push:
    post:
      operationId: createVersionPush
      tags:
        - versioning
      x-speakeasy-group: versions.commits
      x-speakeasy-name-override: push
      summary: Push local commits to the remote repository
      description: Push all local commits from the local repository to the remote
        repository.
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /version/revert:
    post:
      operationId: createVersionRevert
      tags:
        - versioning
      x-speakeasy-group: versions.commits
      x-speakeasy-name-override: revert
      summary: Revert a commit in the local repository
      description: Revert a commit in the local repository.
      deprecated: false
      responses:
        "200":
          description: a list of GitRevertResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitRevertResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: GitRevertParams object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GitRevertParams"
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to revert the
            commit for. Required in Distributed deployments. Omit in
            Single-instance deployments.
  /version/show:
    get:
      operationId: getVersionShow
      tags:
        - versioning
      x-speakeasy-group: versions.commits
      x-speakeasy-name-override: get
      summary: Get the diff and log message for a commit
      description: Get the diff and log message for a commit. Default is the latest
        commit (HEAD).
      deprecated: false
      responses:
        "200":
          description: a list of GitShowResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitShowResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: commit
          in: query
          required: false
          schema:
            type: string
          description: The Git commit hash to retrieve the diff and log message for.
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            diff and log message for.
        - name: filename
          in: query
          required: false
          schema:
            type: string
          description: The relative path of the file to get the diff and log message for.
        - name: diffLineLimit
          in: query
          required: false
          schema:
            type: number
          description: Number of lines of the diff to return. Default is 1000. Set to
            <code>0</code> to return the full diff, regardless of the number of
            lines.
  /version/status:
    get:
      operationId: getVersionStatus
      tags:
        - versioning
      x-speakeasy-group: versions.statuses
      x-speakeasy-name-override: get
      summary: Get the status of the current working tree
      description: Get the status of the current working tree of the Git repository
        used for Cribl configuration. The response includes details about
        modified, staged, untracked, and conflicted files, as well as branch and
        remote tracking information.
      deprecated: false
      responses:
        "200":
          description: a list of GitStatusResult objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/GitStatusResult"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            status for.
  /version/sync:
    post:
      operationId: createVersionSync
      tags:
        - versioning
      x-speakeasy-group: versions
      summary: Synchronize the local branch with the remote repository
      description: Synchronize the local branch with the remote repository. Any merge
        conflicts indicated in the response must be resolved using Git.
      deprecated: false
      responses:
        "200":
          description: a list of any objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /version/undo:
    post:
      operationId: createVersionUndo
      tags:
        - versioning
      x-speakeasy-group: versions.commits
      x-speakeasy-name-override: undo
      summary: Discard uncommitted (staged) changes
      description: Discard all uncommitted (staged) configuration changes, resetting
        the working directory to the last committed state. Use only if you are
        certain that you do not need to preserve your local changes.
      deprecated: false
      responses:
        "200":
          description: a list of object objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to undo the
            uncommited changes for.
  /ai/settings/features/{feature}:
    get:
      operationId: getAiSettingsFeaturesByFeature
      tags:
        - ai-settings
      summary: Returns setting for a specific feature
      description: Returns setting for a specific feature
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: feature
          in: path
          required: true
          schema:
            type: string
          description: Feature name to get settings for
    post:
      operationId: createAiSettingsFeaturesByFeature
      tags:
        - ai-settings
      summary: Updates setting for a specific feature
      description: Updates setting for a specific feature
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: feature
          in: path
          required: true
          schema:
            type: string
          description: Feature name to update settings for
  /ai/settings/features:
    get:
      operationId: getAiSettingsFeatures
      tags:
        - ai-settings
      summary: Returns all feature settings
      description: Returns all feature settings
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createAiSettingsFeatures
      tags:
        - ai-settings
      summary: Updates all AI settings at once
      description: Updates all AI settings at once
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /ai/consent:
    get:
      operationId: getAiConsent
      tags:
        - consent
      summary: Fetches the AI consent information, specifically the org GUID and
        accepted boolean.
      description: Fetches the AI consent information, specifically the org GUID and
        accepted boolean.
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createAiConsent
      tags:
        - consent
      summary: Stores the AI consent information, specifically the org GUID and
        accepted boolean.
      description: Stores the AI consent information, specifically the org GUID and
        accepted boolean.
      deprecated: false
      responses:
        "200":
          description: a list of Response objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/event-breaker-preview:
    post:
      operationId: createSearchEventBreakerPreview
      tags:
        - search
      summary: Runs an event breaker rule on the specified data
      description: Runs an event breaker rule on the specified data
      deprecated: false
      responses:
        "200":
          description: a list of PreviewResponseBody objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PreviewResponseBody"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: DatatypePreviewRequestBody object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DatatypePreviewRequestBody"
  /search/docs:
    get:
      operationId: getSearchDocs
      tags:
        - search
      summary: Get Search documentation
      description: Get Search documentation
      deprecated: false
      responses:
        "200":
          description: string object
          content:
            application/json:
              schema:
                type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/healthcheck:
    get:
      operationId: getSearchHealthcheck
      tags:
        - search
      summary: Get health check metric for search
      description: Get health check metric for search
      deprecated: false
      responses:
        "200":
          description: a list of SearchHealthCheckStatus objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/SearchHealthCheckStatus"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/jobs/{id}/metrics:
    get:
      operationId: getSearchJobsMetricsById
      tags:
        - search
      summary: Get search job metrics
      description: Get search job metrics
      deprecated: false
      responses:
        "200":
          description: string object
          content:
            application/json:
              schema:
                type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /search/job-metrics:
    get:
      operationId: getSearchJobMetrics
      tags:
        - search
      summary: List metrics for all search jobs
      description: List metrics for all search jobs
      deprecated: false
      responses:
        "200":
          description: string object
          content:
            application/json:
              schema:
                type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/preview:
    post:
      operationId: createSearchPreview
      tags:
        - search
      summary: Applies a query snippet on a set of input events for preview
      description: Applies a query snippet on a set of input events for preview
      deprecated: false
      responses:
        "200":
          description: a list of PreviewResponseBody objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/PreviewResponseBody"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: PreviewRequestBody object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PreviewRequestBody"
  /search/query:
    get:
      operationId: getSearchQuery
      tags:
        - query
      summary: Runs the query and returns the results
      description: Runs the query and returns the results
      deprecated: false
      responses:
        "200":
          description: SearchResultsResults for the Search /results and /results-poll
            endpoints. object
          content:
            application/x-ndjson:
              schema:
                $ref: "#/components/schemas/SearchJobResults"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: queryId
          in: query
          required: false
          schema:
            type: string
          description: Saved query ID
        - name: jobId
          in: query
          required: false
          schema:
            type: string
          description: Job ID
        - name: query
          in: query
          required: false
          schema:
            type: string
          description: Search query string
        - name: earliest
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: number
          description: Beginning of query time range, inclusive, in a relative time format
            or seconds
        - name: latest
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: number
          description: End of query time range, exclusive, in a relative time format or
            seconds
        - name: sampleRate
          in: query
          required: false
          schema:
            type: number
          description: Number between 0-1 to sample events during search
        - name: force
          in: query
          required: false
          schema:
            type: boolean
          description: When true, forces to run the scheduled query
        - name: offset
          in: query
          required: false
          schema:
            type: number
          description: Pagination offset
        - name: limit
          in: query
          required: false
          schema:
            type: number
          description: Pagination limit - maximum number of events to return
  /search/ui-metrics:
    post:
      operationId: createSearchUiMetrics
      tags:
        - search
      summary: Send metric events from the UI endpoint
      description: Send metric events from the UI endpoint
      deprecated: false
      responses:
        "200":
          description: string object
          content:
            application/json:
              schema:
                type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/trust-policies:
    get:
      operationId: listTrustPolicy
      x-speakeasy-name-override: list
      tags:
        - trust-policies
      summary: Get a list of TrustPolicy objects
      description: Get a list of TrustPolicy objects
      responses:
        "200":
          description: a list of TrustPolicy objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/TrustPolicy"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /search/trust-policies/{id}: {}
  /search/datasets/{id}/datasetStats:
    get:
      operationId: getSearchDatasetsDatasetStatsById
      tags:
        - datasets
      summary: Get dataset statistics
      description: Get dataset statistics
      deprecated: false
      responses:
        "200":
          description: DatasetStatsResponse object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DatasetStatsResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: dataset id
        - name: startTime
          in: query
          required: true
          schema:
            type: number
          description: start time (in ms)
        - name: endTime
          in: query
          required: true
          schema:
            type: number
          description: end time (in ms)
        - name: granularity
          in: query
          required: true
          schema:
            type: number
          description: time-bucket size (in hours)
  /search/datasets/{id}/usageStats:
    get:
      operationId: getSearchDatasetsUsageStatsById
      tags:
        - datasets
      summary: Get dataset usage statistics
      description: Get dataset usage statistics
      deprecated: false
      responses:
        "200":
          description: DatasetUsageStatsResponse object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DatasetUsageStatsResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: dataset id
        - name: endTime
          in: query
          required: false
          schema:
            type: number
          description: end time in ms, default is current time
        - name: timeWindow
          in: query
          required: false
          schema:
            type: number
          description: time window in hours, default is 24
  /search/datasets/{id}/fieldStats:
    get:
      operationId: getSearchDatasetsFieldStatsById
      tags:
        - datasets
      summary: Get field statistics
      description: Get field statistics
      deprecated: false
      responses:
        "200":
          description: FieldStatsResponse object
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FieldStatsResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: dataset id
        - name: startTime
          in: query
          required: true
          schema:
            type: number
          description: start time (in ms)
        - name: endTime
          in: query
          required: true
          schema:
            type: number
          description: end time (in ms)
        - name: granularity
          in: query
          required: true
          schema:
            type: number
          description: time-bucket size (in hours)
  /search/jobs/{id}/diag:
    get:
      operationId: getSearchJobsDiagById
      tags:
        - search
      summary: Get full search job data
      description: Get full search job data
      deprecated: false
      responses:
        "200":
          description: string object
          content:
            application/json:
              schema:
                type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
  /search/jobs/{id}/logs/{filename}:
    get:
      operationId: getSearchJobsLogsByIdAndFilename
      tags:
        - search
      summary: Get the contents of a log file
      description: Get the contents of a log file
      deprecated: false
      responses:
        "200":
          description: string object
          content:
            application/json:
              schema:
                type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
        - name: filename
          in: path
          required: true
          schema:
            type: string
          description: name of the log file to get
  /search/jobs/{id}/stages/{stageId}/results:
    get:
      operationId: getSearchJobsStagesResultsByIdAndStageId
      tags:
        - search
      summary: List search results for a given stage. Note that this cannot be the
        root stage!
      description: List search results for a given stage. Note that this cannot be the
        root stage!
      deprecated: false
      responses:
        "200":
          description: string object
          content:
            application/json:
              schema:
                type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job ID
        - name: stageId
          in: path
          required: true
          schema:
            type: string
          description: id of the search job stage
  /search/jobs/{id}/results:
    get:
      operationId: getSearchJobsResultsById
      tags:
        - search
      summary: List search results, when lower/upper bound is provided, offset is
        relative to the time range.
      description: List search results, when lower/upper bound is provided, offset is
        relative to the time range.
      deprecated: false
      responses:
        "200":
          description: SearchResultsResults for the Search /results and /results-poll
            endpoints. object
          content:
            application/x-ndjson:
              schema:
                $ref: "#/components/schemas/SearchJobResults"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
        - name: limit
          in: query
          required: false
          schema:
            type: number
          description: maximum number of events returned
        - name: offset
          in: query
          required: false
          schema:
            type: number
          description: starting offset of the events
        - name: lowerBound
          in: query
          required: false
          schema:
            type: number
          description: lower bound of the time range, inclusive
        - name: upperBound
          in: query
          required: false
          schema:
            type: number
          description: upper bound of the time range, exclusive
  /search/jobs/{id}/results-poll:
    get:
      operationId: getSearchJobsResultsPollById
      tags:
        - search
      summary: List search results
      description: List search results
      deprecated: false
      responses:
        "200":
          description: SearchResultsResults for the Search /results and /results-poll
            endpoints. object
          content:
            application/x-ndjson:
              schema:
                $ref: "#/components/schemas/SearchJobResults"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: search job id
        - name: limit
          in: query
          required: false
          schema:
            type: number
          description: maximum number of events returned
        - name: offset
          in: query
          required: false
          schema:
            type: number
          description: starting offset of the events
        - name: lowerBound
          in: query
          required: false
          schema:
            type: number
          description: lower bound of the time range, inclusive
        - name: upperBound
          in: query
          required: false
          schema:
            type: number
          description: upper bound of the time range, exclusive
        - name: lastJobStatus
          in: query
          required: false
          schema:
            type: string
          description: last known status of the Search Job. Used to return immediatelyupon
            status change if the status was queued.
  /edge/containers/{id}:
    get:
      operationId: getEdgeContainersById
      tags:
        - edgeContainers
      summary: Get details for a single container on the edge host. Add stream=true to
        get a stream instead.
      description: Get details for a single container on the edge host. Add
        stream=true to get a stream instead.
      deprecated: false
      responses:
        "200":
          description: a list of Container objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Container"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID
  /edge/containers:
    get:
      operationId: getEdgeContainers
      tags:
        - edgeContainers
      summary: Get a detailed list of containers running on the edge host.
      description: Get a detailed list of containers running on the edge host.
      deprecated: false
      responses:
        "200":
          description: a list of Container objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Container"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /edge/logs:
    get:
      operationId: getEdgeLogs
      tags:
        - edge
      summary: list log files
      description: list log files
      deprecated: false
      responses:
        "200":
          description: a list of EdgeFile objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/EdgeFile"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: mode
          in: query
          required: false
          schema:
            type: string
          description: Discovery Mode (default is "auto")
        - name: allow
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
          description: List of allowed-filename wildcard patterns
        - name: path
          in: query
          required: false
          schema:
            type: string
          description: Search directory for "manual" mode
        - name: depth
          in: query
          required: false
          schema:
            type: number
          description: Search depth for "manual" mode
  /edge/processes/{pid}:
    get:
      operationId: getEdgeProcessesByPid
      tags:
        - edgeProcesses
      summary: Get details of a process running on the edge host
      description: Get details of a process running on the edge host
      deprecated: false
      responses:
        "200":
          description: a list of Process objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Process"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: pid
          in: path
          required: true
          schema:
            type: string
          description: PID of the process
  /edge/processes:
    get:
      operationId: getEdgeProcesses
      tags:
        - edgeProcesses
      summary: Get a detailed list of processes running on the edge host
      description: Get a detailed list of processes running on the edge host
      deprecated: false
      responses:
        "200":
          description: a list of Process objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Process"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /functions:
    get:
      operationId: listFunction
      x-speakeasy-name-override: list
      tags:
        - functions
      summary: Get a list of Function objects
      description: Get a list of Function objects
      responses:
        "200":
          description: a list of Function objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Function"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /functions/{id}:
    get:
      operationId: getFunctionById
      x-speakeasy-name-override: get
      tags:
        - functions
      summary: Get Function by ID
      description: Get Function by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Function objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Function"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /p/{pack}/functions:
    get:
      operationId: getFunctionByPack
      x-speakeasy-name-override: list
      tags:
        - functions
      summary: Get a list of Function objects within a Pack
      description: Get a list of Function objects within the specified Pack.
      responses:
        "200":
          description: a list of Function objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Function"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.functions
      parameters:
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
  /p/{pack}/functions/{id}:
    get:
      operationId: getFunctionByPackAndId
      x-speakeasy-name-override: get
      tags:
        - functions
      summary: Get Function by ID within a Pack
      description: Get Function by ID within the specified Pack.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
        - name: pack
          in: path
          required: true
          schema:
            type: string
          description: pack ID to GET
      responses:
        "200":
          description: a list of Function objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Function"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: packs.functions
  /collectors:
    get:
      operationId: getCollectors
      tags:
        - collectors
      x-speakeasy-group: collectors
      summary: List all Collectors
      description: List all collectors
      deprecated: false
      responses:
        "200":
          description: a list of Collector objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Collector"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: scope
          in: query
          required: false
          schema:
            type: string
          description: Pass "scope=pack" to include only pack-enabled collectors
  /executors:
    get:
      operationId: listExecutor
      x-speakeasy-name-override: list
      tags:
        - executors
      summary: Get a list of Executor objects
      description: Get a list of Executor objects
      responses:
        "200":
          description: a list of Executor objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Executor"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /executors/{id}:
    get:
      operationId: getExecutorById
      x-speakeasy-name-override: get
      tags:
        - executors
      summary: Get Executor by ID
      description: Get Executor by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Executor objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Executor"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/projects:
    get:
      operationId: listProject
      x-speakeasy-name-override: list
      tags:
        - projects
      summary: Get a list of Project objects
      description: Get a list of Project objects
      responses:
        "200":
          description: a list of Project objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProjectConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createProject
      x-speakeasy-name-override: create
      tags:
        - projects
      summary: Create Project
      description: Create Project
      requestBody:
        description: New Project object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProjectConfig"
      responses:
        "200":
          description: a list of Project objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProjectConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/projects/{id}:
    get:
      operationId: getProjectById
      x-speakeasy-name-override: get
      tags:
        - projects
      summary: Get Project by ID
      description: Get Project by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Project objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProjectConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateProjectById
      x-speakeasy-name-override: update
      tags:
        - projects
      summary: Update Project
      description: Update Project
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: Project object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProjectConfig"
      responses:
        "200":
          description: a list of Project objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProjectConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteProjectById
      x-speakeasy-name-override: delete
      tags:
        - projects
      summary: Delete Project
      description: Delete Project
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of Project objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProjectConfig"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /system/projects/{id}/acl:
    get:
      operationId: getProjectAclById
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Get
      description: List accesses to Project granted to users
      summary: Get Project ACL
      tags:
        - projects
  /system/projects/{id}/acl/apply:
    post:
      operationId: createProjectAclApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Create
      description: Add/remove accesses to Project for users
      summary: Modify Project ACL
      tags:
        - projects
  /system/projects/{id}/acl/teams:
    get:
      operationId: getProjectAclTeamsById
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Get
      description: List accesses to Project granted to Teams
      summary: Get Project Teams
      tags:
        - projects
  /system/projects/{id}/acl/teams/apply:
    post:
      operationId: createProjectAclTeamsApplyById
      requestBody:
        description: AccessControlSchema object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccessControlSchema"
      responses:
        "200":
          description: N/A
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID for ACL Teams Create
      description: Add/remove accesses to Project for Teams
      summary: Modify Project Teams ACL
      tags:
        - projects
  /system/projects/{projectId}/destinations:
    get:
      operationId: getProjectDestinationsByProjectId
      tags:
        - projects
      summary: Lists destinations associated with this project.
      description: Lists destinations associated with this project.
      deprecated: false
      responses:
        "200":
          description: a list of ProjectDestination objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ProjectDestination"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project Id
  /system/subscriptions:
    get:
      operationId: listSubscription
      x-speakeasy-name-override: list
      tags:
        - subscriptions
      summary: Get a list of Subscription objects
      description: Get a list of Subscription objects
      responses:
        "200":
          description: a list of Subscription objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Subscription"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      operationId: createSubscription
      x-speakeasy-name-override: create
      tags:
        - subscriptions
      summary: Create subscription
      description: Create subscription
      requestBody:
        description: New Subscription object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Subscription"
      responses:
        "200":
          description: a list of Subscription objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Subscription"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/subscriptions/{id}:
    get:
      operationId: getSubscriptionById
      x-speakeasy-name-override: get
      tags:
        - subscriptions
      summary: Get Subscription by ID
      description: Get Subscription by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of Subscription objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Subscription"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateSubscriptionById
      x-speakeasy-name-override: update
      tags:
        - subscriptions
      summary: Update subscription
      description: Update subscription
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Subscription ID
      requestBody:
        description: Subscription object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Subscription"
      responses:
        "200":
          description: a list of Subscription objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Subscription"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
    delete:
      operationId: deleteSubscriptionById
      x-speakeasy-name-override: delete
      tags:
        - subscriptions
      summary: Delete subscription
      description: Delete subscription
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Subscription ID
      responses:
        "200":
          description: a list of Subscription objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Subscription"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
  /system/projects/{projectId}/subscriptions:
    get:
      operationId: getSubscriptionByProjectId
      tags:
        - subscriptions
      summary: Get the subscriptions associated with the project
      description: Get the subscriptions associated with the project
      deprecated: false
      responses:
        "200":
          description: a list of Subscription objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/Subscription"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project Id
  /master/workers:
    get:
      operationId: listMasterWorkerEntry
      x-speakeasy-name-override: list
      tags:
        - workers
      summary: Get detailed metadata for Worker and Edge Nodes
      description: Get detailed metadata for Worker and Edge Nodes.
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: nodes
      deprecated: false
      parameters:
        - name: filterExp
          in: query
          required: false
          schema:
            type: string
          description: Filter expression to evaluate against Nodes for inclusion in the
            response.
        - name: sortExp
          in: query
          required: false
          schema:
            type: string
          description: Sorting expression to evaluate against Nodes to specify the sort
            order for the response.
        - name: filter
          in: query
          required: false
          schema:
            type: string
          description: JSON-stringified filter object to evaluate against Nodes for
            inclusion in the response.
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: JSON-stringified sorting object to evaluate against Nodes to
            specify the sort order for the response.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of Nodes to return in the response for this request.
            Use with <code>offset</code> to paginate the response into
            manageable batches.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
          description: Starting point from which to retrieve results for this request. Use
            with <code>limit</code> to paginate the response into manageable
            batches.
    post:
      operationId: createMasterWorkerEntry
      x-speakeasy-name-override: create
      tags:
        - workers
      summary: Create MasterWorkerEntry
      description: Create MasterWorkerEntry
      requestBody:
        description: New MasterWorkerEntry object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MasterWorkerEntry"
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /master/workers/{id}:
    get:
      operationId: getMasterWorkerEntryById
      x-speakeasy-name-override: get
      tags:
        - workers
      summary: Get MasterWorkerEntry by ID
      description: Get MasterWorkerEntry by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateMasterWorkerEntryById
      x-speakeasy-name-override: update
      tags:
        - workers
      summary: Update MasterWorkerEntry
      description: Update MasterWorkerEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: MasterWorkerEntry object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MasterWorkerEntry"
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteMasterWorkerEntryById
      x-speakeasy-name-override: delete
      tags:
        - workers
      summary: Delete MasterWorkerEntry
      description: Delete MasterWorkerEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /master/summary/workers:
    get:
      operationId: getMasterWorkerEntry
      tags:
        - workers
      x-speakeasy-group: nodes
      x-speakeasy-name-override: count
      summary: Get a count of Worker and Edge Nodes
      description: Get a count of all Worker and Edge Nodes.
      deprecated: false
      responses:
        "200":
          description: a list of number objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: number
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: filterExp
          in: query
          required: false
          schema:
            type: string
          description: Filter expression to evaluate against Nodes for inclusion in the
            response.
  /master/workers/restart:
    patch:
      operationId: updateMasterWorkerEntry
      tags:
        - workers
      x-speakeasy-group: nodes
      x-speakeasy-name-override: restart
      summary: Restart Worker and Edge Nodes
      description: restarts worker nodes
      deprecated: false
      responses:
        "200":
          description: a list of RestartResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RestartResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /master/outposts:
    get:
      operationId: listOutposts
      x-speakeasy-name-override: list
      tags:
        - outpost
      summary: Retrieve detailed metadata for Outpost Nodes
      description: get Outpost nodes
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      deprecated: false
      parameters:
        - name: filter
          in: query
          required: false
          schema:
            type: string
          description: Filter object (JSON stringified) to select nodes
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: Sorting object (JSON stringified) expression evaluated against nodes
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of nodes to return
        - name: offset
          in: query
          required: false
          schema:
            type: integer
          description: Pagination offset
        - name: filterExp
          in: query
          required: false
          schema:
            type: string
          description: Filter expression evaluated against nodes (deprecated, use filter
            instead)
        - name: sortExp
          in: query
          required: false
          schema:
            type: string
          description: Sorting expression evaluated against nodes (deprecated, use sort
            instead)
    post:
      operationId: createOutposts
      x-speakeasy-name-override: create
      tags:
        - outpost
      summary: Create MasterWorkerEntry
      description: Create MasterWorkerEntry
      requestBody:
        description: New MasterWorkerEntry object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MasterWorkerEntry"
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /master/outposts/{id}:
    get:
      operationId: getOutpostsById
      x-speakeasy-name-override: get
      tags:
        - outpost
      summary: Get MasterWorkerEntry by ID
      description: Get MasterWorkerEntry by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to GET
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    patch:
      operationId: updateOutpostsById
      x-speakeasy-name-override: update
      tags:
        - outpost
      summary: Update MasterWorkerEntry
      description: Update MasterWorkerEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to PATCH
      requestBody:
        description: MasterWorkerEntry object to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MasterWorkerEntry"
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      operationId: deleteOutpostsById
      x-speakeasy-name-override: delete
      tags:
        - outpost
      summary: Delete MasterWorkerEntry
      description: Delete MasterWorkerEntry
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique ID to DELETE
      responses:
        "200":
          description: a list of MasterWorkerEntry objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MasterWorkerEntry"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /master/outposts/restart:
    patch:
      operationId: updateOutpostsRestart
      tags:
        - outpost
      summary: Restart Outpost Nodes
      description: restarts outpost nodes
      deprecated: false
      responses:
        "200":
          description: a list of RestartResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RestartResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /master/outposts/upgrade:
    patch:
      operationId: updateOutpostsUpgrade
      tags:
        - outpost
      summary: Upgrade Outpost Nodes
      description: upgrades outpost nodes
      deprecated: true
      responses:
        "200":
          description: a list of OutpostUpgradeResponse objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/OutpostUpgradeResponse"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /admin/products/{product}/mappings/activate:
    post:
      operationId: createAdminProductsMappingsActivateByProduct
      tags:
        - mappings
      x-speakeasy-group: groups.mappings
      x-speakeasy-name-override: activate
      summary: Set a Mapping Ruleset as the active configuration for the specified
        Cribl product
      description: Set a specific Mapping Ruleset as the currently active
        configuration for the specified Cribl product.
      deprecated: false
      responses:
        "200":
          description: The <code>id</code> of the Mapping Ruleset that has been
            successfully activated
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/RulesetId"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: RulesetId object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RulesetId"
            examples:
              MappingRulesetActivateExamplesActivate:
                $ref: "#/components/examples/MappingRulesetActivateExamplesActivate"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to activate the Mapping Ruleset for
  /admin/products/{product}/mappings:
    post:
      operationId: createAdminProductsMappingsByProduct
      tags:
        - mappings
      x-speakeasy-group: groups.mappings
      x-speakeasy-name-override: create
      summary: Create a new Mapping Ruleset for the specified Cribl product
      description: Create and save a new Mapping Ruleset for the specified Cribl product.
      deprecated: false
      responses:
        "200":
          description: A list containing the newly created Mapping Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MappingRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: MappingRuleset object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MappingRuleset"
            examples:
              MappingRulesetCreateExamplesOSBasedMapping:
                $ref: "#/components/examples/MappingRulesetCreateExamplesOSBasedMapping"
              MappingRulesetCreateExamplesTagBasedMapping:
                $ref: "#/components/examples/MappingRulesetCreateExamplesTagBasedMapping"
              MappingRulesetCreateExamplesOutpostBasedMapping:
                $ref: "#/components/examples/MappingRulesetCreateExamplesOutpostBasedMapping"
              MappingRulesetCreateExamplesComplexMapping:
                $ref: "#/components/examples/MappingRulesetCreateExamplesComplexMapping"
              MappingRulesetCreateExamplesAWSEC2InstanceMapping:
                $ref: "#/components/examples/MappingRulesetCreateExamplesAWSEC2InstanceMapping"
              MappingRulesetCreateExamplesContainerBasedMapping:
                $ref: "#/components/examples/MappingRulesetCreateExamplesContainerBasedMapping"
              MappingRulesetCreateExamplesDefaultRuleset:
                $ref: "#/components/examples/MappingRulesetCreateExamplesDefaultRuleset"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to create the Mapping Ruleset for
    get:
      operationId: getAdminProductsMappingsByProduct
      tags:
        - mappings
      x-speakeasy-group: groups.mappings
      x-speakeasy-name-override: list
      summary: List all Mapping Rulesets for the specified Cribl product
      description: Retrieve a list of all existing Mapping Rulesets for the specified
        Cribl product.
      deprecated: false
      responses:
        "200":
          description: a list of MappingRuleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MappingRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to list the Mapping Rulesets for
  /admin/products/{product}/mappings/{id}:
    delete:
      operationId: deleteAdminProductsMappingsByProductAndId
      tags:
        - mappings
      x-speakeasy-group: groups.mappings
      x-speakeasy-name-override: delete
      summary: Delete the specified Mapping Ruleset from the Worker Group or Edge Fleet
      description: Permanently remove the specified Mapping Ruleset from the Worker
        Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: A list containing the deleted Mapping Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MappingRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to delete the Mapping Ruleset for
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Mapping Ruleset to delete.
    get:
      operationId: getAdminProductsMappingsByProductAndId
      tags:
        - mappings
      x-speakeasy-group: groups.mappings
      x-speakeasy-name-override: get
      summary: Retrieve a Specific Mapping Ruleset
      description: Get the details for a single Mapping Ruleset, identified by its id,
        for a Worker Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of MappingRuleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MappingRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Mappings for
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet Mapping
            Ruleset to get
    patch:
      operationId: updateAdminProductsMappingsByProductAndId
      tags:
        - mappings
      x-speakeasy-group: groups.mappings
      x-speakeasy-name-override: update
      summary: Update an existing Mapping Ruleset for a Worker Group or Edge Fleet
      description: Modify the configuration of the specified Mapping Ruleset for a
        Worker Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: A list containing the updated Mapping Ruleset objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/MappingRuleset"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: MappingRuleset object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MappingRuleset"
            examples:
              MappingRulesetUpdateExamplesUpdateComplexRule:
                $ref: "#/components/examples/MappingRulesetUpdateExamplesUpdateComplexRule"
              MappingRulesetUpdateExamplesEnableDisabledRule:
                $ref: "#/components/examples/MappingRulesetUpdateExamplesEnableDisabledRule"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to update the Mapping Ruleset for
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Mapping Ruleset to update.
  /products/{product}/groups:
    get:
      operationId: listConfigGroupByProduct
      x-speakeasy-name-override: list
      tags:
        - groups
      summary: List all Worker Groups or Edge Fleets for the specified Cribl product
      description: Get a list of all Worker Groups or Edge Fleets for the specified
        Cribl product.
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: groups
      deprecated: false
      parameters:
        - name: fields
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated list of additional properties to include in the
            response. Available values are <code>git.commit</code>,
            <code>git.localChanges</code>, and <code>git.log</code>.
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Groups or Edge Fleets
            for.
    post:
      operationId: createConfigGroupByProduct
      x-speakeasy-name-override: create
      tags:
        - groups
      summary: Create a Worker Group or Edge Fleet for the specified Cribl product
      description: Create a new Worker Group or Edge Fleet for the specified Cribl product.
      requestBody:
        description: GroupCreateRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GroupCreateRequest"
            examples:
              CreateGroupExamplesCloudWg:
                $ref: "#/components/examples/CreateGroupExamplesCloudWg"
              CreateGroupExamplesOnPremWg:
                $ref: "#/components/examples/CreateGroupExamplesOnPremWg"
              CreateGroupExamplesCloneWg:
                $ref: "#/components/examples/CreateGroupExamplesCloneWg"
              CreateGroupExamplesEdgeFleet:
                $ref: "#/components/examples/CreateGroupExamplesEdgeFleet"
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: groups
      deprecated: false
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: required Name of the Cribl product to add the Worker Group or Edge
            Fleet to.
  /products/{product}/groups/{id}:
    get:
      operationId: getConfigGroupByProductAndId
      x-speakeasy-name-override: get
      tags:
        - groups
      summary: Get a Worker Group or Edge Fleet
      description: Get the specified Worker Group or Edge Fleet.
      parameters:
        - name: product
          in: path
          required: true
          schema:
            type: string
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Groups or Edge Fleets
            for.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get.
        - name: fields
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated list of additional properties to include in the
            response. Available values are <code>git.commit</code>,
            <code>git.localChanges</code>, and <code>git.log</code>.
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: groups
      deprecated: false
    patch:
      operationId: updateConfigGroupByProductAndId
      x-speakeasy-name-override: update
      tags:
        - groups
      summary: Update a Worker Group or Edge Fleet
      description: Update the specified Worker Group or Edge Fleet.
      parameters:
        - name: product
          in: path
          required: true
          schema:
            type: string
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Groups or Edge Fleets
            for.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to update.
      requestBody:
        description: ConfigGroup object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConfigGroup"
            examples:
              UpdateGroupExamplesScaleCloudWorkerGroup:
                $ref: "#/components/examples/UpdateGroupExamplesScaleCloudWorkerGroup"
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: groups
      deprecated: false
    delete:
      operationId: deleteConfigGroupByProductAndId
      x-speakeasy-name-override: delete
      tags:
        - groups
      summary: Delete a Worker Group or Edge Fleet
      description: Delete the specified Worker Group or Edge Fleet.
      parameters:
        - name: product
          in: path
          required: true
          schema:
            type: string
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Groups or Edge Fleets
            for.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to delete.
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-speakeasy-group: groups
      deprecated: false
  /products/{product}/groups/{id}/configVersion:
    get:
      operationId: getConfigGroupConfigVersionByProductAndId
      tags:
        - groups
      x-speakeasy-group: groups.configs.versions
      x-speakeasy-name-override: get
      summary: Get the configuration version for a Worker Group or Edge Fleet
      description: Get the configuration version for the specified Worker Group or
        Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of string objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      type: string
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Groups or Edge Fleets
            for.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            configuration version for.
  /products/{product}/groups/{id}/deploy:
    patch:
      operationId: updateConfigGroupDeployByProductAndId
      tags:
        - groups
      x-speakeasy-group: groups
      x-speakeasy-name-override: deploy
      summary: Deploy commits to a Worker Group or Edge Fleet
      description: Deploy commits to the specified Worker Group or Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of ConfigGroup objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConfigGroup"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      requestBody:
        description: DeployRequest object
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeployRequest"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Groups or Edge Fleets
            for.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the target Worker Group or Edge Fleet for
            commit deployment.
  /products/{product}/groups/{id}/acl/teams:
    get:
      operationId: getConfigGroupAclTeamsByProductAndId
      tags:
        - teams
      x-speakeasy-group: groups.acl.teams
      x-speakeasy-name-override: get
      summary: Get the Access Control List for teams with permissions on a Worker
        Group or Edge Fleet for the specified Cribl product
      description: Get the Access Control List (ACL) for teams that have permissions
        on a Worker Group or Edge Fleet for the specified Cribl product.
      deprecated: false
      responses:
        "200":
          description: a list of TeamAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/TeamAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product that contains the Worker Group or Edge
            Fleet.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            team ACL for.
        - name: type
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/RbacResource"
          description: Filter for limiting the response to ACL entries for the specified
            RBAC resource type.
  /products/{product}/groups/{id}/acl:
    get:
      operationId: getConfigGroupAclByProductAndId
      tags:
        - groups
      x-speakeasy-group: groups.acl
      x-speakeasy-name-override: get
      summary: Get the Access Control List for a Worker Group or Edge Fleet
      description: Get the Access Control List (ACL) for the specified Worker Group or
        Edge Fleet.
      deprecated: false
      responses:
        "200":
          description: a list of UserAccessControlList objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/UserAccessControlList"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Groups or Edge Fleets
            for.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            ACL for.
        - name: type
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/RbacResource"
          description: Filter for limiting the response to ACL entries for the specified
            RBAC resource type.
  /products/{product}/groups/{group}/summary:
    get:
      operationId: getProductsGroupsSummaryByProductAndGroup
      tags:
        - distributed
      x-speakeasy-group: nodes.summaries.groups
      x-speakeasy-name-override: get
      summary: Get a summary of the Distributed deployment for a specific worker group
        or fleet
      description: Get a summary of the Distributed deployment for a specific worker
        group or fleet. The response includes count of Pipelines, Routes,
        Sources, Destinations, and Worker and Edge Nodes, as well as statistics
        for the Worker and Edge Nodes.
      deprecated: false
      responses:
        "200":
          description: a list of DistributedSummary objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DistributedSummary"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ProductsCore"
          description: Name of the Cribl product to get the Worker Group or Edge Fleet
            summary for.
        - name: group
          in: path
          required: true
          schema:
            type: string
          description: The <code>id</code> of the Worker Group or Edge Fleet to get the
            summary for.
  /master/summary:
    get:
      operationId: getSummary
      tags:
        - distributed
      x-speakeasy-group: nodes.summaries
      x-speakeasy-name-override: get
      summary: Get a summary of the Distributed deployment
      description: Get a summary of the Distributed deployment. The response includes
        counts of Worker Groups, Edge Fleets, Pipelines, Routes, Sources,
        Destinations, and Worker and Edge Nodes, as well as statistics for the
        Worker and Edge Nodes.
      deprecated: false
      responses:
        "200":
          description: a list of DistributedSummary objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: number of items present in the items array
                  items:
                    type: array
                    items:
                      $ref: "#/components/schemas/DistributedSummary"
        "401":
          description: Unauthorized
        "500":
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      parameters:
        - name: mode
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/WorkerTypes"
          description: "Filter for limiting the response by Cribl product: Cribl Stream
            (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."
