openapi: 3.1.0
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.
Base URL contexts for reference:
- Leader context: /api/v1
- Worker Group or Edge Fleet context: /api/v1/m/{groupName}
- Host (Worker or Edge Node) context: /api/v1/w/{nodeId}
- Search context: /api/v1/m/default_search
version: 4.19.0-0fbd6d34
contact:
name: Support
url: https://portal.support.cribl.io
externalDocs:
description: See our complementary product documentation
url: https://docs.cribl.io
x-speakeasy-retries:
strategy: backoff
statusCodes:
- "429"
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
clientOauth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://login.cribl.cloud/oauth/token
x-speakeasy-token-endpoint-additional-properties:
audience:
type: string
example: https://api.cribl.cloud
scopes: {}
schemas:
Error:
type: object
required:
- status
- message
properties:
status:
type: string
description: Always "error" for API error responses.
const: error
message:
type: string
description: Human-readable message describing the error.
details:
description: Optional structured details about the error (e.g. validation
failures).
DiffLineDelete:
type: object
description: Deleted line in a Git diff hunk.
properties:
type:
type: string
enum:
- delete
description: Line change type. Always delete for deleted lines.
oldNumber:
type: integer
description: Line number in the original file.
content:
type: string
description: Full content of the line, including the diff prefix character.
required:
- type
- oldNumber
- content
DiffLineInsert:
type: object
description: Inserted line in a Git diff hunk.
properties:
type:
type: string
enum:
- insert
description: Line change type. Always insert for inserted lines.
newNumber:
type: integer
description: Line number in the new file.
content:
type: string
description: Full content of the line, including the diff prefix character.
required:
- type
- newNumber
- content
DiffLineContext:
type: object
description: Unchanged context line in a Git diff hunk.
properties:
type:
type: string
enum:
- context
description: Line change type. Always context for unchanged lines.
newNumber:
type: integer
description: Line number in the new file.
oldNumber:
type: integer
description: Line number in the original file.
content:
type: string
description: Full content of the line, including the diff prefix character.
required:
- type
- newNumber
- oldNumber
- content
DiffLine:
description: Array of lines in a Git diff hunk.
type: array
items:
oneOf:
- $ref: "#/components/schemas/DiffLineDelete"
- $ref: "#/components/schemas/DiffLineInsert"
- $ref: "#/components/schemas/DiffLineContext"
discriminator:
propertyName: type
mapping:
delete: "#/components/schemas/DiffLineDelete"
insert: "#/components/schemas/DiffLineInsert"
context: "#/components/schemas/DiffLineContext"
EventBreakerExistingOrNewNewTimestampTypeAuto:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsEventBreakerExistingOrNewNewTimestampTyp\
eAuto"
length:
type: number
title: Length
minimum: 2
description: Length
required:
- length
EventBreakerExistingOrNewNewTimestampTypeFormat:
type: object
properties:
type:
enum:
- format
type: string
description: Resource type identifier.
format:
type: string
title: Format
description: Format
required:
- format
EventBreakerExistingOrNewNewTimestampTypeCurrent:
type: object
properties:
type:
enum:
- current
type: string
description: Resource type identifier.
EventBreakerExistingOrNewNewRuleTypeRegex:
type: object
properties:
ruleType:
enum:
- regex
type: string
description: Discriminator value.
eventBreakerRegex:
type: string
title: Event Breaker
description: The regex used to break the stream into events at the beginning of
the match. Matched content will be consumed, unless you use a
lookahead regex such as (?=pattern) to keep it. Do NOT use capturing
groups in the pattern.
required:
- eventBreakerRegex
EventBreakerExistingOrNewNewRuleTypeJson:
type: object
properties:
ruleType:
enum:
- json
- timestamp
- aws_cloudtrail
- aws_vpcflow
- azure_flowlog
type: string
EventBreakerExistingOrNewNewRuleTypeJsonArray:
type: object
properties:
ruleType:
enum:
- json_array
type: string
description: Discriminator value.
jsonArrayField:
type: string
title: Array field
description: The path to an array in a JSON event with records to extract, such
as Records or level1.level2.events. Leave blank if result itself is
an array, such as [{...},{...}]
parentFieldsToCopy:
title: Parent fields to copy
description: Top-level fields to copy to the output events. Nested fields are
not supported. 'Array field' is always excluded. If 'Array field'
points to a nested array, the entire top-level object will be
excluded. Supports * wildcards. Enclose field names containing
special characters in single or double quotes.
type: array
items:
type: string
jsonExtractAll:
type: boolean
title: JSON extract fields
description: Automatically extract fields from JSON events. When disabled, only
_raw and _time are defined on extracted events.
fieldsToRemove:
title: Fields to remove
description: List of fields to remove from the output events. Supports *
wildcards. Enclose field names containing special characters in
single or double quotes.
type: array
items:
type: string
jsonTimeField:
type: string
title: Timestamp field
description: Optional path to timestamp field in extracted events, such as
eventTime or level1.level2.eventTime.
EventBreakerExistingOrNewNewRuleTypeHeader:
type: object
properties:
ruleType:
enum:
- header
type: string
description: Discriminator value.
delimiterRegex:
type: string
title: Field delimiter
description: Field delimiter regex
fieldsLineRegex:
type: string
title: Fields regex
description: Regex with one capturing group that captures all fields (and
delimiters) to be broken by field delimiter
headerLineRegex:
type: string
title: Header line
description: Regex matching a file header line
nullFieldVal:
type: string
title: Null value
description: Representation of a null value. Null fields are not added to events.
cleanFields:
type: boolean
title: Clean fields
description: Clean field names by replacing non [a-zA-Z0-9] characters with _
required:
- delimiterRegex
- fieldsLineRegex
- headerLineRegex
EventBreakerExistingOrNewNewRuleTypeCsv:
type: object
properties:
ruleType:
enum:
- csv
type: string
description: Discriminator value.
delimiter:
type: string
title: Delimiter
minLength: 1
description: Delimiter character to use to split values
quoteChar:
type: string
title: Quote char
minLength: 1
description: Character used to quote literal values
escapeChar:
type: string
title: Escape char
minLength: 1
description: Character used to escape the quote character in field values
timeField:
type: string
title: Timestamp field
description: Optional timestamp field name in extracted events
required:
- delimiter
- quoteChar
- escapeChar
EventBreakerExistingOrNewNew:
type: object
properties:
existingOrNew:
enum:
- new
type: string
description: Discriminator value.
ruleType:
$ref: "#/components/schemas/EventBreakerTypeOptionsEventBreakerExistingOrNewNew"
maxEventBytes:
type: number
title: Event byte limit
description: The maximum number of bytes that an event can be before being
flushed to the Pipelines
minimum: 1
maximum: 134217728
timestampAnchorRegex:
type: string
title: Timestamp anchor
description: Regex to match before attempting timestamp extraction. Use $ (end
of string anchor) to not perform extraction.
timestamp:
$ref: "#/components/schemas/TimestampFormatTypeEventBreakerExistingOrNewNew"
timestampTimezone:
type: string
title: Default timezone
description: Timezone to assign to timestamps without timezone info
timestampEarliest:
title: Earliest timestamp allowed
description: The earliest timestamp value allowed relative to now, such as
-42years. Parsed values prior to this date will be set to current
time.
type: string
timestampLatest:
title: Future timestamp allowed
description: The latest timestamp value allowed relative to now, such as
+42days. Parsed values after this date will be set to current time.
type: string
allOf:
- oneOf:
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeRegex"
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeJson"
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeJsonArray"
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeHeader"
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeCsv"
discriminator:
propertyName: ruleType
mapping:
regex: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeRegex"
json: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeJson"
json_array: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeJsonArray"
header: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeHeader"
csv: "#/components/schemas/EventBreakerExistingOrNewNewRuleTypeCsv"
EventBreakerExistingOrNewExisting:
type: object
properties:
existingOrNew:
enum:
- existing
type: string
description: Discriminator value.
existingRule:
type: string
title: Existing ruleset
description: ID of an existing event breaker ruleset to apply.
minLength: 1
NumerifyFormatFix:
type: object
properties:
format:
enum:
- fix
type: string
description: Discriminator value.
digits:
type: number
title: Digits
description: Number of digits after the decimal point, between 0 and 20. If left
blank, defaults to 2.
minimum: 0
maximum: 20
NumerifyFormatNone:
type: object
properties:
format:
enum:
- none
- floor
- ceil
type: string
RedisDeploymentTypeStandalone:
type: object
properties:
deploymentType:
enum:
- standalone
type: string
description: Discriminator value.
url:
title: Redis URL
description: "Redis URL to connect to. Format:
redis[s]://[[user][:password@]][host][:port][/db-number][?db=db-num\
ber[&password=bar[&option=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: `myBucket-${C.vars.myVar}`"
type: string
tlsOptions:
$ref: "#/components/schemas/TlsOptionsTypeRedisDeploymentTypeStandalone"
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
required:
- url
RedisDeploymentTypeCluster:
type: object
properties:
deploymentType:
enum:
- cluster
type: string
description: Discriminator value.
rootNodes:
title: Root nodes
description: Root nodes to which the cluster connection should be initiated
type: array
minItems: 1
items:
$ref: "#/components/schemas/RootNodeConfRedisDeploymentTypeCluster"
tls:
title: TLS
type: boolean
description: Use TLS for connections to this cluster
scaleReads:
$ref: "#/components/schemas/ScaleReadsOptionsRedisDeploymentTypeCluster"
tlsOptions:
$ref: "#/components/schemas/TlsOptionsTypeRedisDeploymentTypeCluster"
RedisDeploymentTypeSentinel:
type: object
properties:
deploymentType:
enum:
- sentinel
type: string
description: Discriminator value.
masterName:
title: Master group name
description: Name of the Redis Sentinel master group to connect to.
type: string
rootNodes:
title: Sentinels
description: List of sentinels to be used
type: array
minItems: 1
items:
type: object
required:
- host
- port
properties:
host:
type: string
title: Hostname
description: "Hostname of sentinel node. 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: `myBucket-${C.vars.myVar}`."
port:
type: number
title: Port
description: Port of sentinel node
tls:
title: TLS
type: boolean
description: Use TLS for connections to this cluster
tlsOptions:
$ref: "#/components/schemas/TlsOptionsTypeRedisDeploymentTypeCluster"
required:
- masterName
RedisAuthTypeNone:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
RedisAuthTypeManual:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeManual"
username:
title: Username
description: Username for Redis authentication.
type: string
password:
title: Password
description: Password for Redis authentication.
type: string
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
required:
- password
RedisAuthTypeCredentialsSecret:
type: object
properties:
authType:
enum:
- credentialsSecret
type: string
description: Discriminator value.
credentialsSecret:
type: string
title: User secret
description: Secret that references Redis username and password
required:
- credentialsSecret
RedisAuthTypeTextSecret:
type: object
properties:
authType:
enum:
- textSecret
type: string
description: Discriminator value.
textSecret:
type: string
title: Admin secret
description: Secret that references Redis admin password
required:
- textSecret
SerdeTypeAuto:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsEventBreakerExistingOrNewNewTimestampTyp\
eAuto"
tagDatatype:
type: boolean
title: Tag events with datatype and isParsed
description: Keep the detected datatype field and set isParsed to true on each
event. Enable this when events are bound for downstream Cribl Search
processing.
SerdeTypeKvp:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsSerdeTypeKvp"
srcField:
title: Source field
description: Field containing text to be parsed
type: string
dstField:
title: Destination field
description: Name of the field to add fields to. Extract mode only.
type: string
keep:
title: Fields to keep
description: List of fields to keep. Supports wildcards (*). Takes precedence
over 'Fields to remove'.
type: array
items:
type: string
remove:
title: Fields to remove
description: List of fields to remove. Supports wildcards (*). Cannot remove
fields that match 'Fields to keep'.
type: array
items:
type: string
fieldFilterExpr:
title: Fields filter expression
description: Expression evaluated against {index, name, value} context. Return
truthy to keep a field, or falsy to remove it.
type: string
cleanFields:
type: boolean
title: Clean fields
description: Clean field names by replacing non [a-zA-Z0-9] characters with _
allowedKeyChars:
type: array
items:
type: string
title: Allowed key characters
description: A list of characters that may be present in a key name, even though
they are normally separator or control characters
allowedValueChars:
type: array
items:
type: string
title: Allowed value characters
description: A list of characters that may be present in a value, even though
they are normally separator or control characters
SerdeTypeDelim:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsSerdeTypeDelim"
srcField:
title: Source field
description: Field containing text to be parsed
type: string
dstField:
title: Destination field
description: Name of the field to add fields to. Extract mode only.
type: string
fields:
title: List of fields
description: The fields to be extracted, listed in order. Will auto-generate if
empty.
type: array
items:
type: string
keep:
title: Fields to keep
description: List of fields to keep. Supports wildcards (*). Takes precedence
over 'Fields to remove'.
type: array
items:
type: string
remove:
title: Fields to remove
description: List of fields to remove. Supports wildcards (*). Cannot remove
fields that match 'Fields to keep'.
type: array
items:
type: string
fieldFilterExpr:
title: Fields filter expression
description: Expression evaluated against {index, name, value} context. Return
truthy to keep a field, or falsy to remove it.
type: string
delimChar:
type: string
title: Delimiter
minLength: 1
description: Delimiter character to use to split values
quoteChar:
type: string
title: Quote char
minLength: 1
description: Character used to quote literal values
escapeChar:
type: string
title: Escape char
minLength: 1
description: Escape character used to escape delimiter or quote character
nullValue:
type: string
title: Null value
description: Field value representing the null value. Null fields will be omitted.
SerdeTypeCsv:
type: object
properties:
type:
enum:
- csv
- elff
- clf
type: string
srcField:
title: Source field
description: Field containing text to be parsed
type: string
dstField:
title: Destination field
description: Name of the field to add fields to. Extract mode only.
type: string
fields:
title: List of fields
description: The fields to be extracted, listed in order. Will auto-generate if
empty.
type: array
items:
type: string
keep:
title: Fields to keep
description: List of fields to keep. Supports wildcards (*). Takes precedence
over 'Fields to remove'.
type: array
items:
type: string
remove:
title: Fields to remove
description: List of fields to remove. Supports wildcards (*). Cannot remove
fields that match 'Fields to keep'.
type: array
items:
type: string
fieldFilterExpr:
title: Fields filter expression
description: Expression evaluated against {index, name, value} context. Return
truthy to keep a field, or falsy to remove it.
type: string
SerdeTypeJson:
type: object
properties:
type:
enum:
- json
type: string
description: Resource type identifier.
srcField:
title: Source field
description: Field containing text to be parsed
type: string
dstField:
title: Destination field
description: Name of the field to add fields to. Extract mode only.
type: string
keep:
title: Fields to keep
description: List of fields to keep. Supports wildcards (*). Takes precedence
over 'Fields to remove'.
type: array
items:
type: string
remove:
title: Fields to remove
description: List of fields to remove. Supports wildcards (*). Cannot remove
fields that match 'Fields to keep'.
type: array
items:
type: string
fieldFilterExpr:
title: Fields filter expression
description: Expression evaluated against {index, name, value} context. Return
truthy to keep a field, or falsy to remove it.
type: string
SerdeTypeRegex:
type: object
properties:
type:
enum:
- regex
type: string
description: Resource type identifier.
srcField:
title: Source field
description: Field containing text to be parsed
type: string
dstField:
title: Destination field
description: Name of the field to add fields to. Extract mode only.
type: string
regex:
type: string
title: Regex
description: Regex literal with named capturing groups, such as (?bar), or
_NAME_ and _VALUE_ capturing groups, such as(?<_NAME_0>[^
=]+)=(?<_VALUE_0>[^,]+)
regexList:
type: array
title: Additional regex
description: Additional regex patterns to apply for field extraction.
items:
$ref: "#/components/schemas/RegexListConfSerdeTypeRegex"
iterations:
type: number
title: Max exec
description: The maximum number of times to apply regex to source field when the
global flag is set, or when using _NAME_ and _VALUE_ capturing
groups
minimum: 1
fieldNameExpression:
title: Field name format expression
description: "JavaScript expression to format field names when _NAME_n and
_VALUE_n capturing groups are used. Original field name is in global
variable 'name'. Example: To append XX to all field names, use
`${name}_XX` (backticks are literal). If empty, names will be
sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can
access other fields values via __e.."
type: string
overwrite:
type: boolean
title: Overwrite existing fields
description: Overwrite existing event fields with extracted values. If disabled,
existing fields will be converted to an array.
required:
- regex
SerdeTypeGrok:
type: object
properties:
type:
enum:
- grok
type: string
description: Resource type identifier.
srcField:
title: Source field
description: Field containing text to be parsed
type: string
dstField:
title: Destination field
description: Name of the field to add fields to. Extract mode only.
type: string
pattern:
type: string
title: Pattern
description: "Grok pattern to extract fields. Syntax supported:
%{PATTERN_NAME:FIELD_NAME}"
patternList:
type: array
title: Additional Grok patterns
description: Additional Grok patterns to apply to the source field.
items:
$ref: "#/components/schemas/PatternListConfSerdeTypeGrok"
required:
- pattern
SerializeTypeKvp:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsSerdeTypeKvp"
cleanFields:
type: boolean
title: Clean fields
description: Clean field names by replacing non-[a-zA-Z0-9] characters with _
fields:
title: Fields to serialize
description: "Required for CSV, ELFF, and CLF. All other formats support
wildcard field lists. Examples: host, myField, !source *"
type: array
items:
type: string
pairDelimiter:
type: string
title: Pair delimiter
minLength: 1
description: Delimiter used to separate key=value pairs. Defaults to a single
space character. Should not have common characters with key-value
delimiter.
keyValueDelimiter:
type: string
title: Key-Value delimiter
minLength: 1
description: Delimiter used to separate key and value in pair. Defaults to a
'='. Should not have common characters with pair delimiter.
SerializeTypeDelim:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsSerdeTypeDelim"
delimChar:
type: string
title: Delimiter
minLength: 1
description: Delimiter character to use to split values. If left blank, will
default to ','.
quoteChar:
type: string
title: Quote char
minLength: 1
description: Character used to quote literal values. If left blank, will default
to '"'.
escapeChar:
type: string
title: Escape char
minLength: 1
description: Escape character used to escape delimiter or quote character. If
left blank, will default to the Quote char.
nullValue:
type: string
title: Null value
description: Field value representing the null value. Null fields will be omitted.
SerializeTypeCsv:
type: object
properties:
type:
enum:
- csv
- elff
- clf
- json
type: string
SnmpTrapSerializeV3UserAuthProtocolNone:
type: object
properties:
authProtocol:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
SnmpTrapSerializeV3UserAuthProtocolNotNonePrivProtocolNone:
type: object
properties:
privProtocol:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
SnmpTrapSerializeV3UserAuthProtocolNotNonePrivProtocolNotNone:
type: object
properties:
privProtocol:
type: string
enum:
- des
- aes
- aes256b
- aes256r
x-speakeasy-unknown-values: allow
privKey:
type: string
title: V3 privacy key
description: V3 privacy key
required:
- privKey
SnmpTrapSerializeV3UserAuthProtocolNotNone:
type: object
properties:
authProtocol:
type: string
enum:
- md5
- sha
- sha224
- sha256
- sha384
- sha512
x-speakeasy-unknown-values: allow
authKey:
type: string
title: V3 authentication key
description: V3 authentication key
privProtocol:
$ref: "#/components/schemas/PrivacyProtocolOptionsSnmpTrapSerializeV3UserAuthPr\
otocolNotNone"
name:
title: Username
type: string
minLength: 1
description: Username
required:
- authKey
- name
allOf:
- oneOf:
- $ref: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNonePrivProto\
colNone"
- $ref: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNonePrivProto\
colNotNone"
discriminator:
propertyName: privProtocol
mapping:
none: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNonePrivProto\
colNone"
des: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNonePrivProtoc\
olNotNone"
aes: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNonePrivProtoc\
olNotNone"
aes256b: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNonePrivPr\
otocolNotNone"
aes256r: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNonePrivPr\
otocolNotNone"
FunctionConfSchemaAggregateMetrics:
type: object
properties:
passthrough:
type: boolean
title: Passthrough mode
description: Pass through the original events along with the aggregation events
preserveGroupBys:
type: boolean
title: Preserve group by fields
description: Preserve the structure of the original aggregation event's groupby
fields
sufficientStatsOnly:
type: boolean
title: Sufficient stats mode
description: Output only statistics that are sufficient for the supplied
aggregations
prefix:
type: string
title: Output prefix
description: A prefix that is prepended to all of the fields output by this
Aggregations Function
timeWindow:
pattern: \d+[sm]$
type: string
title: Time window
description: The time span of the tumbling window for aggregating events. Must
be a valid time string (such as 10s).
aggregations:
type: array
title: Aggregates
description: Combination of Aggregation function and output metric type
minItems: 1
items:
type: object
required:
- agg
- metricType
additionalProperties: false
properties:
metricType:
title: Metric type
description: The output metric type
type: string
enum:
- automatic
- counter
- distribution
- gauge
- histogram
- summary
- timer
x-speakeasy-unknown-values: allow
agg:
title: Aggregation
type: string
description: "Aggregate function to perform on events. Example:
sum(bytes).where(action=='REJECT').as(TotalBytes)"
groupbys:
type: array
title: Group by dimensions
description: "Optional: One or more dimensions to group aggregates by. Supports
wildcard expressions. Wrap dimension names in quotes if using
literal identifiers, such as 'service.name'. Warning: Using wildcard
'*' causes all dimensions in the event to be included, which can
result in high cardinality and increased memory usage. Exclude
dimensions that can result in high cardinality before using
wildcards. Example: !_time, !_numericValue, *"
items:
type: string
flushEventLimit:
type: number
title: Aggregation event limit
description: The maximum number of events to include in any given aggregation
event
minimum: 1
flushMemLimit:
type: string
title: Aggregation memory limit
description: "The memory usage limit to impose upon aggregations. Defaults to
80% of the process memory; value configured above default limit is
ignored. Accepts numerals with units like KB and MB (example:
128MB)."
pattern: ^\d+\s*(?:\w{2})?$
cumulative:
type: boolean
title: Cumulative aggregations
description: Enable to retain aggregations for cumulative aggregations when
flushing out an aggregation table event. When disabled (the
default), aggregations are reset to 0 on flush.
shouldTreatDotsAsLiterals:
type: boolean
title: Treat dots as literals
description: Treat dots in dimension names as literals. This is useful for
top-level dimensions that contain dots, such as 'service.name'.
add:
title: Evaluate fields
description: Set of key-value pairs to evaluate and add/set
type: array
items:
type: object
required:
- value
properties:
name:
type: string
title: Name
description: Name
value:
type: string
title: Value expression
description: JavaScript expression to compute the value (can be constant)
flushOnInputClose:
type: boolean
title: Flush on stream close
description: Flush aggregations when an input stream is closed. If disabled,
Time Window Settings control flush behavior.
lagTolerance:
type: string
title: Lag tolerance
description: The tumbling window tolerance to late events. Must be a valid time
string (such as 10s).
pattern: \d+[sm]$
idleTimeLimit:
type: string
title: Idle bucket time limit
description: How long to wait before flushing a bucket that has not received
events. Must be a valid time string (such as 10s).
pattern: \d+[sm]$
FunctionAggregateMetrics:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- aggregate_metrics
description: Identifier of the Function. Always aggregate_metrics
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaAggregation:
type: object
properties:
passthrough:
type: boolean
title: Passthrough mode
description: Pass through the original events along with the aggregation events
preserveGroupBys:
type: boolean
title: Preserve group by fields
description: Preserve the structure of the original aggregation event's groupby
fields
sufficientStatsOnly:
type: boolean
title: Sufficient stats mode
description: Output only statistics that are sufficient for the supplied
aggregations
metricsMode:
type: boolean
title: Metrics mode
description: Enable to output the aggregates as metrics. When disabled,
aggregates are output as events.
prefix:
type: string
title: Output prefix
description: A prefix that is prepended to all of the fields output by this
Aggregations Function
timeWindow:
pattern: \d+[sm]$
type: string
title: Time window
description: The time span of the tumbling window for aggregating events. Must
be a valid time string (such as 10s).
aggregations:
type: array
title: Aggregates
description: "Aggregate function to perform on events. Example:
sum(bytes).where(action=='REJECT').as(TotalBytes)"
minItems: 1
items:
type: string
groupbys:
type: array
title: Group by fields
description: "Optional: One or more fields to group aggregates by. Supports
wildcard expressions. Warning: Using wildcard '*' causes all fields
in the event to be included, which can result in high cardinality
and increased memory usage. Exclude fields that can result in high
cardinality before using wildcards. Example: !_time, !_numericValue,
*"
items:
type: string
flushEventLimit:
type: number
title: Aggregation event limit
description: The maximum number of events to include in any given aggregation
event
minimum: 1
flushMemLimit:
type: string
title: Aggregation memory limit
description: "The memory usage limit to impose upon aggregations. Defaults to
80% of the process memory; value configured above default limit is
ignored. Accepts numerals with units like KB and MB (example:
128MB)."
pattern: ^\d+\s*(?:\w{2})?$
cumulative:
type: boolean
title: Cumulative aggregations
description: Enable to retain aggregations for cumulative aggregations when
flushing out an aggregation table event. When disabled (the
default), aggregations are reset to 0 on flush.
searchAggMode:
type: string
title: Search-specific aggregation mode
description: Allows Cribl Search-specific aggregation configuration
add:
title: Evaluate fields
description: Set of key-value pairs to evaluate and add/set
type: array
items:
$ref: "#/components/schemas/AddConfFunctionConfSchemaAggregation"
shouldTreatDotsAsLiterals:
type: boolean
title: Treat dots as literals
description: Treat dots in dimension names as literals. This is useful for
top-level dimensions that contain dots, such as 'service.name'.
flushOnInputClose:
type: boolean
title: Flush on stream close
description: Flush aggregations when an input stream is closed. If disabled,
Time Window Settings control flush behavior.
printUndefineds:
type: boolean
title: Print undefined as null
description: When enabled (e.g. for Cribl Search), convert undefined expression
results to null so requested-but-missing fields appear in JSON
output. When disabled (default), undefined is preserved.
lagTolerance:
type: string
title: Lag tolerance
description: The tumbling window tolerance to late events. Must be a valid time
string (such as 10s).
pattern: \d+[sm]$
idleTimeLimit:
type: string
title: Idle bucket time limit
description: How long to wait before flushing a bucket that has not received
events. Must be a valid time string (such as 10s).
pattern: \d+[sm]$
FunctionAggregation:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- aggregation
description: Identifier of the Function. Always aggregation
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaAutoTimestamp:
type: object
additionalProperties: false
properties:
srcField:
title: Source field
description: Field to search for a timestamp
type: string
dstField:
title: Destination field
description: Field to place timestamp in
type: string
defaultTimezone:
type: string
title: Default timezone
description: Timezone to assign to timestamps without timezone info
timeExpression:
title: Time expression
description: Expression to use to format time. Current time, as a JavaScript
Date object, is in global `time`. You can access other fields'
values via __e..
type: string
offset:
title: Start scan offset
description: The offset into the string from which to look for a timestamp
type: number
minimum: 0
maxLen:
title: Max timestamp scan depth
description: Maximum string length at which to look for a timestamp
type: number
minimum: 1
defaultTime:
title: Default time
description: How to set the time field if no timestamp is found
type: string
enum:
- now
- last
- none
x-speakeasy-enum-descriptions:
- Current Time
- Last Event's Time
- None
x-speakeasy-unknown-values: allow
latestDateAllowed:
title: Future timestamp allowed
description: The latest timestamp value allowed relative to now, such as
+42days. Parsed values after this date will be set to the Default
time.
type: string
spacer:
type: string
description: UI layout spacer; no effect on event processing.
earliestDateAllowed:
title: Earliest timestamp allowed
description: The earliest timestamp value allowed relative to now, such as
-42years. Parsed values prior to this date will be set to the
Default time.
type: string
timestamps:
title: Additional timestamps
description: Add regex/strptime pairs to extract additional timestamp formats
type: array
items:
type: object
required:
- regex
- strptime
properties:
regex:
type: string
title: Regex
description: Regex with first capturing group matching the timestamp
strptime:
type: string
title: Strptime format
description: Select or enter strptime format for the captured timestamp
FunctionAutoTimestamp:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- auto_timestamp
description: Identifier of the Function. Always auto_timestamp
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaCef:
type: object
additionalProperties: false
properties:
outputField:
title: Output field
description: The field to which the CEF formatted event will be output
type: string
header:
title: Header Fields
description: Set of header key/value pairs
type: array
items:
type: object
required:
- value
properties:
name:
type: string
title: Name
readOnly: true
description: Name
value:
type: string
title: Value Expression
description: JavaScript expression to compute the value (can be constant)
extension:
title: Extension Fields
description: Set of extension key-value pairs
type: array
items:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
pattern: ^[a-zA-Z0-9]+$
description: Name
value:
type: string
title: Value Expression
description: JavaScript expression to compute the value (can be constant)
FunctionCef:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- cef
description: Identifier of the Function. Always cef
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaChain:
type: object
properties:
processor:
title: Processor
description: The data processor (Pack/Pipeline) to send events through
type: string
FunctionChain:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- chain
description: Identifier of the Function. Always chain
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaClone:
type: object
properties:
clones:
type: array
title: Clones
description: Create clones with the following fields set
minItems: 1
items:
type: object
title: Fields
description: Key-value pairs to set or overwrite in the clone
additionalProperties:
type: string
FunctionClone:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- clone
description: Identifier of the Function. Always clone
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaCode:
type: object
additionalProperties: false
properties:
code:
type: string
title: Code
description: "Caution: This Function will be evaluated in an unprotected
context. This means that you will be able to execute almost any
JavaScript code."
maxNumOfIterations:
type: number
title: Iteration limit
description: The maximum number of allowed iterations within this Function.
Defaults to 5,000.
minimum: 1
maximum: 100000
activeLogSampleRate:
type: number
title: Error log sample rate
description: Rate at which this Function logs errors. For example, a value of 1
logs every error, a value of 1000 (the default) logs every
thousandth error, and so on.
minimum: 1
maximum: 5000
useUniqueLogChannel:
type: boolean
title: Use unique log channel
description: Logs from this Function will be sent to a unique channel in the
form `func:code:${pipelineName}:${functionIndex}`. Disable to use
the generic `func:code` log channel instead.
FunctionCode:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- code
description: Identifier of the Function. Always code
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaComment:
type: object
properties:
comment:
type: string
title: Comment
description: Optional, short description of this Function's purpose in the
Pipeline
maxLength: 1000
FunctionComment:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- comment
description: Identifier of the Function. Always comment
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaDistinct:
type: object
title: distinct configuration
properties:
groupBy:
type: array
title: Grouping properties
description: Defines the properties that are concatenated to produce distinct key
minItems: 1
items:
type: string
maxCombinations:
type: number
description: maximum number of tracked combinations
maxDepth:
type: number
description: maximum number of groupBy properties
isFederated:
type: boolean
description: indicator that the operator runs on a federated executor
suppressPreviews:
type: boolean
title: Suppress preview results
description: Toggle this on to suppress generating previews of intermediate
results
FunctionDistinct:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- distinct
description: Identifier of the Function. Always distinct
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaDnsLookup:
type: object
additionalProperties: true
properties:
dnsLookupFields:
title: DNS lookup fields
description: List of field names on which to perform DNS lookup
type: array
items:
type: object
properties:
inFieldName:
type: string
title: Lookup field name
description: Lookup field name
resourceRecordType:
title: Resource record type
description: The DNS record type (RR) to return. Defaults to 'A'.
type: string
enum:
- A
- AAAA
- ANY
- CNAME
- MX
- NAPTR
- NS
- PTR
- SOA
- SRV
- TXT
x-speakeasy-enum-descriptions:
- A
- AAAA
- ANY
- CNAME
- MX
- NAPTR
- NS
- PTR
- SOA
- SRV
- TXT
x-speakeasy-unknown-values: allow
outFieldName:
type: string
title: Output field name
description: Name of field to add lookup results to. Leave blank to overwrite
the lookup field.
reverseLookupFields:
title: Reverse DNS lookup fields
description: List of field names on which to perform reverse DNS lookup
type: array
items:
type: object
properties:
inFieldName:
type: string
title: Lookup field name
description: Name of the field containing the IP to look up. If the field value
is not in IPv4 or IPv6 format, the lookup is skipped.
outFieldName:
type: string
title: Output field name
description: Name of field to add the resolved domain to. Leave blank to
overwrite the lookup field.
dnsServers:
title: DNS server overrides
description: "IPs, in RFC 5952 format, of the DNS servers to use for resolution.
Examples: IPv4 1.1.1.1, 4.2.2.2:53, or IPv6 [2001:4860:4860::8888],
[2001:4860:4860::8888]:1053. If not specified, system's DNS will be
used."
type: array
items:
type: string
cacheTTL:
type: number
title: Cache time to live (minutes)
description: How frequently to expire and refetch DNS cache. Use 0 to disable.
maxCacheSize:
type: number
title: Cache size limit
description: The maximum number of DNS resolutions to be cached locally. Leave
at default unless you understand the implications of changing.
maximum: 100000
useResolvConf:
title: Use /etc/resolv.conf
description: Attempt to resolve DNS short names using the search or domain
directive from /etc/resolv.conf
type: boolean
lookupFallback:
title: Fall back to DNS.lookup()
description: "If unable to resolve a DNS short name, make a DNS.lookup() call to
resolve it. Caution: This might degrade performance in unrelated
areas of @{product}."
type: boolean
domainOverrides:
title: Use search or domain fallbacks
description: Specify fallback values for the DNS resolver to use when it cannot
resolve a DNS short name
type: array
items:
type: string
title: fallback
lookupFailLogLevel:
title: Log level for failed lookups
description: Log level to use when a DNS lookup fails.
type: string
enum:
- silly
- debug
- info
- warn
- error
x-speakeasy-enum-descriptions:
- silly
- debug
- info
- warn
- error
x-speakeasy-unknown-values: allow
FunctionDnsLookup:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- dns_lookup
description: Identifier of the Function. Always dns_lookup
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaDrop:
type: object
FunctionDrop:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- drop
description: Identifier of the Function. Always drop
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaDropDimensions:
type: object
properties:
timeWindow:
pattern: \d+[sm]$
type: string
title: Aggregation time window
description: The time span of the tumbling window for aggregating events. Must
be a valid time string (such as 10s).
dropDimensions:
type: array
title: Dimensions to drop
description: "One or more dimensions to be dropped. Supports wildcard
expressions. Warning: Using wildcard '*' causes all dimensions in
the event to be dropped."
minItems: 1
items:
type: string
flushOnInputClose:
type: boolean
title: Flush on stream close
description: Flush aggregations when an input stream is closed. If disabled,
aggregations are flushed based on Time Window Settings instead.
FunctionDropDimensions:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- drop_dimensions
description: Identifier of the Function. Always drop_dimensions
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaDynamicSampling:
type: object
additionalProperties: false
properties:
mode:
title: Sample mode
type: string
description: "Defines how sample rate will be derived: log(previousPeriodCount)
or sqrt(previousPeriodCount)"
enum:
- log
- sqrt
x-speakeasy-enum-descriptions:
- Logarithmic
- Square Root
x-speakeasy-unknown-values: allow
keyExpr:
title: Sample group key
description: Expression used to derive sample group key.
Example:`${domain}:${status}`. Each sample group will have its own
derived sampling rate based on volume. Defaults to `${host}`.
type: string
samplePeriod:
title: Sample period
description: How often (in seconds) sample rates will be adjusted
type: number
minEvents:
title: Minimum events
description: Minimum number of events that must be received in previous sample
period for sampling mode to be applied to current period. If the
number of events received for a sample group is less than this
minimum, a sample rate of 1:1 is used.
type: number
maxSampleRate:
title: Sampling rate limit
description: Maximum sampling rate. If computed sampling rate is above this
value, it will be limited to this value.
type: number
minimum: 1
FunctionDynamicSampling:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- dynamic_sampling
description: Identifier of the Function. Always dynamic_sampling
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaEval:
type: object
additionalProperties: false
properties:
add:
title: Evaluate fields
description: Set of key-value pairs to evaluate and add/set
type: array
items:
type: object
required:
- value
properties:
name:
type: string
title: Name
description: Name
value:
type: string
title: Value Expression
description: JavaScript expression to compute the value (can be constant)
disabled:
type: boolean
description: Set to No to disable the evaluation of an individual expression
keep:
title: Keep fields
description: List of fields to keep. Supports * wildcards. Takes precedence over
'Remove fields'.
type: array
items:
type: string
remove:
title: Remove fields
description: List of fields to remove. Supports * wildcards. Fields that match
'Keep fields' will not be removed. Enclose field names containing
special characters in single or double quotes.
type: array
items:
type: string
printUndefineds:
type: boolean
title: Print undefined as null
description: When enabled (e.g. for Cribl Search), convert undefined expression
results to null so requested-but-missing fields appear in JSON
output. When disabled (default), undefined is preserved.
FunctionEval:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- eval
description: Identifier of the Function. Always eval
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaEventBreaker:
type: object
properties:
existingOrNew:
title: Existing or new?
description: Whether to use an existing event breaker ruleset or create a new
one inline.
type: string
enum:
- existing
- new
x-speakeasy-enum-descriptions:
- Use Existing
- Create New
x-speakeasy-unknown-values: allow
shouldMarkCriblBreaker:
type: boolean
title: Add to cribl_breaker
description: Add this Function name to the cribl_breaker field
ruleType:
$ref: "#/components/schemas/EventBreakerTypeOptionsEventBreakerExistingOrNewNew"
maxEventBytes:
type: number
title: Event byte limit
description: The maximum number of bytes that an event can be before being
flushed to the Pipelines
minimum: 1
maximum: 134217728
timestampAnchorRegex:
type: string
title: Timestamp anchor
description: Regex to match before attempting timestamp extraction. Use $ (end
of string anchor) to not perform extraction.
timestamp:
$ref: "#/components/schemas/TimestampFormatTypeEventBreakerExistingOrNewNew"
timestampTimezone:
type: string
title: Default timezone
description: Timezone to assign to timestamps without timezone info
timestampEarliest:
title: Earliest timestamp allowed
description: The earliest timestamp value allowed relative to now, such as
-42years. Parsed values prior to this date will be set to current
time.
type: string
timestampLatest:
title: Future timestamp allowed
description: The latest timestamp value allowed relative to now, such as
+42days. Parsed values after this date will be set to current time.
type: string
existingRule:
type: string
title: Existing ruleset
description: ID of an existing event breaker ruleset to apply.
minLength: 1
allOf:
- oneOf:
- $ref: "#/components/schemas/EventBreakerExistingOrNewNew"
- $ref: "#/components/schemas/EventBreakerExistingOrNewExisting"
discriminator:
propertyName: existingOrNew
mapping:
new: "#/components/schemas/EventBreakerExistingOrNewNew"
existing: "#/components/schemas/EventBreakerExistingOrNewExisting"
FunctionEventBreaker:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- event_breaker
description: Identifier of the Function. Always event_breaker
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaEventstats:
type: object
title: eventstats configuration
properties:
aggregations:
type: array
title: Aggregates
description: Aggregate function(s) to perform on events. E.g.,
sum(bytes).where(action=='REJECT').as(TotalBytes)
minItems: 1
items:
type: string
groupBys:
type: array
title: Group by fields
description: Fields to group aggregates by, supports wildcard expressions.
items:
type: string
maxEvents:
type: number
title: Maximum number of events
description: Specifies how many events are at max kept in memory to be enriched
with aggregations
flushOnInputClose:
type: boolean
title: Flush on stream close
description: Determines if aggregations should flush when an input stream is
closed. If disabled, time window settings will control flush
behavior.
FunctionEventstats:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- eventstats
description: Identifier of the Function. Always eventstats
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaExternaldata:
type: object
FunctionExternaldata:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- externaldata
description: Identifier of the Function. Always externaldata
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaFlatten:
type: object
properties:
fields:
type: array
title: Fields
description: List of top-level fields to include for flattening. Supports *
wildcards, except when used on internal fields. Defaults to empty
array, which means all fields.
items:
type: string
pattern: ^(?!__.*\*).*$
prefix:
type: string
title: Prefix
description: Prefix string for flattened field names. Defaults to empty.
depth:
type: number
title: Depth
description: Number representing the nested levels to consider for flattening.
Defaults to 5. Minimum should be 1.
minimum: 1
delimiter:
type: string
title: Delimiter
description: Delimiter to be used for flattening. Defaults to underscore.
FunctionFlatten:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- flatten
description: Identifier of the Function. Always flatten
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaFoldkeys:
type: object
properties:
deleteOriginal:
title: Delete original
description: When enabled (default), only the folded keys are kept. When
disabled, the original entries are retained alongside the folded
keys.
type: boolean
separator:
title: Separator string
description: Character or string used to separate key levels to be folded.
Defaults to the dot (.) character.
type: string
selectionRegExp:
title: Selection regular expression
description: Optional regular expression to select a subset of the keys to fold.
type: string
maxDepth:
title: Maximum depth
description: Maximum recursion depth when traversing nested objects. Prevents
infinite loops caused by cyclic references. Defaults to 20.
type: integer
minimum: 1
FunctionFoldkeys:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- foldkeys
description: Identifier of the Function. Always foldkeys
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaGenStats:
type: object
title: Gen stats configuration
additionalProperties: false
properties:
fields:
type: array
description: List of field names from which to generate statistics.
items:
type: string
FunctionGenStats:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- gen_stats
description: Identifier of the Function. Always gen_stats
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaGeoip:
type: object
additionalProperties: false
properties:
file:
type: string
title: GeoIP file (.mmdb)
description: Select an uploaded Maxmind database, or specify path to a Maxmind
database with .mmdb extension
minLength: 1
inField:
type: string
title: IP field
description: Field name in which to find an IP to look up. Can be nested.
outField:
type: string
title: Result field
description: Field name in which to store the GeoIP lookup results
additionalFields:
type: array
title: Additional fields
description: Additional IP fields on which to perform GeoIP lookups.
items:
type: object
required:
- extraInField
- extraOutField
properties:
extraInField:
type: string
title: IP Field
description: Field name in which to find an IP to look up. Can be nested.
extraOutField:
type: string
title: Result Field
description: Field name in which to store the GeoIP lookup results
outFieldMappings:
type: object
title: Output field mappings
description: Search-specific mappings for granular control over event enrichment
FunctionGeoip:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- geoip
description: Identifier of the Function. Always geoip
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaGrok:
type: object
properties:
pattern:
type: string
title: Pattern
description: "Grok pattern to extract fields. Syntax supported:
%{PATTERN_NAME:FIELD_NAME}"
patternList:
type: array
title: Additional Grok patterns
description: Additional Grok patterns to apply to the source field.
items:
$ref: "#/components/schemas/PatternListConfSerdeTypeGrok"
source:
type: string
title: Source field
description: Field on which to perform Grok extractions
FunctionGrok:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- grok
description: Identifier of the Function. Always grok
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaHandlebars:
type: object
properties:
templates:
type: array
title: Templates
description: Array of template definitions. Uses event.__template_id to select
template at runtime.
items:
type: object
title: Template definition
required:
- id
- content
- type
additionalProperties: false
properties:
id:
type: string
title: Template ID
description: Unique identifier for this template
minLength: 1
content:
type: string
title: Template content
description: Handlebars template string
minLength: 1
description:
type: string
title: Description
description: Optional description of what this template is used for
type:
type: string
title: Template type
description: Type categorization for the template (e.g., Universal, Email,
Slack)
targetField:
type: string
title: Target field
description: Field name to store the rendered template result. Defaults to _raw.
parseJson:
type: boolean
title: Parse as JSON
description: Parse the rendered template as JSON and store as an object instead
of a string. Useful for building structured data like Slack blocks.
removeOnNull:
type: boolean
title: Remove field if empty
description: Remove the target field if the rendered result is empty or null.
FunctionHandlebars:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- handlebars
description: Identifier of the Function. Always handlebars
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaJoin:
type: object
title: Join Configuration
additionalProperties: false
properties:
kind:
type: string
title: Kind
description: Join kind, e.g. inner
hints:
type: object
title: Hint
description: Hints passed to the join function
additionalProperties:
type: string
fieldConditions:
title: Join Conditions
description: Fields to use when joining
type: array
minItems: 1
items:
type: object
required:
- leftFieldName
- rightFieldName
properties:
leftFieldName:
title: Left Field Name
description: The field name to join on, on the left side.
type: string
rightFieldName:
title: Right Field Name
description: The field name on the right side of the data, i.e. the stage
results, that we are joining with
type: string
searchJobId:
title: Search Job Id
description: The id for this search job.
type: string
stageId:
title: Stage Id
description: The stage we are joining with.
type: string
FunctionJoin:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- join
description: Identifier of the Function. Always join
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaJsonUnroll:
type: object
properties:
path:
type: string
title: Path
description: Path to array to unroll, such as foo.0.bar
name:
type: string
title: New name
description: Name of each exploded array element in each new event. Leave empty
to expand the array element with its original name.
FunctionJsonUnroll:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- json_unroll
description: Identifier of the Function. Always json_unroll
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLakeExport:
type: object
title: Lake export Configuration
additionalProperties: false
properties:
searchJobId:
title: Search Job Id
description: Id of the search job this function is running on.
type: string
dataset:
title: Dataset Name
description: Name of the dataset
type: string
lake:
title: Lake Name
description: Name of the lake
type: string
tee:
title: Tee
description: Tee results to search. When set to true results will be shipped
instead of stats
type: boolean
flushMs:
title: Flush period
description: How often are stats flushed in ms
type: number
suppressPreviews:
type: boolean
title: Suppress periodic stats
description: Disables generation of intermediate stats. When true stats will be
emitted only on end
FunctionLakeExport:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- lake_export
description: Identifier of the Function. Always lake_export
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLimit:
type: object
additionalProperties: false
properties:
limit:
title: Event limit
description: Number of qualifying events to pass through
type: integer
minimum: 0
FunctionLimit:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- limit
description: Identifier of the Function. Always limit
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLocalSearchDatatypeParser:
type: object
FunctionLocalSearchDatatypeParser:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- local_search_datatype_parser
description: Identifier of the Function. Always
local_search_datatype_parser
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLocalSearchRulesetRunner:
type: object
additionalProperties: false
properties:
rulesetType:
type: string
enum:
- dataset
- datatype
title: Ruleset Type
description: "Type of ruleset to apply: dataset or datatype."
x-speakeasy-unknown-values: allow
rulesetId:
type: string
title: Ruleset ID
description: ID of the ruleset to apply.
ruleset:
type: object
title: Full ruleset
description: Full ruleset definition, used with live data capture for draft or
unsaved rulesets.
markAndIncludeDroppedEvents:
type: boolean
title: Mark and include dropped events
description: Only for use with live data capture. Mark events that were dropped
by dataset rules and still include them for capture
FunctionLocalSearchRulesetRunner:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- local_search_ruleset_runner
description: Identifier of the Function. Always
local_search_ruleset_runner
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLocalSearchSchemaMapper:
type: object
FunctionLocalSearchSchemaMapper:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- local_search_schema_mapper
description: Identifier of the Function. Always
local_search_schema_mapper
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLocalSearchTimeRangeNormalizer:
type: object
FunctionLocalSearchTimeRangeNormalizer:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- local_search_time_range_normalizer
description: Identifier of the Function. Always
local_search_time_range_normalizer
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLocalSearchTransformer:
type: object
FunctionLocalSearchTransformer:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- local_search_transformer
description: Identifier of the Function. Always
local_search_transformer
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaLookup:
type: object
properties:
file:
type: string
title: Lookup file path (.csv, .csv.gz)
description: "Path to the lookup file. Reference environment variables via $.
Example: $HOME/file.csv"
minLength: 1
dbLookup:
type: boolean
title: Use Disk-Based Lookup
description: Enable to use a disk-based lookup. This option displays only the
settings relevant to disk-based mode and hides those for in-memory
lookups.
matchMode:
title: Match mode
type: string
description: Specifies the matching method based on the format and logic used in
the lookup file
enum:
- exact
- cidr
- regex
x-speakeasy-enum-descriptions:
- Exact
- CIDR
- Regex
x-speakeasy-unknown-values: allow
matchType:
title: Match type
type: string
description: "Further defines how to handle multiple matches: return the first
match, the most specific match, or all matches"
enum:
- first
- specific
- all
x-speakeasy-unknown-values: allow
reloadPeriodSec:
type: number
title: Reload period (sec)
description: Checks the lookup file periodically for changes and reloads it if
modified. Set to -1 to disable reloading (default). Useful for
lookups not managed by Stream or not updated by an external process.
[Learn
more](https://docs.cribl.io/stream/lookup-function/#advanced-settings)
inFields:
type: array
title: Lookup fields
description: Fields that should be used to key into the lookup table
minItems: 1
items:
type: object
required:
- eventField
properties:
eventField:
type: string
title: Lookup Field Name in Event
description: Field name as it appears in events
pattern: ^[a-zA-Z$_'"][a-zA-Z0-9$_\[\]\.'"]*$
lookupField:
type: string
title: Corresponding Field Name in Lookup
description: "Optional: The field name as it appears in the lookup file.
Defaults to event field name"
outFields:
type: array
title: Output fields
description: Fields to add to events after matching lookup. Defaults to all if
not specified.
items:
type: object
required:
- lookupField
properties:
lookupField:
type: string
title: Output Field Name from Lookup
description: The field name as it appears in the lookup file
eventField:
type: string
title: Lookup Field Name in Event
description: "Optional: Field name to add to event. Defaults to lookup field
name."
pattern: ^[a-zA-Z$_][a-zA-Z0-9$_\[\]\.'"]*$
defaultValue:
type: string
title: Default Value
description: "Optional: Value to assign if lookup entry is not found"
addToEvent:
type: boolean
title: Add to raw event
description: Add the looked-up values to _raw, as key=value pairs
ignoreCase:
type: boolean
title: Ignore case
description: "Whether to ignore case when performing lookups using Match Mode:
Regex."
FunctionLookup:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- lookup
description: Identifier of the Function. Always lookup
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaMask:
type: object
properties:
rules:
type: array
title: Masking rules
description: List of masking rules, each specifying a regex to match and an
expression to replace matched content.
minItems: 1
items:
type: object
required:
- matchRegex
- replaceExpr
properties:
matchRegex:
type: string
title: Match Regex
description: Pattern to replace. Use /g to replace all matches.
minLength: 1
replaceExpr:
type: string
title: Replace Expression
description: A JavaScript expression or literal to replace the matching content.
Capturing groups can be referenced as g1, g2, and so on, and
event fields as event..
disabled:
type: boolean
description: Set to No to disable the evaluation of an individual rule
fields:
type: array
title: Apply to fields
description: Fields on which to apply the masking rules. Supports * wildcards,
except when used on internal fields.
items:
type: string
pattern: ^(?!__.*\*).*$
depth:
type: integer
title: Depth
description: Depth to which the Mask Function will search for fields to mask
minimum: 1
flags:
title: Evaluate fields
description: Fields to evaluate if one or more masking rules are matched
type: array
items:
$ref: "#/components/schemas/AddConfFunctionConfSchemaAggregation"
FunctionMask:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- mask
description: Identifier of the Function. Always mask
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaMetricsExport:
type: object
title: Metrics export Configuration
additionalProperties: true
properties:
searchJobId:
title: Search Job Id
description: Id of the search job this function is running on.
type: string
dataset:
title: Dataset Id
description: Id of the metrics dataset
type: string
nameField:
$ref: "#/components/schemas/NameFieldType"
timeField:
$ref: "#/components/schemas/NameFieldType"
valueField:
$ref: "#/components/schemas/NameFieldType"
typeField:
$ref: "#/components/schemas/NameFieldType"
labelFields:
oneOf:
- type: object
required:
- mode
- field
properties:
mode:
enum:
- object
description: Discriminator value.
x-speakeasy-unknown-values: allow
field:
$ref: "#/components/schemas/NameFieldType"
- type: object
required:
- mode
- fields
properties:
mode:
enum:
- list
description: Discriminator value.
x-speakeasy-unknown-values: allow
fields:
type: array
items:
$ref: "#/components/schemas/NameFieldType"
tee:
title: Tee
description: Tee results to search. When set to true results will be shipped
instead of stats
type: boolean
flushMs:
title: Flush period
description: How often stats are flushed in ms
type: number
suppressPreviews:
type: boolean
title: Suppress periodic stats
description: Disables generation of intermediate stats. When true stats will be
emitted only on end
FunctionMetricsExport:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- metrics_export
description: Identifier of the Function. Always metrics_export
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaMvExpand:
type: object
additionalProperties: false
properties:
sourceFields:
title: Source fields
description: Array of property-/field-names to expand
type: array
minItems: 1
items:
type: string
targetNames:
title: Target field names
description: stores the value as new target field name
type: array
minItems: 1
items:
type: string
rowLimit:
title: Row limit
description: max. number of rows generated out of every source events
type: number
itemIndexName:
title: Item index name
description: name of an optional index property generated into the output
type: string
bagExpansionMode:
title: Bag expansion mode
description: decides if bag-values are expanded to bags or arrays
type: string
enum:
- bag
- array
x-speakeasy-enum-descriptions:
- Store as object
- Store as array
x-speakeasy-unknown-values: allow
FunctionMvExpand:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- mv_expand
description: Identifier of the Function. Always mv_expand
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaMvPull:
type: object
additionalProperties: false
properties:
arrayPath:
title: Field name of source array
description: Field name of the array within events that contains the data
objects of interest. Can be a path.
type: string
relativeKeyPath:
title: Field name of key
description: Extract the K-V pair's key from this field, relative to the data
object.
type: string
relativeValuePath:
title: Field name of value
description: Extract the K-V pair's value from this field, relative to the data
object.
type: string
targetBagPath:
title: Field name for pulled fields
description: Optionally, specify a bag as the target for K-V entries. If not
specified, these entries are stored on each top-level event.
type: string
deleteOriginal:
title: Delete source array after processing
description: Toggle this on to remove each original array of data objects after
extraction. If toggled off, arrays are retained.
type: boolean
FunctionMvPull:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- mv_pull
description: Identifier of the Function. Always mv_pull
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaNotificationPolicies:
type: object
title: Notification Policies Configuration
properties:
policies:
type: array
title: Policies
description: List of notification routing policies evaluated in order
items:
type: object
required:
- id
- templateTargetPairs
- order
properties:
id:
type: string
title: Policy ID
description: Unique identifier for this policy
minLength: 1
disabled:
type: boolean
title: Disabled
description: If true, this policy will be skipped during evaluation
waitToGroup:
type: integer
title: Wait to Group (Minutes)
description: Time to wait (in minutes) to group similar alerts before sending
minimum: 0
groupByLabels:
type: array
title: Group By Labels
description: Event fields to use for grouping
items:
type: string
conditions:
type: array
title: OR Conditions
description: List of conditions. If ANY condition matches (OR), the policy
applies. Each condition is a list of tags that must ALL match
(AND).
items:
type: array
title: AND Group
items:
type: object
required:
- key
- operator
- value
properties:
key:
type: string
title: Field Name
description: Event field name to match against
minLength: 1
operator:
type: string
title: Operator
description: Comparison operator
enum:
- =
- "!="
- =~
- "!~"
x-speakeasy-enums:
- Equal
- NotEqual
- RegexMatch
- RegexNotMatch
x-speakeasy-unknown-values: allow
value:
title: Value
description: Value to compare against (string, number, boolean)
oneOf:
- type: string
- type: number
- type: boolean
templateTargetPairs:
type: array
title: Template & Target Pairs
description: List of targets to route to and the templates to use
minItems: 1
items:
$ref: "#/components/schemas/TemplateTargetPairConfFunctionConfSchemaNotificatio\
nPolicies"
final:
type: boolean
title: Final
description: If true, stop evaluating further policies after this one matches
order:
type: integer
title: Order
description: Evaluation order of this policy (lower numbers evaluated first)
minimum: 0
FunctionNotificationPolicies:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- notification_policies
description: Identifier of the Function. Always notification_policies
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaNotifications:
type: object
additionalProperties: false
properties:
id:
type: string
title: ID
description: Notification ID
field:
type: string
title: Field
description: Notification event state field name
deduplicate:
type: boolean
title: Deduplicate
description: Toggle deduplication.
FunctionNotifications:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- notifications
description: Identifier of the Function. Always notifications
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaNotify:
type: object
title: Notify Configuration
additionalProperties: false
properties:
group:
title: Group
description: Group the notification belongs to
type: string
notificationId:
title: Workspace
description: Workspace within the deployment to send the search results to.
type: string
searchId:
title: Search Id
description: Id of the search this function is running on.
type: string
savedQueryId:
title: Saved query Id
description: Id of the saved query
type: string
trigger:
title: Trigger condition expression
description: Js expression that filters events, a greater than 'Trigger Count'
events will trigger the notification
type: string
triggerType:
type: string
title: Trigger type
description: Type of the trigger condition. custom applies a kusto expression
over the results, and results count applies a comparison over
results count
enum:
- custom
- resultsCount
x-speakeasy-enum-descriptions:
- Where
- Count of Results
x-speakeasy-unknown-values: allow
triggerComparator:
type: string
title: Count comparator
description: Operation to be applied over the results count
enum:
- ">"
- <
- ===
- "!=="
- ">="
- <=
x-speakeasy-enum-descriptions:
- greater than
- less than
- equals
- not equal to
- greater than or equal to
- less than or equal to
x-speakeasy-unknown-values: allow
triggerCount:
title: Trigger Count
description: How many results that match trigger the condition
type: number
resultsLimit:
title: Top number results
description: Number of results to include in the notification event
type: number
searchUrl:
title: Search url
description: Url of the search results
type: string
message:
title: Message content
description: "Message content template, available fields: searchId, resultSet,
savedQueryId, notificationId, searchResultsUrl"
type: string
authToken:
title: Api Auth Token
description: Auth token for sending notification messages
type: string
messagesEndpoint:
title: Messages api endpoint
description: System messages api endpoint
type: string
tenantId:
title: Tenant Id
description: Current tenant id
type: string
FunctionNotify:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- notify
description: Identifier of the Function. Always notify
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaNumerify:
type: object
properties:
depth:
type: integer
title: Depth
description: Depth to which the Numerify Function will search within a nested
event. Depth greater than 5 (the default) could decrease
performance.
minimum: 0
maximum: 10
ignoreFields:
title: Ignore fields
description: "Fields to NOT numerify. Takes precedence over 'Include expression'
when set. Supports wildcards. A '!' before field name(s) means:
numerify all fields EXCEPT these. For syntax details, see
[Wildcard Lists](https://docs.cribl.io/stream/introduction-referenc\
e/#wildcard-lists)."
type: array
items:
type: string
description: Field to ignore
filterExpr:
title: Include expression
description: "Optional JavaScript expression to determine whether a field should
be numerified. If left blank, all fields will be numerified. Use the
'name' and 'value' global variables to access fields' names/values.
Examples: `value != null`, `name=='fieldname'`. You can access other
fields' values via `__e.`."
type: string
format:
title: Format
description: Numeric format to apply after type conversion.
type: string
enum:
- none
- fix
- floor
- ceil
x-speakeasy-enum-descriptions:
- None
- Fix
- Floor
- Ceil
x-speakeasy-unknown-values: allow
digits:
type: number
title: Digits
description: Number of digits after the decimal point, between 0 and 20. If left
blank, defaults to 2.
minimum: 0
maximum: 20
allOf:
- oneOf:
- $ref: "#/components/schemas/NumerifyFormatFix"
- $ref: "#/components/schemas/NumerifyFormatNone"
discriminator:
propertyName: format
mapping:
fix: "#/components/schemas/NumerifyFormatFix"
none: "#/components/schemas/NumerifyFormatNone"
FunctionNumerify:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- numerify
description: Identifier of the Function. Always numerify
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaOtlpLogs:
type: object
properties:
dropNonLogEvents:
type: boolean
title: Drop non-log events
description: Drop events that are not OTLP log records.
batchOTLPLogs:
type: boolean
title: Batch OTLP logs
description: Batch OTLP log records by shared top-level `resource` attributes
sendBatchSize:
type: number
title: Batch size
description: Number of log records after which a batch will be sent, regardless
of the timeout
timeout:
type: number
title: Batch timeout (ms)
description: Time duration after which a batch will be sent, regardless of size
sendBatchMaxSize:
type: number
title: Batch size limit (kb)
description: Maximum batch size. Enter 0 for no maximum.
metadataKeys:
type: array
title: Batch log metadata keys
description: When set, this processor will create one batcher instance per
distinct combination of values in the metadata
items:
type: string
metadataCardinalityLimit:
type: number
title: Metadata cardinality limit
description: "Limit the number of unique combinations of metadata key values
that will be processed over the lifetime of the process. After the
limit is reached, events with new metadata key value combinations
will be dropped. "
FunctionOtlpLogs:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- otlp_logs
description: Identifier of the Function. Always otlp_logs
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaOtlpMetrics:
type: object
properties:
resourceAttributePrefixes:
type: array
title: Resource attribute prefixes
description: The prefixes of top-level attributes to add as resource attributes.
Each attribute must match the regex pattern `^[a-zA-Z0-9_\.]+$`. Use
Eval to copy nested attributes to the top level for matching.
items:
type: string
pattern: ^[a-zA-Z0-9_\.]+$
dropNonMetricEvents:
type: boolean
title: Drop non-metric events
description: Drop events that are not OTLP metric data points.
otlpVersion:
$ref: "#/components/schemas/OtlpVersionOptions"
batchOTLPMetrics:
type: boolean
title: Batch OTLP metrics
description: Batch OTLP metrics by shared top-level `resource` attributes
sendBatchSize:
type: number
title: Batch size
description: Number of metric data points after which a batch will be sent,
regardless of the timeout
timeout:
type: number
title: Batch timeout (ms)
description: Time duration after which a batch will be sent, regardless of size
sendBatchMaxSize:
type: number
title: Batch size limit (kb)
description: Maximum batch size. Enter 0 for no maximum.
metadataKeys:
type: array
title: Batch metrics metadata keys
description: When set, this processor will create one batcher instance per
distinct combination of values in the metadata
items:
type: string
metadataCardinalityLimit:
type: number
title: Metadata cardinality limit
description: Limit the number of unique combinations of metadata key values that
will be processed over the lifetime of the process. After the limit
is reached, events with new metadata key value combinations will be
dropped.
FunctionOtlpMetrics:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- otlp_metrics
description: Identifier of the Function. Always otlp_metrics
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaOtlpTraces:
type: object
properties:
dropNonTraceEvents:
type: boolean
title: Drop non-trace events
description: Drop events that are not OTLP trace spans.
otlpVersion:
$ref: "#/components/schemas/OtlpVersionOptions"
batchOTLPTraces:
type: boolean
title: Batch OTLP traces
description: Batch OTLP traces by shared top-level `resource` attributes
sendBatchSize:
type: number
title: Batch size
description: Number of spans after which a batch will be sent, regardless of the
timeout
timeout:
type: number
title: Batch timeout (ms)
description: Time duration after which a batch will be sent, regardless of size
sendBatchMaxSize:
type: number
title: Batch size limit (kb)
description: Maximum batch size. Enter 0 for no maximum.
metadataKeys:
type: array
title: Batch traces metadata keys
description: When set, this processor will create one batcher instance per
distinct combination of values in the metadata
items:
type: string
metadataCardinalityLimit:
type: number
title: Metadata cardinality limit
description: Limit the number of unique combinations of metadata key values that
will be processed over the lifetime of the process. After the limit
is reached, events with new metadata key value combinations will be
dropped.
FunctionOtlpTraces:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- otlp_traces
description: Identifier of the Function. Always otlp_traces
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaPack:
type: object
properties:
unpackedFields:
title: Unpacked fields
description: List of fields to keep, everything else will be packed
type: array
items:
type: string
target:
type: string
title: Packed target Field
description: Name of the (packed) target field
FunctionPack:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- pack
description: Identifier of the Function. Always pack
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaPivot:
type: object
title: Simple Pivot Configuration
additionalProperties: false
properties:
labelField:
title: Labeling field
description: Fields to be used for the left-most column.
type: string
dataFields:
title: Data fields
description: Fields with the cell values (i.e. aggregates)
type: array
minItems: 1
items:
type: string
qualifierFields:
title: Qualifier fields
description: Fields to qualify or group data fields
type: array
minItems: 1
items:
type: string
FunctionPivot:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- pivot
description: Identifier of the Function. Always pivot
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaPublishMetrics:
type: object
additionalProperties: false
properties:
fields:
title: Add metrics
description: List of metrics from event to extract and format. Formatted metrics
can be used by a destination to pass metrics to a metrics
aggregation platform.
type: array
minItems: 0
items:
type: object
required:
- inFieldName
- metricType
properties:
inFieldName:
type: string
title: Event Field Name
description: The name of the field in the event that contains the metric value
outFieldExpr:
type: string
title: Metric Name Expression
description: JavaScript expression to evaluate the metric field name. Defaults
to Event Field Name.
metricType:
type: string
title: Metric Type
enum:
- counter
- timer
- gauge
- distribution
- summary
- histogram
x-speakeasy-enum-descriptions:
- Counter
- Timer
- Gauge
- Distribution
- Summary
- Histogram
description: Metric Type
x-speakeasy-unknown-values: allow
overwrite:
type: boolean
title: Overwrite
description: Overwrite previous metric specs. Leave disabled to append.
dimensions:
type: array
title: Add dimensions
description: Optional list of dimensions to include in events. Wildcards
supported. If you don't specify metrics, values will be appended to
every metric found in the event. When you add a new metric,
dimensions will be present only in those new metrics.
items:
type: string
removeMetrics:
title: Remove metrics
description: Optional list of metric field names to look for when removing
metrics. When a metric's field name matches an element in this list,
the metric will be removed from the event.
type: array
items:
type: string
removeDimensions:
type: array
title: Remove dimensions
description: Optional list of dimensions to remove from every metric found in
the event. Wildcards supported.
items:
type: string
FunctionPublishMetrics:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- publish_metrics
description: Identifier of the Function. Always publish_metrics
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaRedis:
type: object
properties:
commands:
type: array
minItems: 1
title: Commands
description: List of Redis commands to execute against the specified keys.
items:
type: object
required:
- keyExpr
- command
properties:
outField:
title: Result field
description: Name of the field in which to store the returned value. Leave blank
to discard returned value.
type: string
command:
title: Command
description: "Redis command to perform. For a complete list visit:
https://redis.io/commands"
type: string
keyExpr:
title: Key
description: A JavaScript expression to compute the value of the key to operate
on. Can also be a constant such as 'username'.
type: string
argsExpr:
title: Args
description: A JavaScript expression to compute arguments to the operation. Can
return an array.
type: string
deploymentType:
title: Deployment type
type: string
description: How the Redis server is configured. Defaults to Standalone
enum:
- standalone
- cluster
- sentinel
x-speakeasy-enum-descriptions:
- Standalone
- Cluster
- Sentinel
x-speakeasy-unknown-values: allow
authType:
type: string
title: Authentication method
description: Authentication method to use when connecting to Redis.
enum:
- none
- manual
- credentialsSecret
- textSecret
x-speakeasy-enum-descriptions:
- None
- Manual
- User Secret
- Admin Secret
x-speakeasy-unknown-values: allow
maxBlockSecs:
type: number
title: Blocking time limit
description: Maximum amount of time (seconds) to wait before assuming that Redis
is down and passing events through. Use 0 to disable.
enableClientSideCaching:
type: boolean
title: Client-side cache
description: Enable client-side cache. Redundant when using Redis write
operations. See more options at Settings > General > Limits > Redis
Cache.
url:
title: Redis URL
description: "Redis URL to connect to. Format:
redis[s]://[[user][:password@]][host][:port][/db-number][?db=db-num\
ber[&password=bar[&option=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: `myBucket-${C.vars.myVar}`"
type: string
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
tlsOptions:
$ref: "#/components/schemas/TlsOptionsTypeRedisDeploymentTypeStandalone"
rootNodes:
title: Root nodes
description: Root nodes to which the cluster connection should be initiated
type: array
minItems: 1
items:
$ref: "#/components/schemas/RootNodeConfRedisDeploymentTypeCluster"
tls:
title: TLS
type: boolean
description: Use TLS for connections to this cluster
scaleReads:
$ref: "#/components/schemas/ScaleReadsOptionsRedisDeploymentTypeCluster"
masterName:
title: Master group name
description: Name of the Redis Sentinel master group to connect to.
type: string
username:
title: Username
description: Username for Redis authentication.
type: string
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
password:
title: Password
description: Password for Redis authentication.
type: string
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
credentialsSecret:
type: string
title: User secret
description: Secret that references Redis username and password
textSecret:
type: string
title: Admin secret
description: Secret that references Redis admin password
allOf:
- oneOf:
- $ref: "#/components/schemas/RedisDeploymentTypeStandalone"
- $ref: "#/components/schemas/RedisDeploymentTypeCluster"
- $ref: "#/components/schemas/RedisDeploymentTypeSentinel"
discriminator:
propertyName: deploymentType
mapping:
standalone: "#/components/schemas/RedisDeploymentTypeStandalone"
cluster: "#/components/schemas/RedisDeploymentTypeCluster"
sentinel: "#/components/schemas/RedisDeploymentTypeSentinel"
- oneOf:
- $ref: "#/components/schemas/RedisAuthTypeNone"
- $ref: "#/components/schemas/RedisAuthTypeManual"
- $ref: "#/components/schemas/RedisAuthTypeCredentialsSecret"
- $ref: "#/components/schemas/RedisAuthTypeTextSecret"
discriminator:
propertyName: authType
mapping:
none: "#/components/schemas/RedisAuthTypeNone"
manual: "#/components/schemas/RedisAuthTypeManual"
credentialsSecret: "#/components/schemas/RedisAuthTypeCredentialsSecret"
textSecret: "#/components/schemas/RedisAuthTypeTextSecret"
FunctionRedis:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- redis
description: Identifier of the Function. Always redis
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaRegexExtract:
type: object
properties:
regex:
type: string
title: Regex
description: Regex literal with named capturing groups, such as (?bar), or
_NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^
=]+)=(?<_VALUE_0>[^,]+)
regexList:
type: array
title: Additional regex
description: Additional regex patterns to apply for field extraction.
items:
$ref: "#/components/schemas/RegexListConfSerdeTypeRegex"
source:
type: string
title: Source field
description: Field on which to perform regex field extraction
iterations:
type: number
title: Max exec
description: The maximum number of times to apply regex to source field when the
global flag is set, or when using _NAME_ and _VALUE_ capturing
groups
minimum: 1
fieldNameExpression:
title: Field name format expression
description: "JavaScript expression to format field names when _NAME_n and
_VALUE_n capturing groups are used. Original field name is in global
variable 'name'. Example: To append XX to all field names, use
`${name}_XX` (backticks are literal). If empty, names will be
sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can
access other fields values via __e.."
type: string
overwrite:
type: boolean
title: Overwrite existing fields
description: Overwrite existing event fields with extracted values. If disabled,
existing fields will be converted to an array.
FunctionRegexExtract:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- regex_extract
description: Identifier of the Function. Always regex_extract
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaRegexFilter:
type: object
properties:
regex:
title: Regex
description: Regex to test against
type: string
regexList:
type: array
title: Additional regex
description: Additional regex patterns to test against the field.
items:
type: object
required:
- regex
properties:
regex:
type: string
title: Regex
description: Regex to test against
minLength: 1
field:
title: Field
description: Name of the field to apply the regex on (defaults to _raw)
type: string
FunctionRegexFilter:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- regex_filter
description: Identifier of the Function. Always regex_filter
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaRename:
type: object
properties:
baseFields:
title: Parent fields
description: Fields whose children will inherit the Rename fields and Rename
expression operations. Supports wildcards. If empty, only top-level
fields will be renamed.
type: array
items:
type: string
rename:
title: Rename fields
description: Set of key-value pairs to rename fields, where key is the current
name and value is the new name. Does not support internal fields.
type: array
items:
type: object
required:
- currentName
- newName
properties:
currentName:
type: string
title: Current Name
description: Name of the field to rename. Literal identifiers must be quoted.
pattern: ^(?!__).+
newName:
type: string
title: New Name
description: The name the field will be renamed to. Literal identifiers must be
quoted.
pattern: ^(?!__).+
renameExpr:
title: Rename expression
description: "Optional JavaScript expression whose returned value will be used
to rename fields. Use the 'name' and 'value' global variables to
access field names/values. Example: `name.startsWith('data') ?
name.toUpperCase() : name`. You can access other field values via
__e.."
type: string
wildcardDepth:
type: integer
title: Parent field wildcard depth
description: For wildcards specified in Parent fields, sets the maximum depth
within events to match and rename fields. Enter `0` to match only
top-level fields. Defaults to `5` levels down.
minimum: 0
FunctionRename:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- rename
description: Identifier of the Function. Always rename
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaRollupMetrics:
type: object
properties:
dimensions:
title: Dimensions
description: List of dimensions across which to perform rollups. Supports
wildcards. Defaults to all original dimensions.
type: array
items:
type: string
timeWindow:
pattern: \d+[sm]$
type: string
title: Time window
description: The time span of the rollup window. Must be a valid time string
(such as 10s).
gaugeRollup:
title: Gauge update
description: The operation to use when rolling up gauge metrics. Defaults to last.
type: string
enum:
- last
- max
- min
- avg
x-speakeasy-enum-descriptions:
- Last
- Maximum
- Minimum
- Average
x-speakeasy-unknown-values: allow
FunctionRollupMetrics:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- rollup_metrics
description: Identifier of the Function. Always rollup_metrics
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSampling:
type: object
properties:
rules:
type: array
title: Sampling rules
description: Events matching these rules will be sampled at the given rate
items:
type: object
required:
- filter
- rate
additionalProperties: false
properties:
filter:
title: Filter
type: string
description: JavaScript filter expression matching events to be sampled. Use
true to match all.
rate:
title: Sampling Rate
type: integer
description: Sampling rate; picks one out of N matching events
FunctionSampling:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- sampling
description: Identifier of the Function. Always sampling
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSearchEngineExport:
type: object
title: Search engine export Configuration
additionalProperties: false
properties:
searchJobId:
title: Search Job Id
description: Id of the search job this function is running on.
type: string
dataset:
title: Dataset Id
description: Id of the dataset
type: string
tee:
title: Tee
description: Tee results to search. When set to true results will be shipped
instead of stats
type: boolean
flushMs:
title: Flush period
description: How often are stats flushed in ms
type: number
suppressPreviews:
type: boolean
title: Suppress periodic stats
description: Disables generation of intermediate stats. When true stats will be
emitted only on end
FunctionSearchEngineExport:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- search_engine_export
description: Identifier of the Function. Always search_engine_export
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSend:
type: object
title: Send Configuration
additionalProperties: false
properties:
url:
title: URL
description: Full URL to send search to.
type: string
group:
title: Group
description: Group within the workspace we're sending to.
type: string
workspace:
title: Workspace
description: Workspace within the deployment to send the search results to.
type: string
sendUrlTemplate:
title: URL Template
description: Template to build the URL to send from.
type: string
searchId:
title: Search Id
description: Id of the search this function is running on.
type: string
tee:
title: Tee
description: Tee results to search. When set to true results will be shipped
instead of stats
type: boolean
flushMs:
title: Flush period
description: How often are stats flushed in ms
type: number
suppressPreviews:
type: boolean
title: Suppress periodic stats
description: Disables generation of intermediate stats. When true stats will be
emitted only on end
mode:
type: string
title: Mode
description: In Sender mode, forwards search results directly to the
destination. In Metrics mode, accumulates metrics from federated
send operators, and forwards the aggregate metrics.
enum:
- sender
- metrics
x-speakeasy-unknown-values: allow
FunctionSend:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- send
description: Identifier of the Function. Always send
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSensitiveDataScanner:
type: object
properties:
rules:
type: array
title: Scanning Rulesets
description: List of scanning rulesets to apply, each with a ruleset ID and a
mitigation expression.
minItems: 1
items:
type: object
required:
- rulesetId
- replaceExpr
properties:
rulesetId:
type: string
title: Ruleset ID
description: The ID of the ruleset to use for the scan
replaceExpr:
type: string
title: Mitigation Expression
description: A JavaScript expression or literal to replace the matching content.
Capturing groups can be referenced as g1, g2, and so on, and
event fields as event..
disabled:
type: boolean
fields:
type: array
title: Apply to fields
description: Rulesets act on the events contained in these fields. Mitigation
expressions apply to the scan results. Supports wildcards (*).
items:
type: string
pattern: ^(?!__.*\*).*$
excludeFields:
type: array
title: Fields to ignore
description: Fields that the mitigation expression will not be applied to.
Supports wildcards (*).
items:
type: string
pattern: ^(?!__.*\*).*$
flags:
title: Add fields
description: Fields to add when mitigation is applied to an event
type: array
items:
type: object
required:
- value
properties:
name:
type: string
title: Name
description: Name
value:
type: string
title: Value
description: Value
includeDetectedRules:
type: boolean
title: Include detected rules
description: Add matching ruleset IDs to a field called "__detected"
backgroundDetection:
type: boolean
title: Background detection
description: Run detection in the background without blocking event processing.
FunctionSensitiveDataScanner:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- sensitive_data_scanner
description: Identifier of the Function. Always
sensitive_data_scanner
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSerde:
type: object
properties:
mode:
title: Operation mode
type: string
description: Extract creates new fields. Reserialize extracts and filters
fields, and then reserializes.
enum:
- extract
- reserialize
x-speakeasy-enum-descriptions:
- Extract
- Reserialize
x-speakeasy-unknown-values: allow
type:
title: Type
description: Parser or formatter type to use
type: string
enum:
- auto
- csv
- elff
- clf
- kvp
- json
- delim
- regex
- grok
x-speakeasy-enum-descriptions:
- Auto
- CSV
- Extended Log File Format
- Common Log Format
- Key=Value Pairs
- JSON Object
- Delimited values
- Regular Expression
- Grok
x-speakeasy-unknown-values: allow
tagDatatype:
type: boolean
title: Tag events with datatype and isParsed
description: Keep the detected datatype field and set isParsed to true on each
event. Enable this when events are bound for downstream Cribl Search
processing.
keep:
title: Fields to keep
description: List of fields to keep. Supports wildcards (*). Takes precedence
over 'Fields to remove'.
type: array
items:
type: string
remove:
title: Fields to remove
description: List of fields to remove. Supports wildcards (*). Cannot remove
fields that match 'Fields to keep'.
type: array
items:
type: string
fieldFilterExpr:
title: Fields filter expression
description: Expression evaluated against {index, name, value} context. Return
truthy to keep a field, or falsy to remove it.
type: string
allowedKeyChars:
type: array
items:
type: string
title: Allowed key characters
description: A list of characters that may be present in a key name, even though
they are normally separator or control characters
allowedValueChars:
type: array
items:
type: string
title: Allowed value characters
description: A list of characters that may be present in a value, even though
they are normally separator or control characters
fields:
title: List of fields
description: The fields to be extracted, listed in order. Will auto-generate if
empty.
type: array
items:
type: string
regex:
type: string
title: Regex
description: Regex literal with named capturing groups, such as (?bar), or
_NAME_ and _VALUE_ capturing groups, such as(?<_NAME_0>[^
=]+)=(?<_VALUE_0>[^,]+)
regexList:
type: array
title: Additional regex
description: Additional regex patterns to apply for field extraction.
items:
$ref: "#/components/schemas/RegexListConfSerdeTypeRegex"
iterations:
type: number
title: Max exec
description: The maximum number of times to apply regex to source field when the
global flag is set, or when using _NAME_ and _VALUE_ capturing
groups
minimum: 1
fieldNameExpression:
title: Field name format expression
description: "JavaScript expression to format field names when _NAME_n and
_VALUE_n capturing groups are used. Original field name is in global
variable 'name'. Example: To append XX to all field names, use
`${name}_XX` (backticks are literal). If empty, names will be
sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can
access other fields values via __e.."
type: string
overwrite:
type: boolean
title: Overwrite existing fields
description: Overwrite existing event fields with extracted values. If disabled,
existing fields will be converted to an array.
pattern:
type: string
title: Pattern
description: "Grok pattern to extract fields. Syntax supported:
%{PATTERN_NAME:FIELD_NAME}"
patternList:
type: array
title: Additional Grok patterns
description: Additional Grok patterns to apply to the source field.
items:
$ref: "#/components/schemas/PatternListConfSerdeTypeGrok"
allOf:
- oneOf:
- $ref: "#/components/schemas/SerdeTypeAuto"
- $ref: "#/components/schemas/SerdeTypeKvp"
- $ref: "#/components/schemas/SerdeTypeDelim"
- $ref: "#/components/schemas/SerdeTypeCsv"
- $ref: "#/components/schemas/SerdeTypeJson"
- $ref: "#/components/schemas/SerdeTypeRegex"
- $ref: "#/components/schemas/SerdeTypeGrok"
discriminator:
propertyName: type
mapping:
auto: "#/components/schemas/SerdeTypeAuto"
kvp: "#/components/schemas/SerdeTypeKvp"
delim: "#/components/schemas/SerdeTypeDelim"
csv: "#/components/schemas/SerdeTypeCsv"
json: "#/components/schemas/SerdeTypeJson"
regex: "#/components/schemas/SerdeTypeRegex"
grok: "#/components/schemas/SerdeTypeGrok"
FunctionSerde:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- serde
description: Identifier of the Function. Always serde
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSerialize:
type: object
properties:
type:
title: Type
description: Data output format
type: string
enum:
- csv
- elff
- clf
- kvp
- json
- delim
x-speakeasy-enum-descriptions:
- CSV
- Extended Log File Format
- Common Log Format
- Key=Value Pairs
- JSON Object
- Delimited values
x-speakeasy-unknown-values: allow
fields:
title: Fields to serialize
description: "Required for CSV, ELFF, CLF, and Delimited values. All other
formats support wildcard field lists. Examples: host, array*, !host
*"
type: array
items:
type: string
srcField:
title: Source field
description: Field containing object to serialize. Leave blank to serialize
top-level event fields.
type: string
dstField:
title: Destination field
description: Field to serialize data to
type: string
cleanFields:
type: boolean
title: Clean fields
description: Clean field names by replacing non-[a-zA-Z0-9] characters with _
pairDelimiter:
type: string
title: Pair delimiter
minLength: 1
description: Delimiter used to separate key=value pairs. Defaults to a single
space character. Should not have common characters with key-value
delimiter.
keyValueDelimiter:
type: string
title: Key-Value delimiter
minLength: 1
description: Delimiter used to separate key and value in pair. Defaults to a
'='. Should not have common characters with pair delimiter.
allOf:
- oneOf:
- $ref: "#/components/schemas/SerializeTypeKvp"
- $ref: "#/components/schemas/SerializeTypeDelim"
- $ref: "#/components/schemas/SerializeTypeCsv"
discriminator:
propertyName: type
mapping:
kvp: "#/components/schemas/SerializeTypeKvp"
delim: "#/components/schemas/SerializeTypeDelim"
csv: "#/components/schemas/SerializeTypeCsv"
FunctionSerialize:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- serialize
description: Identifier of the Function. Always serialize
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSidlookup:
type: object
properties:
fields:
title: Lookup fields
description: Set of expressions matched to lookup responses
type: array
items:
type: object
required:
- expr
properties:
name:
type: string
title: Name
description: Name
expr:
type: string
title: Value Expression
description: JavaScript expression to compute the value (can be constant)
disabled:
type: boolean
description: Set to No to disable the evaluation of an individual expression
FunctionSidlookup:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- sidlookup
description: Identifier of the Function. Always sidlookup
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSignalFilter:
type: object
title: Signal Filter Configuration
additionalProperties: false
properties:
signals:
type: array
title: Signal event types to filter
description: List of signal event types to filter
items:
type: string
FunctionSignalFilter:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- signal_filter
description: Identifier of the Function. Always signal_filter
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSnmpTrapSerialize:
type: object
properties:
strict:
type: boolean
title: Enforce required fields
description: Prevent event serialization if any required fields are missing.
When disabled, @{product} will attempt to serialize the event even
if required fields are missing, which could cause unexpected
behavior at the downstream receiver.
dropFailedEvents:
type: boolean
title: Drop failed events
description: When disabled, `snmpSerializeErrors` will be set on the event, and
the `__snmpRaw` field will be removed to prevent @{product} from
sending the event from the SNMP Trap Destination
v3User:
type: object
description: SNMPv3 user configuration, including authentication and privacy
protocol settings.
properties:
name:
title: Username
type: string
minLength: 1
description: Username
authProtocol:
$ref: "#/components/schemas/AuthenticationProtocolOptionsV3User"
privProtocol:
type: string
allOf:
- oneOf:
- $ref: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNone"
- $ref: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNone"
discriminator:
propertyName: authProtocol
mapping:
none: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNone"
md5: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNone"
sha: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNone"
sha224: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNone"
sha256: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNone"
sha384: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNone"
sha512: "#/components/schemas/SnmpTrapSerializeV3UserAuthProtocolNotNone"
FunctionSnmpTrapSerialize:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- snmp_trap_serialize
description: Identifier of the Function. Always snmp_trap_serialize
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSort:
type: object
title: Sort Configuration
additionalProperties: false
properties:
sortId:
title: Identifier for the specific sort operation
description: Has to be unique if there are multiple sorts on the pipeline.
type: string
comparisonExpression:
title: Expression to compare two events
description: The expression can access the events via the 'left' and 'right'
properties.
type: string
topN:
title: The amount of events to return sorted
description: Limits the output to N (highest/lowest) events
type: number
maxEvents:
title: The maximum number of events in input
description: Specifies the number of events that can flow into this function
type: number
suppressPreviews:
type: boolean
title: Disable intermediate results
description: Toggle this on to suppress generating previews of intermediate
results
FunctionSort:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- sort
description: Identifier of the Function. Always sort
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaStore:
type: object
title: Store Function Configuration
additionalProperties: false
properties:
type:
title: Output type
description: The type of knowledge object, generated by the function (i.e.,
'lookup')
type: string
destination:
title: Configuration for store destination
description: Configures where and how the data should be stored
type: string
description:
title: Description for object
description: The knowledge object's description
type: string
fieldMapping:
title: Mapping of field names
description: Mapping event property names to output field names
type: object
separator:
title: Separator for CSV output
description: Character to be used as value delimiter in output
type: string
overwrite:
title: Overwrite destination
description: For existing files, an error is thrown if overwrite is false or the
file is replaced if overwrite is true
type: boolean
compress:
title: Compress the output
description: True will compress output, false leaves it as it is and auto
decides based on size
type: string
tee:
title: Tee Results
description: Tee results to the next operator
type: boolean
maxEvents:
title: Maximum number of events
description: Limits how many events can be stored
type: number
suppressPreviews:
title: Suppress previews
description: Suppresses the timer-based export stats generating
type: boolean
FunctionStore:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- store
description: Identifier of the Function. Always store
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaSuppress:
type: object
properties:
keyExpr:
type: string
title: Key expression
description: Suppression key expression used to uniquely identify events to
suppress. For example, `${ip}:${port}` will use fields ip and port
from each event to generate the key.
allow:
type: number
title: Number to allow
minimum: 1
description: The number of events to allow per time period
suppressPeriodSec:
type: number
title: Suppression period (sec)
minimum: 0
description: The number of seconds to suppress events after 'Number to allow'
events are received
dropEventsMode:
type: boolean
title: Drop suppressed events
description: If disabled, suppressed events will be tagged with suppress=1 but
not dropped
maxCacheSize:
type: number
title: Cache size limit
description: The maximum number of keys that can be cached before idle entries
are removed. Leave at default unless you understand the implications
of changing.
cacheIdleTimeoutPeriods:
type: number
title: Suppression period timeout
description: The number of suppression periods 'Suppression Period' of
inactivity before a cache entry is considered idle. Leave at default
unless you understand the implications of changing.
numEventsIdleTimeoutTrigger:
type: number
title: Num events to trigger cache clean-up
description: Check cache for idle sessions every N events when cache size is >
'Maximum Cache Size'. Leave at default unless you understand the
implications of changing.
FunctionSuppress:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- suppress
description: Identifier of the Function. Always suppress
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaTee:
type: object
properties:
command:
type: string
title: Command
description: Command to execute and feed events to, via stdin. One
JSON-formatted event per line.
args:
type: array
title: Command arguments
description: Command-line arguments to pass to the command.
items:
type: string
restartOnExit:
type: boolean
title: Restart on exit
description: Restart the process if it exits and/or we fail to write to it
env:
type: object
title: Environment variables
description: Environment variables to overwrite or set
additionalProperties:
type: string
FunctionTee:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- tee
description: Identifier of the Function. Always tee
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaTrimTimestamp:
type: object
properties:
field:
type: string
title: Field name
description: Name of field in which to save the timestamp. (If empty, timestamp
will not be saved to a field.)
FunctionTrimTimestamp:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- trim_timestamp
description: Identifier of the Function. Always trim_timestamp
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaUnion:
type: object
title: Union Configuration
additionalProperties: false
properties:
searchJobId:
title: Search Job Id
description: The id for this search job.
type: string
stageIds:
title: Stage Ids
description: The stages we are unioning with.
type: array
minItems: 1
items:
type: string
FunctionUnion:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- union
description: Identifier of the Function. Always union
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaUnroll:
type: object
properties:
srcExpr:
type: string
title: Source field expression
description: "Field in which to find/calculate the array to unroll. Example:
_raw, _raw.split(/\\n/)"
dstField:
type: string
title: Destination field
description: Field in destination event in which to place the unrolled value
FunctionUnroll:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- unroll
description: Identifier of the Function. Always unroll
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaWindow:
type: object
additionalProperties: false
properties:
eventWindowId:
title: Unique Identifier
description: Identifies the unique ID, used for a event window
type: number
registeredFunctions:
title: Registered Window Functions
description: All window functions, tracked by this event window
type: array
minItems: 1
items:
type: string
tailEventCount:
title: Tail Event Count
description: Number of events to keep before the current event in the window
type: number
headEventCount:
title: Head Event Count
description: Number of events to keep after the current event in the window
type: number
FunctionWindow:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- window
description: Identifier of the Function. Always window
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionConfSchemaXmlUnroll:
type: object
properties:
unroll:
type: string
title: Unroll elements regex
description: "Path to array to unroll. Example: ^root\\.child\\.ElementToUnroll$"
inherit:
type: string
title: Copy elements regex
description: "Regex matching elements to copy into each unrolled event. Example:
^root\\.(childA|childB|childC)$"
unrollIdxField:
type: string
title: Unroll index field
description: Add a field with this name, containing the index at which the item
was located, starting from 0
pretty:
type: boolean
title: Pretty print
description: Pretty print the output XML
FunctionXmlUnroll:
type: object
properties:
__filename:
type: string
description: Path to the JavaScript file that implements the Function.
asyncTimeout:
type: number
description: Maximum time, in milliseconds, that the Function is allowed to run
asynchronously before timing out.
cribl_version:
type: string
description: Minimum Cribl version required by the Function, if applicable.
disabled:
type: boolean
description: If true, the Function is disabled and will not execute
in a Pipeline. Otherwise, false.
group:
type: string
description: Category group the Function belongs to.
handleSignals:
type: boolean
description: If true, the Function handles stream signals such as
flush and close. Otherwise,
false.
id:
type: string
enum:
- xml_unroll
description: Identifier of the Function. Always xml_unroll
loadTime:
type: number
description: Time the Function module was loaded, in milliseconds since the Unix
epoch.
modTime:
type: number
description: Time the Function module was last modified, in milliseconds since
the Unix epoch.
name:
type: string
description: Display name of the Function.
sync:
type: boolean
description: If true, the Function executes synchronously.
Otherwise, false.
uischema:
type: object
additionalProperties: true
description: UI Schema that controls how the Function's configuration form is
rendered.
version:
type: string
description: Version string of the Function.
schema:
type: object
additionalProperties: true
description: JSON Schema document that describes the Function configuration.
required:
- __filename
- group
- id
- loadTime
- modTime
- name
- uischema
- version
FunctionResponse:
oneOf:
- $ref: "#/components/schemas/FunctionAggregateMetrics"
- $ref: "#/components/schemas/FunctionAggregation"
- $ref: "#/components/schemas/FunctionAutoTimestamp"
- $ref: "#/components/schemas/FunctionCef"
- $ref: "#/components/schemas/FunctionChain"
- $ref: "#/components/schemas/FunctionClone"
- $ref: "#/components/schemas/FunctionCode"
- $ref: "#/components/schemas/FunctionComment"
- $ref: "#/components/schemas/FunctionDistinct"
- $ref: "#/components/schemas/FunctionDnsLookup"
- $ref: "#/components/schemas/FunctionDrop"
- $ref: "#/components/schemas/FunctionDropDimensions"
- $ref: "#/components/schemas/FunctionDynamicSampling"
- $ref: "#/components/schemas/FunctionEval"
- $ref: "#/components/schemas/FunctionEventBreaker"
- $ref: "#/components/schemas/FunctionEventstats"
- $ref: "#/components/schemas/FunctionExternaldata"
- $ref: "#/components/schemas/FunctionFlatten"
- $ref: "#/components/schemas/FunctionFoldkeys"
- $ref: "#/components/schemas/FunctionGenStats"
- $ref: "#/components/schemas/FunctionGeoip"
- $ref: "#/components/schemas/FunctionGrok"
- $ref: "#/components/schemas/FunctionHandlebars"
- $ref: "#/components/schemas/FunctionJoin"
- $ref: "#/components/schemas/FunctionJsonUnroll"
- $ref: "#/components/schemas/FunctionLakeExport"
- $ref: "#/components/schemas/FunctionLimit"
- $ref: "#/components/schemas/FunctionLocalSearchDatatypeParser"
- $ref: "#/components/schemas/FunctionLocalSearchRulesetRunner"
- $ref: "#/components/schemas/FunctionLocalSearchSchemaMapper"
- $ref: "#/components/schemas/FunctionLocalSearchTimeRangeNormalizer"
- $ref: "#/components/schemas/FunctionLocalSearchTransformer"
- $ref: "#/components/schemas/FunctionLookup"
- $ref: "#/components/schemas/FunctionMask"
- $ref: "#/components/schemas/FunctionMetricsExport"
- $ref: "#/components/schemas/FunctionMvExpand"
- $ref: "#/components/schemas/FunctionMvPull"
- $ref: "#/components/schemas/FunctionNotificationPolicies"
- $ref: "#/components/schemas/FunctionNotifications"
- $ref: "#/components/schemas/FunctionNotify"
- $ref: "#/components/schemas/FunctionNumerify"
- $ref: "#/components/schemas/FunctionOtlpLogs"
- $ref: "#/components/schemas/FunctionOtlpMetrics"
- $ref: "#/components/schemas/FunctionOtlpTraces"
- $ref: "#/components/schemas/FunctionPack"
- $ref: "#/components/schemas/FunctionPivot"
- $ref: "#/components/schemas/FunctionPublishMetrics"
- $ref: "#/components/schemas/FunctionRedis"
- $ref: "#/components/schemas/FunctionRegexExtract"
- $ref: "#/components/schemas/FunctionRegexFilter"
- $ref: "#/components/schemas/FunctionRename"
- $ref: "#/components/schemas/FunctionRollupMetrics"
- $ref: "#/components/schemas/FunctionSampling"
- $ref: "#/components/schemas/FunctionSearchEngineExport"
- $ref: "#/components/schemas/FunctionSend"
- $ref: "#/components/schemas/FunctionSensitiveDataScanner"
- $ref: "#/components/schemas/FunctionSerde"
- $ref: "#/components/schemas/FunctionSerialize"
- $ref: "#/components/schemas/FunctionSidlookup"
- $ref: "#/components/schemas/FunctionSignalFilter"
- $ref: "#/components/schemas/FunctionSnmpTrapSerialize"
- $ref: "#/components/schemas/FunctionSort"
- $ref: "#/components/schemas/FunctionStore"
- $ref: "#/components/schemas/FunctionSuppress"
- $ref: "#/components/schemas/FunctionTee"
- $ref: "#/components/schemas/FunctionTrimTimestamp"
- $ref: "#/components/schemas/FunctionUnion"
- $ref: "#/components/schemas/FunctionUnroll"
- $ref: "#/components/schemas/FunctionWindow"
- $ref: "#/components/schemas/FunctionXmlUnroll"
discriminator:
propertyName: id
mapping:
aggregate_metrics: "#/components/schemas/FunctionAggregateMetrics"
aggregation: "#/components/schemas/FunctionAggregation"
auto_timestamp: "#/components/schemas/FunctionAutoTimestamp"
cef: "#/components/schemas/FunctionCef"
chain: "#/components/schemas/FunctionChain"
clone: "#/components/schemas/FunctionClone"
code: "#/components/schemas/FunctionCode"
comment: "#/components/schemas/FunctionComment"
distinct: "#/components/schemas/FunctionDistinct"
dns_lookup: "#/components/schemas/FunctionDnsLookup"
drop: "#/components/schemas/FunctionDrop"
drop_dimensions: "#/components/schemas/FunctionDropDimensions"
dynamic_sampling: "#/components/schemas/FunctionDynamicSampling"
eval: "#/components/schemas/FunctionEval"
event_breaker: "#/components/schemas/FunctionEventBreaker"
eventstats: "#/components/schemas/FunctionEventstats"
externaldata: "#/components/schemas/FunctionExternaldata"
flatten: "#/components/schemas/FunctionFlatten"
foldkeys: "#/components/schemas/FunctionFoldkeys"
gen_stats: "#/components/schemas/FunctionGenStats"
geoip: "#/components/schemas/FunctionGeoip"
grok: "#/components/schemas/FunctionGrok"
handlebars: "#/components/schemas/FunctionHandlebars"
join: "#/components/schemas/FunctionJoin"
json_unroll: "#/components/schemas/FunctionJsonUnroll"
lake_export: "#/components/schemas/FunctionLakeExport"
limit: "#/components/schemas/FunctionLimit"
local_search_datatype_parser: "#/components/schemas/FunctionLocalSearchDatatypeParser"
local_search_ruleset_runner: "#/components/schemas/FunctionLocalSearchRulesetRunner"
local_search_schema_mapper: "#/components/schemas/FunctionLocalSearchSchemaMapper"
local_search_time_range_normalizer: "#/components/schemas/FunctionLocalSearchTimeRangeNormalizer"
local_search_transformer: "#/components/schemas/FunctionLocalSearchTransformer"
lookup: "#/components/schemas/FunctionLookup"
mask: "#/components/schemas/FunctionMask"
metrics_export: "#/components/schemas/FunctionMetricsExport"
mv_expand: "#/components/schemas/FunctionMvExpand"
mv_pull: "#/components/schemas/FunctionMvPull"
notification_policies: "#/components/schemas/FunctionNotificationPolicies"
notifications: "#/components/schemas/FunctionNotifications"
notify: "#/components/schemas/FunctionNotify"
numerify: "#/components/schemas/FunctionNumerify"
otlp_logs: "#/components/schemas/FunctionOtlpLogs"
otlp_metrics: "#/components/schemas/FunctionOtlpMetrics"
otlp_traces: "#/components/schemas/FunctionOtlpTraces"
pack: "#/components/schemas/FunctionPack"
pivot: "#/components/schemas/FunctionPivot"
publish_metrics: "#/components/schemas/FunctionPublishMetrics"
redis: "#/components/schemas/FunctionRedis"
regex_extract: "#/components/schemas/FunctionRegexExtract"
regex_filter: "#/components/schemas/FunctionRegexFilter"
rename: "#/components/schemas/FunctionRename"
rollup_metrics: "#/components/schemas/FunctionRollupMetrics"
sampling: "#/components/schemas/FunctionSampling"
search_engine_export: "#/components/schemas/FunctionSearchEngineExport"
send: "#/components/schemas/FunctionSend"
sensitive_data_scanner: "#/components/schemas/FunctionSensitiveDataScanner"
serde: "#/components/schemas/FunctionSerde"
serialize: "#/components/schemas/FunctionSerialize"
sidlookup: "#/components/schemas/FunctionSidlookup"
signal_filter: "#/components/schemas/FunctionSignalFilter"
snmp_trap_serialize: "#/components/schemas/FunctionSnmpTrapSerialize"
sort: "#/components/schemas/FunctionSort"
store: "#/components/schemas/FunctionStore"
suppress: "#/components/schemas/FunctionSuppress"
tee: "#/components/schemas/FunctionTee"
trim_timestamp: "#/components/schemas/FunctionTrimTimestamp"
union: "#/components/schemas/FunctionUnion"
unroll: "#/components/schemas/FunctionUnroll"
window: "#/components/schemas/FunctionWindow"
xml_unroll: "#/components/schemas/FunctionXmlUnroll"
PipelineFunctionAggregateMetrics:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always aggregate_metrics
type: string
enum:
- aggregate_metrics
example: aggregate_metrics
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaAggregateMetrics"
required:
- timeWindow
- aggregations
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionAggregation:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always aggregation
type: string
enum:
- aggregation
example: aggregation
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaAggregation"
required:
- timeWindow
- aggregations
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionAutoTimestamp:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always auto_timestamp
type: string
enum:
- auto_timestamp
example: auto_timestamp
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaAutoTimestamp"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionCef:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always cef
type: string
enum:
- cef
example: cef
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaCef"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionChain:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always chain
type: string
enum:
- chain
example: chain
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaChain"
required:
- processor
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionClone:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always clone
type: string
enum:
- clone
example: clone
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaClone"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionCode:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always code
type: string
enum:
- code
example: code
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaCode"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionComment:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always comment
type: string
enum:
- comment
example: comment
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaComment"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionDistinct:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always distinct
type: string
enum:
- distinct
example: distinct
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaDistinct"
required:
- groupBy
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionDnsLookup:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always dns_lookup
type: string
enum:
- dns_lookup
example: dns_lookup
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaDnsLookup"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionDrop:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always drop
type: string
enum:
- drop
example: drop
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaDrop"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionDropDimensions:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always drop_dimensions
type: string
enum:
- drop_dimensions
example: drop_dimensions
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaDropDimensions"
required:
- timeWindow
- dropDimensions
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionDynamicSampling:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always dynamic_sampling
type: string
enum:
- dynamic_sampling
example: dynamic_sampling
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaDynamicSampling"
required:
- mode
- keyExpr
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionEval:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always eval
type: string
enum:
- eval
example: eval
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaEval"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionEventBreaker:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always event_breaker
type: string
enum:
- event_breaker
example: event_breaker
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaEventBreaker"
required:
- existingOrNew
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionEventstats:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always eventstats
type: string
enum:
- eventstats
example: eventstats
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaEventstats"
required:
- aggregations
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionExternaldata:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always externaldata
type: string
enum:
- externaldata
example: externaldata
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaExternaldata"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionFlatten:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always flatten
type: string
enum:
- flatten
example: flatten
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaFlatten"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionFoldkeys:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always foldkeys
type: string
enum:
- foldkeys
example: foldkeys
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaFoldkeys"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionGenStats:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always gen_stats
type: string
enum:
- gen_stats
example: gen_stats
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaGenStats"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionGeoip:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always geoip
type: string
enum:
- geoip
example: geoip
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaGeoip"
required:
- file
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionGrok:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always grok
type: string
enum:
- grok
example: grok
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaGrok"
required:
- pattern
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionHandlebars:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always handlebars
type: string
enum:
- handlebars
example: handlebars
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaHandlebars"
required:
- templates
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionJoin:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always join
type: string
enum:
- join
example: join
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaJoin"
required:
- fieldConditions
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionJsonUnroll:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always json_unroll
type: string
enum:
- json_unroll
example: json_unroll
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaJsonUnroll"
required:
- path
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLakeExport:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always lake_export
type: string
enum:
- lake_export
example: lake_export
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaLakeExport"
required:
- dataset
- searchJobId
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLimit:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always limit
type: string
enum:
- limit
example: limit
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaLimit"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLocalSearchDatatypeParser:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always
local_search_datatype_parser
type: string
enum:
- local_search_datatype_parser
example: local_search_datatype_parser
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaLocalSearchDatatypeParser"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLocalSearchRulesetRunner:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always
local_search_ruleset_runner
type: string
enum:
- local_search_ruleset_runner
example: local_search_ruleset_runner
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaLocalSearchRulesetRunner"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLocalSearchSchemaMapper:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always
local_search_schema_mapper
type: string
enum:
- local_search_schema_mapper
example: local_search_schema_mapper
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaLocalSearchSchemaMapper"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLocalSearchTimeRangeNormalizer:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always
local_search_time_range_normalizer
type: string
enum:
- local_search_time_range_normalizer
example: local_search_time_range_normalizer
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaLocalSearchTimeRangeNormalizer"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLocalSearchTransformer:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always
local_search_transformer
type: string
enum:
- local_search_transformer
example: local_search_transformer
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaLocalSearchTransformer"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionLookup:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always lookup
type: string
enum:
- lookup
example: lookup
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaLookup"
required:
- file
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionMask:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always mask
type: string
enum:
- mask
example: mask
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaMask"
required:
- rules
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionMetricsExport:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always metrics_export
type: string
enum:
- metrics_export
example: metrics_export
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaMetricsExport"
required:
- dataset
- searchJobId
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionMvExpand:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always mv_expand
type: string
enum:
- mv_expand
example: mv_expand
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaMvExpand"
required:
- sourceFields
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionMvPull:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always mv_pull
type: string
enum:
- mv_pull
example: mv_pull
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaMvPull"
required:
- arrayPath
- relativeKeyPath
- relativeValuePath
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionNotificationPolicies:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always notification_policies
type: string
enum:
- notification_policies
example: notification_policies
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaNotificationPolicies"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionNotifications:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always notifications
type: string
enum:
- notifications
example: notifications
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaNotifications"
required:
- id
- field
- deduplicate
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionNotify:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always notify
type: string
enum:
- notify
example: notify
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaNotify"
required:
- searchId
- notificationId
- savedQueryId
- group
- searchUrl
- messagesEndpoint
- authToken
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionNumerify:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always numerify
type: string
enum:
- numerify
example: numerify
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaNumerify"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionOtlpLogs:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always otlp_logs
type: string
enum:
- otlp_logs
example: otlp_logs
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaOtlpLogs"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionOtlpMetrics:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always otlp_metrics
type: string
enum:
- otlp_metrics
example: otlp_metrics
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaOtlpMetrics"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionOtlpTraces:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always otlp_traces
type: string
enum:
- otlp_traces
example: otlp_traces
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaOtlpTraces"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionPack:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always pack
type: string
enum:
- pack
example: pack
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaPack"
required:
- unpackedFields
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionPivot:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always pivot
type: string
enum:
- pivot
example: pivot
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaPivot"
required:
- labelField
- dataFields
- qualifierFields
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionPublishMetrics:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always publish_metrics
type: string
enum:
- publish_metrics
example: publish_metrics
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaPublishMetrics"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionRedis:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always redis
type: string
enum:
- redis
example: redis
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaRedis"
required:
- commands
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionRegexExtract:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always regex_extract
type: string
enum:
- regex_extract
example: regex_extract
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaRegexExtract"
required:
- regex
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionRegexFilter:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always regex_filter
type: string
enum:
- regex_filter
example: regex_filter
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaRegexFilter"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionRename:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always rename
type: string
enum:
- rename
example: rename
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaRename"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionRollupMetrics:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always rollup_metrics
type: string
enum:
- rollup_metrics
example: rollup_metrics
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaRollupMetrics"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSampling:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always sampling
type: string
enum:
- sampling
example: sampling
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaSampling"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSearchEngineExport:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always search_engine_export
type: string
enum:
- search_engine_export
example: search_engine_export
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaSearchEngineExport"
required:
- dataset
- searchJobId
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSend:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always send
type: string
enum:
- send
example: send
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaSend"
required:
- searchId
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSensitiveDataScanner:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always
sensitive_data_scanner
type: string
enum:
- sensitive_data_scanner
example: sensitive_data_scanner
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaSensitiveDataScanner"
required:
- rules
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSerde:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always serde
type: string
enum:
- serde
example: serde
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaSerde"
required:
- mode
- type
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSerialize:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always serialize
type: string
enum:
- serialize
example: serialize
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaSerialize"
required:
- type
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSidlookup:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always sidlookup
type: string
enum:
- sidlookup
example: sidlookup
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaSidlookup"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSignalFilter:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always signal_filter
type: string
enum:
- signal_filter
example: signal_filter
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaSignalFilter"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSnmpTrapSerialize:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always snmp_trap_serialize
type: string
enum:
- snmp_trap_serialize
example: snmp_trap_serialize
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaSnmpTrapSerialize"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSort:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always sort
type: string
enum:
- sort
example: sort
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaSort"
required:
- comparisonExpression
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionStore:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always store
type: string
enum:
- store
example: store
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaStore"
required:
- type
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionSuppress:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always suppress
type: string
enum:
- suppress
example: suppress
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaSuppress"
required:
- keyExpr
- allow
- suppressPeriodSec
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionTee:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always tee
type: string
enum:
- tee
example: tee
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaTee"
required:
- command
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionTrimTimestamp:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always trim_timestamp
type: string
enum:
- trim_timestamp
example: trim_timestamp
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
$ref: "#/components/schemas/FunctionConfSchemaTrimTimestamp"
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionUnion:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always union
type: string
enum:
- union
example: union
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaUnion"
required:
- searchJobId
- stageIds
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionUnroll:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always unroll
type: string
enum:
- unroll
example: unroll
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaUnroll"
required:
- srcExpr
- dstField
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionWindow:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always window
type: string
enum:
- window
example: window
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaWindow"
required:
- eventWindowId
- registeredFunctions
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionXmlUnroll:
type: object
required:
- id
- conf
additionalProperties: false
properties:
filter:
title: Filter
description: JavaScript expression that selects data to pass through the Function.
type: string
id:
title: ID
description: Identifier of the Function. Always xml_unroll
type: string
enum:
- xml_unroll
example: xml_unroll
description:
title: Description
description: Brief description of the Pipeline function.
type: string
disabled:
title: Disabled
description: If true, disable the Pipeline function so that events
are not passed through it. Otherwise, false.
type: boolean
final:
title: Final
description: If true, stop passing events to downstream Pipeline
Functions after the Function executes. Otherwise,
false.
type: boolean
conf:
allOf:
- $ref: "#/components/schemas/FunctionConfSchemaXmlUnroll"
required:
- unroll
description: Configuration specific to the Pipeline Function.
groupId:
title: Group ID
description: Unique identifier of the group that contains the Pipeline Function.
type: string
PipelineFunctionConf:
oneOf:
- $ref: "#/components/schemas/PipelineFunctionAggregateMetrics"
- $ref: "#/components/schemas/PipelineFunctionAggregation"
- $ref: "#/components/schemas/PipelineFunctionAutoTimestamp"
- $ref: "#/components/schemas/PipelineFunctionCef"
- $ref: "#/components/schemas/PipelineFunctionChain"
- $ref: "#/components/schemas/PipelineFunctionClone"
- $ref: "#/components/schemas/PipelineFunctionCode"
- $ref: "#/components/schemas/PipelineFunctionComment"
- $ref: "#/components/schemas/PipelineFunctionDistinct"
- $ref: "#/components/schemas/PipelineFunctionDnsLookup"
- $ref: "#/components/schemas/PipelineFunctionDrop"
- $ref: "#/components/schemas/PipelineFunctionDropDimensions"
- $ref: "#/components/schemas/PipelineFunctionDynamicSampling"
- $ref: "#/components/schemas/PipelineFunctionEval"
- $ref: "#/components/schemas/PipelineFunctionEventBreaker"
- $ref: "#/components/schemas/PipelineFunctionEventstats"
- $ref: "#/components/schemas/PipelineFunctionExternaldata"
- $ref: "#/components/schemas/PipelineFunctionFlatten"
- $ref: "#/components/schemas/PipelineFunctionFoldkeys"
- $ref: "#/components/schemas/PipelineFunctionGenStats"
- $ref: "#/components/schemas/PipelineFunctionGeoip"
- $ref: "#/components/schemas/PipelineFunctionGrok"
- $ref: "#/components/schemas/PipelineFunctionHandlebars"
- $ref: "#/components/schemas/PipelineFunctionJoin"
- $ref: "#/components/schemas/PipelineFunctionJsonUnroll"
- $ref: "#/components/schemas/PipelineFunctionLakeExport"
- $ref: "#/components/schemas/PipelineFunctionLimit"
- $ref: "#/components/schemas/PipelineFunctionLocalSearchDatatypeParser"
- $ref: "#/components/schemas/PipelineFunctionLocalSearchRulesetRunner"
- $ref: "#/components/schemas/PipelineFunctionLocalSearchSchemaMapper"
- $ref: "#/components/schemas/PipelineFunctionLocalSearchTimeRangeNormalizer"
- $ref: "#/components/schemas/PipelineFunctionLocalSearchTransformer"
- $ref: "#/components/schemas/PipelineFunctionLookup"
- $ref: "#/components/schemas/PipelineFunctionMask"
- $ref: "#/components/schemas/PipelineFunctionMetricsExport"
- $ref: "#/components/schemas/PipelineFunctionMvExpand"
- $ref: "#/components/schemas/PipelineFunctionMvPull"
- $ref: "#/components/schemas/PipelineFunctionNotificationPolicies"
- $ref: "#/components/schemas/PipelineFunctionNotifications"
- $ref: "#/components/schemas/PipelineFunctionNotify"
- $ref: "#/components/schemas/PipelineFunctionNumerify"
- $ref: "#/components/schemas/PipelineFunctionOtlpLogs"
- $ref: "#/components/schemas/PipelineFunctionOtlpMetrics"
- $ref: "#/components/schemas/PipelineFunctionOtlpTraces"
- $ref: "#/components/schemas/PipelineFunctionPack"
- $ref: "#/components/schemas/PipelineFunctionPivot"
- $ref: "#/components/schemas/PipelineFunctionPublishMetrics"
- $ref: "#/components/schemas/PipelineFunctionRedis"
- $ref: "#/components/schemas/PipelineFunctionRegexExtract"
- $ref: "#/components/schemas/PipelineFunctionRegexFilter"
- $ref: "#/components/schemas/PipelineFunctionRename"
- $ref: "#/components/schemas/PipelineFunctionRollupMetrics"
- $ref: "#/components/schemas/PipelineFunctionSampling"
- $ref: "#/components/schemas/PipelineFunctionSearchEngineExport"
- $ref: "#/components/schemas/PipelineFunctionSend"
- $ref: "#/components/schemas/PipelineFunctionSensitiveDataScanner"
- $ref: "#/components/schemas/PipelineFunctionSerde"
- $ref: "#/components/schemas/PipelineFunctionSerialize"
- $ref: "#/components/schemas/PipelineFunctionSidlookup"
- $ref: "#/components/schemas/PipelineFunctionSignalFilter"
- $ref: "#/components/schemas/PipelineFunctionSnmpTrapSerialize"
- $ref: "#/components/schemas/PipelineFunctionSort"
- $ref: "#/components/schemas/PipelineFunctionStore"
- $ref: "#/components/schemas/PipelineFunctionSuppress"
- $ref: "#/components/schemas/PipelineFunctionTee"
- $ref: "#/components/schemas/PipelineFunctionTrimTimestamp"
- $ref: "#/components/schemas/PipelineFunctionUnion"
- $ref: "#/components/schemas/PipelineFunctionUnroll"
- $ref: "#/components/schemas/PipelineFunctionWindow"
- $ref: "#/components/schemas/PipelineFunctionXmlUnroll"
discriminator:
propertyName: id
mapping:
aggregate_metrics: "#/components/schemas/PipelineFunctionAggregateMetrics"
aggregation: "#/components/schemas/PipelineFunctionAggregation"
auto_timestamp: "#/components/schemas/PipelineFunctionAutoTimestamp"
cef: "#/components/schemas/PipelineFunctionCef"
chain: "#/components/schemas/PipelineFunctionChain"
clone: "#/components/schemas/PipelineFunctionClone"
code: "#/components/schemas/PipelineFunctionCode"
comment: "#/components/schemas/PipelineFunctionComment"
distinct: "#/components/schemas/PipelineFunctionDistinct"
dns_lookup: "#/components/schemas/PipelineFunctionDnsLookup"
drop: "#/components/schemas/PipelineFunctionDrop"
drop_dimensions: "#/components/schemas/PipelineFunctionDropDimensions"
dynamic_sampling: "#/components/schemas/PipelineFunctionDynamicSampling"
eval: "#/components/schemas/PipelineFunctionEval"
event_breaker: "#/components/schemas/PipelineFunctionEventBreaker"
eventstats: "#/components/schemas/PipelineFunctionEventstats"
externaldata: "#/components/schemas/PipelineFunctionExternaldata"
flatten: "#/components/schemas/PipelineFunctionFlatten"
foldkeys: "#/components/schemas/PipelineFunctionFoldkeys"
gen_stats: "#/components/schemas/PipelineFunctionGenStats"
geoip: "#/components/schemas/PipelineFunctionGeoip"
grok: "#/components/schemas/PipelineFunctionGrok"
handlebars: "#/components/schemas/PipelineFunctionHandlebars"
join: "#/components/schemas/PipelineFunctionJoin"
json_unroll: "#/components/schemas/PipelineFunctionJsonUnroll"
lake_export: "#/components/schemas/PipelineFunctionLakeExport"
limit: "#/components/schemas/PipelineFunctionLimit"
local_search_datatype_parser: "#/components/schemas/PipelineFunctionLocalSearchDatatypeParser"
local_search_ruleset_runner: "#/components/schemas/PipelineFunctionLocalSearchRulesetRunner"
local_search_schema_mapper: "#/components/schemas/PipelineFunctionLocalSearchSchemaMapper"
local_search_time_range_normalizer: "#/components/schemas/PipelineFunctionLocalSearchTimeRangeNormalizer"
local_search_transformer: "#/components/schemas/PipelineFunctionLocalSearchTransformer"
lookup: "#/components/schemas/PipelineFunctionLookup"
mask: "#/components/schemas/PipelineFunctionMask"
metrics_export: "#/components/schemas/PipelineFunctionMetricsExport"
mv_expand: "#/components/schemas/PipelineFunctionMvExpand"
mv_pull: "#/components/schemas/PipelineFunctionMvPull"
notification_policies: "#/components/schemas/PipelineFunctionNotificationPolicies"
notifications: "#/components/schemas/PipelineFunctionNotifications"
notify: "#/components/schemas/PipelineFunctionNotify"
numerify: "#/components/schemas/PipelineFunctionNumerify"
otlp_logs: "#/components/schemas/PipelineFunctionOtlpLogs"
otlp_metrics: "#/components/schemas/PipelineFunctionOtlpMetrics"
otlp_traces: "#/components/schemas/PipelineFunctionOtlpTraces"
pack: "#/components/schemas/PipelineFunctionPack"
pivot: "#/components/schemas/PipelineFunctionPivot"
publish_metrics: "#/components/schemas/PipelineFunctionPublishMetrics"
redis: "#/components/schemas/PipelineFunctionRedis"
regex_extract: "#/components/schemas/PipelineFunctionRegexExtract"
regex_filter: "#/components/schemas/PipelineFunctionRegexFilter"
rename: "#/components/schemas/PipelineFunctionRename"
rollup_metrics: "#/components/schemas/PipelineFunctionRollupMetrics"
sampling: "#/components/schemas/PipelineFunctionSampling"
search_engine_export: "#/components/schemas/PipelineFunctionSearchEngineExport"
send: "#/components/schemas/PipelineFunctionSend"
sensitive_data_scanner: "#/components/schemas/PipelineFunctionSensitiveDataScanner"
serde: "#/components/schemas/PipelineFunctionSerde"
serialize: "#/components/schemas/PipelineFunctionSerialize"
sidlookup: "#/components/schemas/PipelineFunctionSidlookup"
signal_filter: "#/components/schemas/PipelineFunctionSignalFilter"
snmp_trap_serialize: "#/components/schemas/PipelineFunctionSnmpTrapSerialize"
sort: "#/components/schemas/PipelineFunctionSort"
store: "#/components/schemas/PipelineFunctionStore"
suppress: "#/components/schemas/PipelineFunctionSuppress"
tee: "#/components/schemas/PipelineFunctionTee"
trim_timestamp: "#/components/schemas/PipelineFunctionTrimTimestamp"
union: "#/components/schemas/PipelineFunctionUnion"
unroll: "#/components/schemas/PipelineFunctionUnroll"
window: "#/components/schemas/PipelineFunctionWindow"
xml_unroll: "#/components/schemas/PipelineFunctionXmlUnroll"
CollectorBase:
type: object
required:
- type
- conf
properties:
type:
type: string
description: Collector type
conf:
type: object
description: Collector configuration
destructive:
type: boolean
description: Delete any files collected (where applicable)
encoding:
type: string
description: Character encoding to use when parsing ingested data.
description: Base collector schema
AzureBlobAuthTypeManual:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeManual"
connectionString:
type: string
title: Connection string
description: Enter your Azure storage account Connection String. If left blank,
Cribl Stream will fall back to env.AZURE_STORAGE_CONNECTION_STRING.
__template_connectionString:
type: string
description: Binds 'connectionString' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'connectionString' at runtime.
required:
- connectionString
AzureBlobAuthTypeSecret:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthTypeOptionsAzureBlobAuthTypeSecret"
textSecret:
type: string
title: Connection string (text secret)
description: Text secret
required:
- textSecret
AzureBlobAuthTypeClientSecret:
type: object
properties:
authType:
enum:
- clientSecret
type: string
description: Discriminator value.
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
clientTextSecret:
type: string
title: Client secret (text secret)
description: Text secret containing the client secret
endpointSuffix:
type: string
title: Endpoint suffix
description: The endpoint suffix for the service URL. Takes precedence over the
Azure Cloud setting. Defaults to core.windows.net.
azureCloud:
type: string
title: Azure Cloud
description: The Azure cloud to use. Defaults to Azure Public Cloud.
__template_storageAccountName:
type: string
description: Binds 'storageAccountName' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'storageAccountName' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_endpointSuffix:
type: string
description: Binds 'endpointSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpointSuffix' at
runtime.
__template_azureCloud:
type: string
description: Binds 'azureCloud' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'azureCloud' at runtime.
required:
- storageAccountName
- tenantId
- clientId
- clientTextSecret
AzureBlobAuthTypeClientCert:
type: object
properties:
authType:
enum:
- clientCert
type: string
description: Discriminator value.
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
certificate:
$ref: "#/components/schemas/CertificateTypeAzureBlobAuthTypeClientCert"
azureCloud:
type: string
title: Azure Cloud
description: The Azure cloud to use. Defaults to Azure Public Cloud.
endpointSuffix:
type: string
title: Endpoint suffix
description: The endpoint suffix for the service URL. Takes precedence over the
Azure Cloud setting. Defaults to core.windows.net.
required:
- storageAccountName
- tenantId
- clientId
- certificate
AzureBlobCollectorConf:
type: object
title: ""
required:
- containerName
properties:
outputName:
type: string
title: Auto-populate from
description: An optional predefined Destination that will be used to
auto-populate Collector settings
authType:
title: Authentication method
type: string
enum:
- manual
- secret
- clientSecret
- clientCert
description: Enter authentication data directly, or select a secret referencing
your auth data
x-speakeasy-unknown-values: allow
containerName:
type: string
title: Container name
minLength: 1
description: Container to collect from. 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}
path:
type: string
title: Path
description: The directory from which to collect data. Templating is supported,
such as myDir/${datacenter}/${host}/${app}/. Time-based tokens are
supported, such as myOtherDir/${_time:%Y}/${_time:%m}/${_time:%d}/.
minLength: 1
extractors:
type: array
title: Path extractors
additionalProperties: false
items:
type: object
required:
- key
- expression
properties:
key:
type: string
title: Token
description: A token from the template path, such as epoch
expression:
type: string
title: Extractor Expression
description: "A JavaScript expression that accesses a corresponding
through the value variable and evaluates the token to
populate event fields. Example: {date: new Date(+value*1000)}"
description: 'Extractors allow use of template tokens as context for expressions
that enrich discovery results. For example, given a template
/path/${epoch}, an extractor under key "epoch" with an expression
{date: new Date(+value*1000)} will enrich discovery results with a
human-readable "date" field.'
recurse:
type: boolean
title: Recursive
description: Recurse through subdirectories
includeMetadata:
type: boolean
title: Include metadata
description: "Include Azure Blob metadata in collected events. In each event,
metadata will be located at: __collectible.metadata."
includeTags:
type: boolean
title: Include tags
description: "Include Azure Blob tags in collected events. In each event, tags
will be located at: __collectible.tags. Disable this feature when
using a Shared Access Signature Connection String, to prevent
errors."
maxBatchSize:
type: number
title: Batch size limit
description: Maximum number of metadata objects to batch before recording as
results
minimum: 1
disableTimeFilter:
type: boolean
title: Disable time filter
description: Disable Collector event time filtering when a date range is specified
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit
description: Maximum file size for each Parquet chunk
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 abort if a chunk cannot be downloaded within the
time specified.
maximum: 3600
minimum: 1
connectionString:
type: string
title: Connection string
description: Enter your Azure storage account Connection String. If left blank,
Cribl Stream will fall back to env.AZURE_STORAGE_CONNECTION_STRING.
__template_connectionString:
type: string
description: Binds 'connectionString' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'connectionString' at runtime.
textSecret:
type: string
title: Connection string (text secret)
description: Text secret
storageAccountName:
type: string
title: Storage account name
description: The name of your Azure storage account
__template_storageAccountName:
type: string
description: Binds 'storageAccountName' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'storageAccountName' at runtime.
tenantId:
type: string
title: Tenant ID
description: The service principal's tenant ID
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
clientId:
type: string
title: Client ID
description: The service principal's client ID
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
clientTextSecret:
type: string
title: Client secret (text secret)
description: Text secret containing the client secret
endpointSuffix:
type: string
title: Endpoint suffix
description: The endpoint suffix for the service URL. Takes precedence over the
Azure Cloud setting. Defaults to core.windows.net.
__template_endpointSuffix:
type: string
description: Binds 'endpointSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpointSuffix' at
runtime.
azureCloud:
type: string
title: Azure Cloud
description: The Azure cloud to use. Defaults to Azure Public Cloud.
__template_azureCloud:
type: string
description: Binds 'azureCloud' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'azureCloud' at runtime.
certificate:
$ref: "#/components/schemas/CertificateTypeAzureBlobAuthTypeClientCert"
__template_containerName:
type: string
description: Binds 'containerName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'containerName' at runtime.
__template_path:
type: string
description: Binds 'path' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'path' at runtime.
allOf:
- oneOf:
- $ref: "#/components/schemas/AzureBlobAuthTypeManual"
- $ref: "#/components/schemas/AzureBlobAuthTypeSecret"
- $ref: "#/components/schemas/AzureBlobAuthTypeClientSecret"
- $ref: "#/components/schemas/AzureBlobAuthTypeClientCert"
discriminator:
propertyName: authType
mapping:
manual: "#/components/schemas/AzureBlobAuthTypeManual"
secret: "#/components/schemas/AzureBlobAuthTypeSecret"
clientSecret: "#/components/schemas/AzureBlobAuthTypeClientSecret"
clientCert: "#/components/schemas/AzureBlobAuthTypeClientCert"
CollectorAzureBlob:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- azure_blob
description: Collector type
conf:
$ref: "#/components/schemas/AzureBlobCollectorConf"
description: AzureBlob collector configuration
CriblLakeCollectorConf:
type: object
title: ""
required:
- dataset
properties:
storageLocationId:
type: string
title: Storage location
description: Storage location for the Lake Dataset
dataset:
type: string
title: Lake Dataset
description: Lake dataset to collect data from.
__template_dataset:
type: string
description: Binds 'dataset' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'dataset' at runtime.
CollectorCriblLake:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- cribl_lake
description: Collector type
conf:
$ref: "#/components/schemas/CriblLakeCollectorConf"
description: CriblLake collector configuration
DatabaseCollectorConf:
type: object
title: ""
required:
- connectionId
- query
properties:
connectionId:
type: string
title: Connection
description: Select an existing Connection, or go to Knowledge > Database
Connections to add one
query:
type: string
title: SQL Query
description: An expression that resolves to the query string for selecting data
from the database. Has access to the special ${earliest} and
${latest} variables, which will resolve to the Collector run's start
and end time.
minLength: 1
queryValidationEnabled:
type: boolean
title: Validate Query
description: "Enforces a basic query validation that allows only a single
'select' statement. Disable for more complex queries or when using
semicolons. Caution: Disabling query validation allows DDL and DML
statements to be executed, which could be destructive to your
database."
defaultBreakers:
$ref: "#/components/schemas/HiddenDefaultBreakersOptionsDatabaseCollectorConf"
__scheduling:
type: object
properties:
stateTracking:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enable tracking of collection progress between consecutive
scheduled executions.
__template_query:
type: string
description: Binds 'query' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'query' at runtime.
CollectorDatabase:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- database
description: Collector type
conf:
$ref: "#/components/schemas/DatabaseCollectorConf"
description: Database collector configuration
FilesystemCollectorConf:
type: object
title: ""
required:
- path
properties:
outputName:
type: string
title: Auto-populate from
description: Select a predefined configuration (a Destination) to auto-populate
Collector settings
path:
type: string
title: Directory
description: The directory from which to collect data. Templating is supported,
such as /myDir/${datacenter}/${host}/${app}/. Time-based tokens are
also supported, such as
/myOtherDir/${_time:%Y}/${_time:%m}/${_time:%d}/.
minLength: 1
extractors:
type: array
title: Path extractors
additionalProperties: false
items:
type: object
required:
- key
- expression
properties:
key:
type: string
title: Token
description: A token from the template directory, such as epoch
expression:
type: string
title: Extractor expression
description: 'JavaScript expression that receives token under "value" variable,
and evaluates to populate event fields, such as {date: new
Date(+value*1000)}'
description: 'Allows using template tokens as context for expressions that
enrich discovery results. For example, given a template
/path/${epoch}, an extractor under key "epoch" with an expression
{date: new Date(+value*1000)}, will enrich discovery results with a
human readable "date" field.'
recurse:
type: boolean
title: Recursive
description: Recurse through subdirectories
maxBatchSize:
type: number
title: Batch size limit (files)
description: Maximum number of metadata files to batch before recording as results
minimum: 1
__template_path:
type: string
description: Binds 'path' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'path' at runtime.
CollectorFilesystem:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- filesystem
description: Collector type
conf:
$ref: "#/components/schemas/FilesystemCollectorConf"
description: Filesystem collector configuration
GoogleCloudStorageAuthTypeAuto:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthTypeOptionsGoogleCloudStorageAuthTypeAuto"
GoogleCloudStorageAuthTypeManual:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeManual"
serviceAccountCredentials:
type: string
title: Service account credentials
description: Contents of Google Cloud service account credentials (JSON keys)
file. To upload a file, click the upload button at this field's
upper right.
required:
- serviceAccountCredentials
GoogleCloudStorageAuthTypeSecret:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthTypeOptionsAzureBlobAuthTypeSecret"
textSecret:
type: string
title: Service account credentials (text secret)
description: Select or create a stored text secret that references your
credentials
required:
- textSecret
GoogleCloudStorageCollectorConf:
type: object
title: ""
required:
- bucket
properties:
outputName:
type: string
title: Auto-populate from
description: Name of the predefined Destination that will be used to
auto-populate Collector settings
bucket:
type: string
title: Bucket name
minLength: 1
description: "Name of the bucket to collect from. 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}`."
path:
type: string
title: Path
description: The directory from which to collect data. Templating is supported,
such as myDir/${datacenter}/${host}/${app}/. Time-based tokens are
also supported, such as
myOtherDir/${_time:%Y}/${_time:%m}/${_time:%d}/.
minLength: 1
extractors:
type: array
title: Path extractors
additionalProperties: false
items:
type: object
required:
- key
- expression
properties:
key:
type: string
title: Token
description: A token from the template path, such as epoch
expression:
type: string
title: Extractor Expression
description: 'JavaScript expression that receives token under "value" variable,
and evaluates to populate event fields, such as {date: new
Date(+value*1000)}'
description: 'Allows using template tokens as context for expressions that
enrich discovery results. For example, given a template
/path/${epoch}, an extractor under key "epoch" with an expression
{date: new Date(+value*1000)}, will enrich discovery results with a
human readable "date" field.'
endpoint:
type: string
title: Endpoint
description: Google Cloud Storage service endpoint. If empty, the endpoint will
default to https://storage.googleapis.com.
disableTimeFilter:
type: boolean
title: Disable time filter
description: Used to disable Collector event time filtering when a date range is
specified
recurse:
type: boolean
title: Recursive
description: Recurse through subdirectories
maxBatchSize:
type: number
title: Batch size limit (objects)
description: Maximum number of metadata objects to batch before recording as
results
minimum: 1
authType:
title: Authentication method
type: string
enum:
- auto
- manual
- secret
description: Enter account credentials manually, select a secret that references
your credentials, or use Google Application Default Credentials
x-speakeasy-unknown-values: allow
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit (MB)
description: Maximum file size for each Parquet chunk
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 abort if a chunk cannot be downloaded within the
time specified.
maximum: 3600
minimum: 1
serviceAccountCredentials:
type: string
title: Service account credentials
description: Contents of Google Cloud service account credentials (JSON keys)
file. To upload a file, click the upload button at this field's
upper right.
textSecret:
type: string
title: Service account credentials (text secret)
description: Select or create a stored text secret that references your
credentials
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_path:
type: string
description: Binds 'path' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'path' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
allOf:
- oneOf:
- $ref: "#/components/schemas/GoogleCloudStorageAuthTypeAuto"
- $ref: "#/components/schemas/GoogleCloudStorageAuthTypeManual"
- $ref: "#/components/schemas/GoogleCloudStorageAuthTypeSecret"
discriminator:
propertyName: authType
mapping:
auto: "#/components/schemas/GoogleCloudStorageAuthTypeAuto"
manual: "#/components/schemas/GoogleCloudStorageAuthTypeManual"
secret: "#/components/schemas/GoogleCloudStorageAuthTypeSecret"
CollectorGoogleCloudStorage:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- google_cloud_storage
description: Collector type
conf:
$ref: "#/components/schemas/GoogleCloudStorageCollectorConf"
description: GoogleCloudStorage collector configuration
HealthCheckCollectMethodGet:
type: object
properties:
collectMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodGet"
collectRequestParams:
title: Health check parameters
description: Optional health check request parameters.
type: array
items:
type: object
required:
- name
- value
properties:
name:
title: Name
type: string
description: Parameter name
value:
title: Value
type: string
description: JavaScript expression to compute the parameter value (can be a
constant).
HealthCheckCollectMethodPost:
type: object
properties:
collectMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPost"
collectRequestParams:
title: Health check parameters
description: Optional health check request parameters.
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfHealthCheckCollectMethodPost"
HealthCheckCollectMethodPostWithBody:
type: object
properties:
collectMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPostWit\
hBody"
collectBody:
type: string
title: Health check POST Body
description: "Template for POST body to send with the health check request. You
can reference parameters from the Discover response, using template
params of the form: ${variable}."
HealthCheckAuthenticationNone:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
HealthCheckAuthenticationBasic:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationBasic"
username:
type: string
title: Username
description: Basic authentication username
password:
type: string
title: Password
description: Basic authentication password
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
required:
- username
- password
HealthCheckAuthenticationBasicSecret:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationBasic\
Secret"
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your credentials
required:
- credentialsSecret
HealthCheckAuthenticationLogin:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationLogin"
loginUrl:
type: string
title: Login URL
description: URL to use for login API call. This call is expected to be a POST.
username:
type: string
title: Username
description: Login username
minLength: 1
password:
type: string
title: Password
description: Login password
minLength: 1
loginBody:
type: string
title: POST body
description: Template for POST body to send with login request, ${username} and
${password} are used to specify location of these attributes in the
message
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
authHeaderExpr:
type: string
title: Authorize Expression
description: JavaScript expression to compute the Authorization header to pass
in discover and collect calls. The value ${token} is used to
reference the token obtained from login.
authRequestHeaders:
title: Authentication Headers
description: Optional authentication request headers.
type: array
items:
$ref: "#/components/schemas/AuthRequestHeaderConfHealthCheckAuthenticationLogin"
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
__template_tokenRespAttribute:
type: string
description: Binds 'tokenRespAttribute' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'tokenRespAttribute' at runtime.
required:
- loginUrl
- username
- password
- loginBody
- authHeaderExpr
HealthCheckAuthenticationLoginSecret:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationLogin\
Secret"
loginUrl:
type: string
title: Login URL
description: URL to use for login API call, this call is expected to be a POST.
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your login
credentials
loginBody:
type: string
title: POST body
description: Template for POST body to send with login request, ${username} and
${password} are used to specify location of these attributes in the
message
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. If left blank, the entire response body will be used to
derive the authorization header.
authHeaderExpr:
type: string
title: Authorize Expression
description: JavaScript expression to compute the Authorization header to pass
in discover and collect calls. The value ${token} is used to
reference the token obtained from login.
authRequestHeaders:
title: Authentication Headers
description: Optional authentication request headers.
type: array
items:
$ref: "#/components/schemas/AuthRequestHeaderConfHealthCheckAuthenticationLogin"
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_tokenRespAttribute:
type: string
description: Binds 'tokenRespAttribute' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'tokenRespAttribute' at runtime.
required:
- loginUrl
- credentialsSecret
- loginBody
- authHeaderExpr
HealthCheckAuthenticationOauth:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationOauth"
loginUrl:
type: string
title: Login URL
description: URL to use for the OAuth API call. This call is expected to be a
POST.
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
authHeaderExpr:
type: string
title: Authorize expression
description: JavaScript expression to compute the Authorization header to pass
in discover and collect calls. The value ${token} is used to
reference the token obtained from login.
clientSecretParamName:
type: string
title: Client secret parameter
description: Parameter name that contains client secret. Defaults to
'client_secret', and is automatically added to request parameters.
clientSecretParamValue:
type: string
title: Client secret value
description: Secret value to add to HTTP requests as the 'client secret'
parameter. Stored on disk encrypted, and is automatically added to
request parameters
authRequestParams:
title: Extra authentication parameters
description: OAuth request parameters added to the POST body. The Content-Type
header will automatically be set to
application/x-www-form-urlencoded.
type: array
items:
$ref: "#/components/schemas/AuthRequestParamConfHealthCheckAuthenticationOauth"
authRequestHeaders:
title: Authentication headers
description: Optional authentication request headers.
type: array
items:
$ref: "#/components/schemas/AuthRequestHeaderConfHealthCheckAuthenticationOauth"
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, the Collector uses the refresh
token to obtain new access tokens without re-sending credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: The Collector will update its stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use.
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, the Collector sends
only grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
th"
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_tokenRespAttribute:
type: string
description: Binds 'tokenRespAttribute' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'tokenRespAttribute' at runtime.
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
required:
- loginUrl
- clientSecretParamName
- clientSecretParamValue
- authHeaderExpr
HealthCheckAuthenticationOauthSecret:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationOauth\
Secret"
loginUrl:
type: string
title: Login URL
description: URL to use for the OAuth API call. This call is expected to be a
POST.
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
authHeaderExpr:
type: string
title: Authorize expression
description: JavaScript expression to compute the Authorization header to pass
in discover and collect calls. The value ${token} is used to
reference the token obtained from login.
clientSecretParamName:
type: string
title: Client secret parameter
description: Parameter name that contains client secret. Defaults to
'client_secret', and is automatically added to request parameters.
textSecret:
type: string
title: Client secret value (text secret)
description: Select or create a text secret that contains the client secret's
value.
authRequestParams:
title: Extra authentication parameters
description: OAuth request parameters added to the POST body. The Content-Type
header will automatically be set to
application/x-www-form-urlencoded.
type: array
items:
$ref: "#/components/schemas/AuthRequestParamConfHealthCheckAuthenticationOauth"
authRequestHeaders:
title: Authentication headers
description: Optional authentication request headers.
type: array
items:
$ref: "#/components/schemas/AuthRequestHeaderConfHealthCheckAuthenticationOauth"
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, the Collector uses the refresh
token to obtain new access tokens without re-sending credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: The Collector will update its stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use.
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, the Collector sends
only grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_tokenRespAttribute:
type: string
description: Binds 'tokenRespAttribute' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'tokenRespAttribute' at runtime.
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
required:
- loginUrl
- clientSecretParamName
- textSecret
- authHeaderExpr
HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet:
type: object
properties:
discoverMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodGet"
discoverRequestParams:
title: Discover parameters
description: Optional discover request parameters.
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfHealthCheckCollectMethodPost"
HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodPost:
type: object
properties:
discoverMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPost"
discoverRequestParams:
title: Discover parameters
description: Optional discover request parameters.
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfHealthCheckCollectMethodPost"
HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodPostWithBody:
type: object
properties:
discoverMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPostWit\
hBody"
discoverBody:
type: string
title: Discover POST body
description: Template for POST body to send with the discover request.
HealthCheckDiscoveryDiscoverTypeHttp:
type: object
properties:
discoverType:
$ref: "#/components/schemas/DiscoverTypeOptionsHealthCheckDiscoveryDiscoverType\
Http"
discoverUrl:
type: string
title: Discover URL
description: Expression to derive URL to use for the Discover operation (can be
a constant).
discoverMethod:
$ref: "#/components/schemas/DiscoverMethodOptionsHealthCheckDiscoveryDiscoverTy\
peHttp"
discoverRequestHeaders:
title: Discover Headers
description: Optional discover request headers.
type: array
items:
$ref: "#/components/schemas/AuthRequestHeaderConfHealthCheckAuthenticationLogin"
discoverDataField:
type: string
title: Discover Data Field
description: "Path to field in the response object which contains discover
results (e.g.: level1.name), leave blank if the result is an array."
__template_discoverUrl:
type: string
description: Binds 'discoverUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'discoverUrl' at runtime.
__template_discoverDataField:
type: string
description: Binds 'discoverDataField' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'discoverDataField' at runtime.
required:
- discoverUrl
- discoverMethod
allOf:
- oneOf:
- $ref: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodG\
et"
- $ref: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodP\
ost"
- $ref: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodP\
ostWithBody"
discriminator:
propertyName: discoverMethod
mapping:
get: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGe\
t"
post: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodP\
ost"
post_with_body: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttpDisco\
verMethodPostWithBody"
HealthCheckDiscoveryDiscoverTypeJson:
type: object
properties:
discoverType:
$ref: "#/components/schemas/DiscoverTypeOptionsHealthCheckDiscoveryDiscoverType\
Json"
manualDiscoverResult:
type: string
title: Discover result
description: Allows hard-coding the Discover result. Must be a JSON object.
Works with the Discover Data field.
discoverDataField:
type: string
title: Discover data field
description: "Within the response JSON, name of the field or array element to
pull results from. Leave blank if the result is an array of values.
Sample entry: items, json: { items: [{id: 'first'},{id: 'second'}]
}"
required:
- manualDiscoverResult
HealthCheckDiscoveryDiscoverTypeList:
type: object
properties:
discoverType:
$ref: "#/components/schemas/DiscoverTypeOptionsHealthCheckDiscoveryDiscoverType\
List"
itemList:
type: array
title: Discover items
description: Comma-separated list of items to return from the Discover task.
Each item returned will generate a collect task, and can be
referenced using `${id}` in the collect URL, headers, or parameters.
minItems: 1
items:
type: string
title: Items
description: List of items to return from discovery.
required:
- itemList
HealthCheckDiscoveryDiscoverTypeNone:
type: object
properties:
discoverType:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
HealthCheckRetryRulesTypeNone:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeNone"
HealthCheckRetryRulesTypeStatic:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeStatic"
interval:
type: number
title: Wait (ms)
description: Time interval between retries. Maximum allowed value is 20,000 ms
(1/3 minute).
minimum: 0
maximum: 20000
limit:
type: number
title: Retry limit
description: The maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
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
items:
type: number
minimum: 100
maximum: 599
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.
HealthCheckRetryRulesTypeBackoff:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeBackoff"
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
limit:
type: number
title: Retry limit
description: The maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
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
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
items:
type: number
minimum: 100
maximum: 599
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.
HealthCheckCollectorConf:
type: object
title: ""
required:
- collectUrl
- collectMethod
- authentication
properties:
discovery:
type: object
required:
- discoverType
properties:
discoverType:
type: string
title: Discover Type
description: Defines how task discovery will be performed. Use None to skip the
discovery. Use HTTP Request to make a REST call to discover
tasks. Use Item List to enumerate items for collect to retrieve.
Use JSON Response to manually define discover tasks as a JSON
array of objects. Each entry returned by the discover operation
will result in a collect task.
enum:
- http
- json
- list
- none
x-speakeasy-enum-descriptions:
- HTTP Request
- JSON Response
- Item List
- None
x-speakeasy-unknown-values: allow
discoverUrl:
type: string
title: Discover URL
description: Expression to derive URL to use for the Discover operation (can be
a constant).
__template_discoverUrl:
type: string
description: Binds 'discoverUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'discoverUrl' at
runtime.
discoverMethod:
$ref: "#/components/schemas/DiscoverMethodOptionsHealthCheckDiscoveryDiscoverTy\
peHttp"
discoverRequestHeaders:
title: Discover Headers
description: Optional discover request headers.
type: array
items:
$ref: "#/components/schemas/AuthRequestHeaderConfHealthCheckAuthenticationLogin"
discoverDataField:
type: string
title: Discover Data Field
description: "Path to field in the response object which contains discover
results (e.g.: level1.name), leave blank if the result is an
array."
__template_discoverDataField:
type: string
description: Binds 'discoverDataField' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'discoverDataField' at runtime.
manualDiscoverResult:
type: string
title: Discover result
description: Allows hard-coding the Discover result. Must be a JSON object.
Works with the Discover Data field.
itemList:
type: array
title: Discover items
description: Comma-separated list of items to return from the Discover task.
Each item returned will generate a collect task, and can be
referenced using `${id}` in the collect URL, headers, or
parameters.
minItems: 1
items:
type: string
title: Items
description: List of items to return from discovery.
allOf:
- oneOf:
- $ref: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttp"
- $ref: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeJson"
- $ref: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeList"
- $ref: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeNone"
discriminator:
propertyName: discoverType
mapping:
http: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeHttp"
json: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeJson"
list: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeList"
none: "#/components/schemas/HealthCheckDiscoveryDiscoverTypeNone"
collectUrl:
type: string
title: Health check URL
description: Expression to derive URL to use for the health check operation (can
be a constant).
collectMethod:
type: string
title: Health check method
description: Health check HTTP method.
enum:
- get
- post
- post_with_body
x-speakeasy-enum-descriptions:
- GET
- POST
- POST with Body
x-speakeasy-unknown-values: allow
collectRequestHeaders:
title: Health check headers
description: Optional health check request headers.
type: array
items:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: Header Name
value:
type: string
title: Value
description: JavaScript expression to compute the header value (can be a
constant).
authenticateCollect:
type: boolean
title: Authenticate health check
description: Enable to make auth health check call.
authentication:
type: string
title: Authentication
description: Authentication method for Discover and Collect REST calls. You can
specify API Key–based authentication by adding the appropriate
Collect headers.
enum:
- none
- basic
- basicSecret
- login
- loginSecret
- oauth
- oauthSecret
x-speakeasy-unknown-values: allow
timeout:
type: number
title: Request Timeout (secs)
description: HTTP request inactivity timeout, use 0 to disable
minimum: 0
maximum: 1800
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).
defaultBreakers:
$ref: "#/components/schemas/HiddenDefaultBreakersOptionsDatabaseCollectorConf"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text.
items:
type: string
retryRules:
type: object
required:
- type
properties:
type:
$ref: "#/components/schemas/RetryTypeOptionsHealthCheckCollectorConfRetryRules"
allOf:
- oneOf:
- $ref: "#/components/schemas/HealthCheckRetryRulesTypeNone"
- $ref: "#/components/schemas/HealthCheckRetryRulesTypeStatic"
- $ref: "#/components/schemas/HealthCheckRetryRulesTypeBackoff"
discriminator:
propertyName: type
mapping:
none: "#/components/schemas/HealthCheckRetryRulesTypeNone"
static: "#/components/schemas/HealthCheckRetryRulesTypeStatic"
backoff: "#/components/schemas/HealthCheckRetryRulesTypeBackoff"
username:
type: string
title: Username
description: Basic authentication username
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
password:
type: string
title: Password
description: Basic authentication password
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your credentials
loginUrl:
type: string
title: Login URL
description: URL to use for login API call. This call is expected to be a POST.
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
loginBody:
type: string
title: POST body
description: Template for POST body to send with login request, ${username} and
${password} are used to specify location of these attributes in the
message
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
__template_tokenRespAttribute:
type: string
description: Binds 'tokenRespAttribute' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'tokenRespAttribute' at runtime.
authHeaderExpr:
type: string
title: Authorize Expression
description: JavaScript expression to compute the Authorization header to pass
in discover and collect calls. The value ${token} is used to
reference the token obtained from login.
authRequestHeaders:
title: Authentication Headers
description: Optional authentication request headers.
type: array
items:
$ref: "#/components/schemas/AuthRequestHeaderConfHealthCheckAuthenticationLogin"
clientSecretParamName:
type: string
title: Client secret parameter
description: Parameter name that contains client secret. Defaults to
'client_secret', and is automatically added to request parameters.
clientSecretParamValue:
type: string
title: Client secret value
description: Secret value to add to HTTP requests as the 'client secret'
parameter. Stored on disk encrypted, and is automatically added to
request parameters
authRequestParams:
title: Extra authentication parameters
description: OAuth request parameters added to the POST body. The Content-Type
header will automatically be set to
application/x-www-form-urlencoded.
type: array
items:
$ref: "#/components/schemas/AuthRequestParamConfHealthCheckAuthenticationOauth"
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, the Collector uses the refresh
token to obtain new access tokens without re-sending credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: The Collector will update its stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use.
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, the Collector sends
only grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
th"
textSecret:
type: string
title: Client secret value (text secret)
description: Select or create a text secret that contains the client secret's
value.
__template_collectUrl:
type: string
description: Binds 'collectUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'collectUrl' at runtime.
allOf:
- oneOf:
- $ref: "#/components/schemas/HealthCheckCollectMethodGet"
- $ref: "#/components/schemas/HealthCheckCollectMethodPost"
- $ref: "#/components/schemas/HealthCheckCollectMethodPostWithBody"
discriminator:
propertyName: collectMethod
mapping:
get: "#/components/schemas/HealthCheckCollectMethodGet"
post: "#/components/schemas/HealthCheckCollectMethodPost"
post_with_body: "#/components/schemas/HealthCheckCollectMethodPostWithBody"
- oneOf:
- $ref: "#/components/schemas/HealthCheckAuthenticationNone"
- $ref: "#/components/schemas/HealthCheckAuthenticationBasic"
- $ref: "#/components/schemas/HealthCheckAuthenticationBasicSecret"
- $ref: "#/components/schemas/HealthCheckAuthenticationLogin"
- $ref: "#/components/schemas/HealthCheckAuthenticationLoginSecret"
- $ref: "#/components/schemas/HealthCheckAuthenticationOauth"
- $ref: "#/components/schemas/HealthCheckAuthenticationOauthSecret"
discriminator:
propertyName: authentication
mapping:
none: "#/components/schemas/HealthCheckAuthenticationNone"
basic: "#/components/schemas/HealthCheckAuthenticationBasic"
basicSecret: "#/components/schemas/HealthCheckAuthenticationBasicSecret"
login: "#/components/schemas/HealthCheckAuthenticationLogin"
loginSecret: "#/components/schemas/HealthCheckAuthenticationLoginSecret"
oauth: "#/components/schemas/HealthCheckAuthenticationOauth"
oauthSecret: "#/components/schemas/HealthCheckAuthenticationOauthSecret"
CollectorHealthCheck:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- health_check
description: Collector type
conf:
$ref: "#/components/schemas/HealthCheckCollectorConf"
description: HealthCheck collector configuration
RestCollectMethodGet:
type: object
properties:
collectMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodGet"
collectRequestParams:
title: Collect parameters
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Collect parameters
RestCollectMethodPost:
type: object
properties:
collectMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPost"
collectRequestParams:
title: Collect parameters
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Collect parameters
RestCollectMethodPostWithBody:
type: object
properties:
collectMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPostWit\
hBody"
collectBody:
type: string
title: Collect POST body
description: "Template for POST body to send with the Collect request. Reference
global variables, functions, or parameters from the Discover
response using template params: `${C.vars.myVar}`, or
`${Date.now()}`, `${param}`"
required:
- collectBody
RestCollectMethodOther:
type: object
properties:
collectMethod:
$ref: "#/components/schemas/CollectMethodOptionsRestCollectMethodOther"
collectVerb:
type: string
title: Collect verb
description: Custom HTTP method to use for the Collect operation
collectBody:
type: string
title: Collect body
description: "Template for body to send with the Collect request. Reference
global variables, functions, or parameters from the Discover
response using template parameters: `${C.vars.myVar}`, or
`${Date.now()}`, `${param}`"
collectRequestParams:
title: Collect parameters
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Collect parameters
required:
- collectVerb
RestAuthenticationNone:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
RestAuthenticationBasic:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationBasic"
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: Password
required:
- username
- password
RestAuthenticationBasicSecret:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationBasic\
Secret"
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your credentials
required:
- credentialsSecret
RestAuthenticationLogin:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationLogin"
loginUrl:
type: string
title: Login URL
description: URL to use for login API call. This call is expected to be a POST.
username:
type: string
title: Login username
minLength: 1
description: Login username
password:
type: string
title: Login password
minLength: 1
description: Login password
loginBody:
type: string
title: POST body
description: Template for POST body to send with login request. ${username} and
${password} are used to specify location of these attributes in the
message. For x-www-form-urlencoded bodies, wrap values with
${C.Encode.uri(password)} to preserve special characters like +, &,
and =.
getAuthTokenFromHeader:
type: boolean
title: Get auth token from header
description: Extract the auth token from the HTTP 'Authorization' response
header instead of the standard JSON body of the login response
authHeaderKey:
type: string
title: Authorization header
description: Authorization header key to pass in Discover and Collect calls.
Defaults to the literal name 'Authorization'.
authHeaderExpr:
type: string
title: Authorize expression
description: JavaScript expression used to compute the Authorization header to
pass in Discover and Collect calls. The value ${token} is used to
reference the token obtained from login.
authRequestHeaders:
title: Authentication headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Authentication headers
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
required:
- loginUrl
- username
- password
- loginBody
- authHeaderExpr
RestAuthenticationLoginSecret:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationLogin\
Secret"
loginUrl:
type: string
title: Login URL
description: URL to use for login API call. This call is expected to be a POST.
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your login
credentials
loginBody:
type: string
title: POST body
description: Template for POST body to send with login request. ${username} and
${password} are used to specify location of these attributes in the
message. For x-www-form-urlencoded bodies, wrap values with
${C.Encode.uri(password)} to preserve special characters like +, &,
and =.
getAuthTokenFromHeader:
type: boolean
title: Get auth token from header
description: Extract the auth token from the HTTP 'Authorization' response
header instead of the standard JSON body of the login response
authHeaderKey:
type: string
title: Authorization header
description: Authorization header key to pass in Discover and Collect calls.
Defaults to the literal name 'Authorization'.
authHeaderExpr:
type: string
title: Authorize expression
description: JavaScript expression to compute the Authorization header to pass
in Discover and Collect calls. The value ${token} is used to
reference the token obtained from login.
authRequestHeaders:
title: Authentication headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Authentication headers
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
required:
- loginUrl
- credentialsSecret
- loginBody
- authHeaderExpr
RestAuthenticationOauth:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationOauth"
loginUrl:
type: string
title: Login URL
description: URL to use for the OAuth API call. This call is expected to be a
POST.
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
authHeaderKey:
type: string
title: Authorization header
description: Authorization header key to pass in Discover and Collect calls.
Defaults to the literal name 'Authorization'.
authHeaderExpr:
type: string
title: Authorize expression
description: JavaScript expression to compute the Authorization header to pass
in Discover and Collect calls. The value ${token} is used to
reference the token obtained from login.
clientSecretParamName:
type: string
title: Client secret parameter
description: Defaults to 'client_secret'. Automatically added to request
parameters using the value specified.
clientSecretParamValue:
type: string
title: Client secret value
description: Secret value to add to HTTP requests as the 'client secret'
parameter. Value is stored encrypted on disk and automatically added
to request parameters.
authRequestParams:
title: Extra authentication parameters
description: OAuth request parameters added to the POST body. The Content-Type
header will automatically be set to
application/x-www-form-urlencoded.
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
authRequestHeaders:
title: Authentication headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Authentication headers
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, the Collector uses the refresh
token to obtain new access tokens without re-sending credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: The Collector will update its stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use.
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, the Collector sends
only grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
th"
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_clientSecretParamValue:
type: string
description: Binds 'clientSecretParamValue' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'clientSecretParamValue' at runtime.
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
required:
- loginUrl
- clientSecretParamName
- clientSecretParamValue
- authHeaderExpr
RestAuthenticationOauthSecret:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationOauth\
Secret"
loginUrl:
type: string
title: Login URL
description: URL to use for the OAuth API call. This call is expected to be a
POST.
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
authHeaderKey:
type: string
title: Authorization header
description: Authorization header key to pass in Discover and Collect calls.
Defaults to the literal name 'Authorization'.
authHeaderExpr:
type: string
title: Authorize expression
description: JavaScript expression to compute the Authorization header to pass
in Discover and Collect calls. The value ${token} is used to
reference the token obtained from login.
clientSecretParamName:
type: string
title: Client secret parameter
description: Defaults to 'client_secret'. Automatically added to request
parameters using the value specified.
textSecret:
type: string
title: Client secret value (text secret)
description: Select or create a text secret that contains the client secret's
value
authRequestParams:
title: Extra authentication parameters
description: OAuth request parameters added to the POST body. The Content-Type
header will automatically be set to
application/x-www-form-urlencoded.
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
authRequestHeaders:
title: Authentication headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Authentication headers
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, the Collector uses the refresh
token to obtain new access tokens without re-sending credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: The Collector will update its stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use.
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, the Collector sends
only grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
required:
- loginUrl
- clientSecretParamName
- textSecret
- authHeaderExpr
RestAuthenticationGoogleOauth:
type: object
properties:
authentication:
enum:
- google_oauth
type: string
description: Discriminator value.
scopes:
type: array
title: Scopes
description: Scopes to use during authentication. See [Google's
docs](https://developers.google.com/identity/protocols/oauth2/scopes)
for more information.
minItems: 1
items:
type: string
minLength: 1
serviceAccountCredentials:
type: string
title: Service account credentials
description: Contents of Google Cloud service account credentials (JSON keys)
file. To upload a file, click the upload icon in this field's upper
right.
minLength: 1
subject:
type: string
title: Impersonated account's email address
description: Email address of a user account with Super Admin permissions to the
resources the collector will retrieve
__template_serviceAccountCredentials:
type: string
description: Binds 'serviceAccountCredentials' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serviceAccountCredentials' at runtime.
__template_subject:
type: string
description: Binds 'subject' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'subject' at runtime.
required:
- scopes
- serviceAccountCredentials
- subject
RestAuthenticationGoogleOauthSecret:
type: object
properties:
authentication:
enum:
- google_oauthSecret
type: string
description: Discriminator value.
scopes:
type: array
title: Scopes
description: Scopes to use during authentication. See [Google's
docs](https://developers.google.com/identity/protocols/oauth2/scopes)
for more information.
minItems: 1
items:
type: string
minLength: 1
textSecret:
type: string
title: Service account credentials (text secret)
description: Select or create a text secret that contains the Google service
account credentials value
subject:
type: string
title: Impersonated account's email address
description: Email address of a user account with Super Admin permissions to the
resources the collector will retrieve
__template_subject:
type: string
description: Binds 'subject' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'subject' at runtime.
required:
- scopes
- textSecret
- subject
RestAuthenticationHmac:
type: object
properties:
authentication:
enum:
- hmac
type: string
description: Discriminator value.
hmacFunctionId:
type: string
title: HMAC Function
description: Select or create an HMAC Function to use with authentication
required:
- hmacFunctionId
RestDiscoveryDiscoverTypeHttpPaginationTypeNone:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeNone"
RestDiscoveryDiscoverTypeHttpPaginationTypeResponseBody:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeResponseBody"
attribute:
type:
- array
- string
title: Response attributes
description: Names of attributes within the response that contain next-page
information
items:
type: string
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve for the discover task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
lastPageExpr:
type: string
title: Last-page expression
description: JavaScript expression used to determine when the last page has been
reached. The values tested by this expression must be in the
Response attributes section.
required:
- attribute
- maxPages
RestDiscoveryDiscoverTypeHttpPaginationTypeResponseHeader:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeResponseHeader"
attribute:
type:
- array
- string
title: Response attributes
description: Names of attributes within the response that contain next-page
information
items:
type: string
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve for the discover task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
required:
- attribute
- maxPages
RestDiscoveryDiscoverTypeHttpPaginationTypeResponseHeaderLink:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeResponseHeaderLink"
nextRelationAttribute:
type: string
title: Next page relation name
description: 'Relation name used in the link header that refers to the next page
in the result set. Example: rel="next" refers to the next page of
results: ; rel="next"'
curRelationAttribute:
type: string
title: Current page relation name
description: 'Relation name used in the link header that refers to the current
result set. Example: rel="self" refers to the current page of
results: ; rel="self" '
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve for the discover task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
required:
- nextRelationAttribute
- maxPages
RestDiscoveryDiscoverTypeHttpPaginationTypeRequestOffset:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeRequestOffset"
offsetField:
type: string
title: Offset field name
description: "Query string parameter that sets the index from which to begin
returning records. Example:
/api/v1/query?term=cribl&limit=100&offset=0"
offset:
type: number
title: Starting offset
description: Offset index from which to start request. Defaults to undefined,
which will start discovery from the first record.
limitField:
type: string
title: Limit field name
description: "Query string parameter that sets the number of records retrieved
per request. Example: /api/v1/query?term=cribl&limit=100&offset=0"
limit:
type: number
title: Record limit
description: Maximum number of records to retrieve per request
minimum: 1
totalRecordField:
type: string
title: Total record count field name
description: Name of the attribute in the response that contains the total
number of records for the query
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve for the discover task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
zeroIndexed:
type: boolean
title: Zero-based index
description: Enable to indicate that the first page in the requested data is at
index 0. Disabled by default, which indicates index 1.
required:
- maxPages
- zeroIndexed
- offsetField
- limitField
- limit
RestDiscoveryDiscoverTypeHttpPaginationTypeRequestPage:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeRequestPage"
pageField:
type: string
title: Page number field name
description: "Query string parameter that sets the page index to be returned.
Example: /api/v1/query?term=cribl&page_size=100&page_number=0"
page:
type: number
title: Starting page number
description: Page number from which to start request. Defaults to undefined,
which will start discovery from the first page.
sizeField:
type: string
title: Page size field name
description: "Query string parameter that sets the number of records retrieved
per request. Example:
/api/v1/query?term=cribl&page_size=100&page_number=0"
size:
type: number
title: Record limit
description: Maximum number of records to retrieve per page
minimum: 1
totalPageField:
type: string
title: Total page count field name
description: Name of the attribute in the response that contains the total
number of pages for the query
totalRecordField:
type: string
title: Total record count field name
description: Name of the attribute in the response that contains the total
number of records for the query
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve for the discover task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
zeroIndexed:
type: boolean
title: Zero-based index
description: Enable to indicate that the first page in the requested data is at
index 0. Disabled by default, which indicates index 1.
required:
- maxPages
- zeroIndexed
- pageField
- sizeField
- size
RestDiscoveryDiscoverTypeHttpDiscoverMethodGet:
type: object
properties:
discoverMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodGet"
discoverRequestParams:
title: Discover parameters
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Discover parameters
RestDiscoveryDiscoverTypeHttpDiscoverMethodPost:
type: object
properties:
discoverMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPost"
discoverRequestParams:
title: Discover parameters
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Discover parameters
RestDiscoveryDiscoverTypeHttpDiscoverMethodPostWithBody:
type: object
properties:
discoverMethod:
$ref: "#/components/schemas/CollectMethodOptionsHealthCheckCollectMethodPostWit\
hBody"
discoverBody:
type: string
title: Discover POST body
description: "Template for POST body to send with the discover request. To
reference global variables or functions, use template parameters: `{
myVar: ${C.vars.myVar}, secret: ${C.Secret('mySecret','text').value}
}`"
required:
- discoverBody
RestDiscoveryDiscoverTypeHttpDiscoverMethodOther:
type: object
properties:
discoverMethod:
$ref: "#/components/schemas/CollectMethodOptionsRestCollectMethodOther"
discoverVerb:
type: string
title: Discover verb
description: Custom HTTP method to use for the Discover operation
discoverBody:
type: string
title: Discover body
description: Template for body to send with the discover request
discoverRequestParams:
title: Discover parameters
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Discover parameters
required:
- discoverVerb
RestDiscoveryDiscoverTypeHttp:
type: object
properties:
discoverType:
$ref: "#/components/schemas/DiscoverTypeOptionsHealthCheckDiscoveryDiscoverType\
Http"
discoverUrl:
type: string
title: Discover URL
description: URL to use for the Discover operation. Can be a constant URL, or a
JavaScript expression to derive the URL.
discoverMethod:
$ref: "#/components/schemas/DiscoverMethodOptionsRestDiscoveryDiscoverTypeHttp"
discoverRequestHeaders:
title: Discover headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Discover headers
pagination:
$ref: "#/components/schemas/PaginationTypeRestDiscoveryDiscoverTypeHttp"
discoverDataField:
type: string
title: Discover data field
description: "Path to field in the response object that contains discovery
results (ex: level1.name). Leave blank if the result is an array."
enableStrictDiscoverParsing:
type: boolean
title: Strict discover response parsing
description: Explicitly set the discover response format. When disabled, best
effort parsing is used.
discoverResponseFormat:
type: string
title: Discover response format
description: If 'Strict discover response parsing' parsing is enabled, provide
the response format
enableDiscoverCode:
type: boolean
title: Format discover result with custom code
description: Format discover result with custom code
formatResultCode:
type: string
title: Format discover result
description: "Custom JavaScript code to format the discover result through the
__e variable which is a JSON object or array containing the original
discover results. The object or array passed should be manipulated
to contain the desired discover results, i.e.: __e['myResult'] =
[{lat: -1.1234, long: 2.345, zip: 11111},{lat: -1.235, long 2.346,
zip: 22222}] or ['11111','22222']. Caution: This function is
evaluated in an unprotected context, allowing you to execute almost
any JavaScript code."
__template_discoverUrl:
type: string
description: Binds 'discoverUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'discoverUrl' at runtime.
required:
- discoverUrl
- discoverMethod
allOf:
- oneOf:
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMethodGet"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMethodPost"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMethodPostWith\
Body"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMethodOther"
discriminator:
propertyName: discoverMethod
mapping:
get: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMethodGet"
post: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMethodPost"
post_with_body: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMeth\
odPostWithBody"
other: "#/components/schemas/RestDiscoveryDiscoverTypeHttpDiscoverMethodOther"
RestDiscoveryDiscoverTypeJson:
type: object
properties:
discoverType:
$ref: "#/components/schemas/DiscoverTypeOptionsHealthCheckDiscoveryDiscoverType\
Json"
manualDiscoverResult:
type: string
title: Discover result
description: Allows hard-coding the Discover result. Must be a JSON object or
array. Works with Discover data field.
discoverDataField:
type: string
title: Discover data field
description: "Within the response JSON, the name of the field to pull results
from, typically a JSON array. Leave blank if the result itself is an
array of values. Sample entry: items, json: { items: [{id:
'first'},{id: 'second'}] }"
required:
- manualDiscoverResult
RestDiscoveryDiscoverTypeList:
type: object
properties:
discoverType:
$ref: "#/components/schemas/DiscoverTypeOptionsHealthCheckDiscoveryDiscoverType\
List"
itemList:
type: array
title: Discover items
description: Comma-separated list of items to return from the Discover task.
Each item returned generates a Collect task and can be referenced
using `${id}` in the Collect URL, headers, or parameters.
minItems: 1
items:
type: string
title: Items
description: List of items to return from discovery
required:
- itemList
RestDiscoveryDiscoverTypeNone:
type: object
properties:
discoverType:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
RestPaginationTypeNone:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeNone"
RestPaginationTypeResponseBody:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeResponseBody"
attribute:
type:
- array
- string
title: Response attributes
description: Names of attributes within the response that contain next-page
information
items:
type: string
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
lastPageExpr:
type: string
title: Last-page expression
description: JavaScript expression used to determine when the last page has been
reached. The values tested by this expression must be in the
Response attributes section.
required:
- attribute
- maxPages
RestPaginationTypeResponseHeader:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeResponseHeader"
attribute:
type:
- array
- string
title: Response attributes
description: Names of attributes within the response that contain next-page
information
items:
type: string
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
required:
- attribute
- maxPages
RestPaginationTypeResponseHeaderLink:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeResponseHeaderLink"
nextRelationAttribute:
type: string
title: Next page relation name
description: 'Relation name used in the link header that refers to the next page
in the result set. Example: rel="next" refers to the next page of
results: ; rel="next"'
curRelationAttribute:
type: string
title: Current page relation name
description: 'Relation name used in the link header that refers to the current
result set. Example: rel="self" refers to the current page of
results: ; rel="self" '
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
required:
- nextRelationAttribute
- maxPages
RestPaginationTypeRequestOffset:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeRequestOffset"
offsetField:
type: string
title: Offset field name
description: "Query string parameter that sets the index from which to begin
returning records. Example:
/api/v1/query?term=cribl&limit=100&offset=0"
offset:
type: number
title: Starting offset
description: Offset index from which to start request. Defaults to undefined,
which will start collection from the first record.
limitField:
type: string
title: Limit field name
description: "Query string parameter that sets the number of records retrieved
per request. Example: /api/v1/query?term=cribl&limit=100&offset=0"
limit:
type: number
title: Record limit
description: Maximum number of records to collect per request
minimum: 1
totalRecordField:
type: string
title: Total record count field name
description: Name of the attribute in the response that contains the total
number of records for the query
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
zeroIndexed:
type: boolean
title: Zero-based index
description: Enable to indicate that the first page in the requested data is at
index 0. Disabled by default, which indicates index 1.
required:
- maxPages
- zeroIndexed
- offsetField
- limitField
- limit
RestPaginationTypeRequestPage:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationT\
ypeRequestPage"
pageField:
type: string
title: Page number field name
description: "Query string parameter that sets the page index to be returned.
Example: /api/v1/query?term=cribl&page_size=100&page_number=0"
page:
type: number
title: Starting page number
description: Page number from which to start request. Defaults to undefined,
which will start collection from the first page.
sizeField:
type: string
title: Page size field name
description: "Query string parameter that sets the number of records retrieved
per request. Example:
/api/v1/query?term=cribl&page_size=100&page_number=0"
size:
type: number
title: Record limit
description: Maximum number of records to collect per page
minimum: 1
totalPageField:
type: string
title: Total page count field name
description: Name of the attribute in the response that contains the total
number of pages for the query
totalRecordField:
type: string
title: Total record count field name
description: Name of the attribute in the response that contains the total
number of records for the query
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
zeroIndexed:
type: boolean
title: Zero-based index
description: Enable to indicate that the first page in the requested data is at
index 0. Disabled by default, which indicates index 1.
required:
- maxPages
- zeroIndexed
- pageField
- sizeField
- size
RestRetryRulesTypeNone:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeNone"
RestRetryRulesTypeStatic:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeStatic"
interval:
type: number
title: Wait (ms)
description: Time interval between retries. Maximum allowed value is 20,000 ms
(1/3 minute).
minimum: 0
maximum: 20000
limit:
type: number
title: Retry limit
description: Maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
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
items:
type: number
minimum: 100
maximum: 599
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 the `Longest interval between retries (ms)` value, even if the
Retry-After header specifies a longer delay. When disabled, all
Retry-After headers are ignored.
retryConnectTimeout:
type: boolean
title: Retry connection timeout
description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
error occurs
retryConnectReset:
type: boolean
title: Retry connection reset
description: Retry request when a connection reset (ECONNRESET) error occurs
retryHeaderName:
type: string
title: Retry-After header name
description: Retry-After header name
RestRetryRulesTypeBackoff:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeBackoff"
interval:
type: number
title: Initial retry interval (ms)
description: Time interval between a failed request and the first retry
minimum: 0
maximum: 20000
limit:
type: number
title: Retry limit
description: Maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
multiplier:
type: number
title: Backoff multiplier
description: "Base for exponential backoff. Example: base 2 means that retries
will occur after 2, then 4, then 8 seconds, and so on."
minimum: 1
maximum: 20
maxIntervalMs:
type: number
title: Longest interval between retries (ms)
minimum: 0
description: Longest interval between retries (ms)
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
items:
type: number
minimum: 100
maximum: 599
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 the `Longest interval between retries (ms)` value, even if the
Retry-After header specifies a longer delay. When disabled, all
Retry-After headers are ignored.
retryConnectTimeout:
type: boolean
title: Retry connection timeout
description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
error occurs
retryConnectReset:
type: boolean
title: Retry connection reset
description: Retry request when a connection reset (ECONNRESET) error occurs
retryHeaderName:
type: string
title: Retry-After header name
description: Retry-After header name
RestCollectorConf:
type: object
title: ""
required:
- collectUrl
- collectMethod
- authentication
properties:
discovery:
type: object
required:
- discoverType
properties:
discoverType:
type: string
title: Discover type
description: Defines how task discovery will be performed. Each entry returned
by the Discover operation will result in a Collect task.
enum:
- http
- json
- list
- none
x-speakeasy-unknown-values: allow
discoverUrl:
type: string
title: Discover URL
description: URL to use for the Discover operation. Can be a constant URL, or a
JavaScript expression to derive the URL.
__template_discoverUrl:
type: string
description: Binds 'discoverUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'discoverUrl' at
runtime.
discoverMethod:
$ref: "#/components/schemas/DiscoverMethodOptionsRestDiscoveryDiscoverTypeHttp"
discoverRequestHeaders:
title: Discover headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Discover headers
pagination:
$ref: "#/components/schemas/PaginationTypeRestDiscoveryDiscoverTypeHttp"
discoverDataField:
type: string
title: Discover data field
description: "Path to field in the response object that contains discovery
results (ex: level1.name). Leave blank if the result is an
array."
enableStrictDiscoverParsing:
type: boolean
title: Strict discover response parsing
description: Explicitly set the discover response format. When disabled, best
effort parsing is used.
enableDiscoverCode:
type: boolean
title: Format discover result with custom code
description: Format discover result with custom code
manualDiscoverResult:
type: string
title: Discover result
description: Allows hard-coding the Discover result. Must be a JSON object or
array. Works with Discover data field.
itemList:
type: array
title: Discover items
description: Comma-separated list of items to return from the Discover task.
Each item returned generates a Collect task and can be
referenced using `${id}` in the Collect URL, headers, or
parameters.
minItems: 1
items:
type: string
title: Items
description: List of items to return from discovery
allOf:
- oneOf:
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttp"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeJson"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeList"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeNone"
discriminator:
propertyName: discoverType
mapping:
http: "#/components/schemas/RestDiscoveryDiscoverTypeHttp"
json: "#/components/schemas/RestDiscoveryDiscoverTypeJson"
list: "#/components/schemas/RestDiscoveryDiscoverTypeList"
none: "#/components/schemas/RestDiscoveryDiscoverTypeNone"
collectUrl:
type: string
title: Collect URL
description: URL (constant or JavaScript expression) to use for the Collect
operation
collectMethod:
type: string
title: Collect method
enum:
- get
- post
- post_with_body
- other
x-speakeasy-enum-descriptions:
- GET
- POST
- POST with Body
- Other
description: Collect method
x-speakeasy-unknown-values: allow
collectRequestHeaders:
title: Collect headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Collect headers
pagination:
type: object
required:
- type
properties:
type:
$ref: "#/components/schemas/PaginationOptionsRestDiscoveryDiscoverTypeHttpPagin\
ation"
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
lastPageExpr:
type: string
title: Last-page expression
description: JavaScript expression used to determine when the last page has been
reached. The values tested by this expression must be in the
Response attributes section.
nextRelationAttribute:
type: string
title: Next page relation name
description: 'Relation name used in the link header that refers to the next page
in the result set. Example: rel="next" refers to the next page
of results: ; rel="next"'
curRelationAttribute:
type: string
title: Current page relation name
description: 'Relation name used in the link header that refers to the current
result set. Example: rel="self" refers to the current page of
results: ; rel="self" '
offsetField:
type: string
title: Offset field name
description: "Query string parameter that sets the index from which to begin
returning records. Example:
/api/v1/query?term=cribl&limit=100&offset=0"
offset:
type: number
title: Starting offset
description: Offset index from which to start request. Defaults to undefined,
which will start collection from the first record.
limitField:
type: string
title: Limit field name
description: "Query string parameter that sets the number of records retrieved
per request. Example:
/api/v1/query?term=cribl&limit=100&offset=0"
limit:
type: number
title: Record limit
description: Maximum number of records to collect per request
minimum: 1
totalRecordField:
type: string
title: Total record count field name
description: Name of the attribute in the response that contains the total
number of records for the query
zeroIndexed:
type: boolean
title: Zero-based index
description: Enable to indicate that the first page in the requested data is at
index 0. Disabled by default, which indicates index 1.
pageField:
type: string
title: Page number field name
description: "Query string parameter that sets the page index to be returned.
Example: /api/v1/query?term=cribl&page_size=100&page_number=0"
page:
type: number
title: Starting page number
description: Page number from which to start request. Defaults to undefined,
which will start collection from the first page.
sizeField:
type: string
title: Page size field name
description: "Query string parameter that sets the number of records retrieved
per request. Example:
/api/v1/query?term=cribl&page_size=100&page_number=0"
size:
type: number
title: Record limit
description: Maximum number of records to collect per page
minimum: 1
totalPageField:
type: string
title: Total page count field name
description: Name of the attribute in the response that contains the total
number of pages for the query
allOf:
- oneOf:
- $ref: "#/components/schemas/RestPaginationTypeNone"
- $ref: "#/components/schemas/RestPaginationTypeResponseBody"
- $ref: "#/components/schemas/RestPaginationTypeResponseHeader"
- $ref: "#/components/schemas/RestPaginationTypeResponseHeaderLink"
- $ref: "#/components/schemas/RestPaginationTypeRequestOffset"
- $ref: "#/components/schemas/RestPaginationTypeRequestPage"
discriminator:
propertyName: type
mapping:
none: "#/components/schemas/RestPaginationTypeNone"
response_body: "#/components/schemas/RestPaginationTypeResponseBody"
response_header: "#/components/schemas/RestPaginationTypeResponseHeader"
response_header_link: "#/components/schemas/RestPaginationTypeResponseHeaderLink"
request_offset: "#/components/schemas/RestPaginationTypeRequestOffset"
request_page: "#/components/schemas/RestPaginationTypeRequestPage"
authentication:
type: string
title: Authentication
description: Authentication method for Discover and Collect REST calls. You can
specify API key–based authentication by adding the appropriate
Collect headers.
enum:
- none
- basic
- basicSecret
- login
- loginSecret
- oauth
- oauthSecret
- google_oauth
- google_oauthSecret
- hmac
x-speakeasy-unknown-values: allow
timeout:
type: number
title: Request timeout (secs)
description: HTTP request inactivity timeout. Use 0 to disable.
minimum: 0
maximum: 1800
maxResponseBodySize:
type: string
title: Max response body size
description: Maximum amount of data to buffer from a single response body.
Responses exceeding this limit will be rejected. Maximum allowed
value is 512 MB. Leave unset to rely on default error handling.
useRoundRobinDns:
type: boolean
title: Round-robin DNS
description: Use round-robin DNS lookup. Suitable when DNS server returns
multiple addresses in sort order.
disableTimeFilter:
type: boolean
title: Disable time filter
description: Disable Collector event time filtering when a date range is specified
decodeUrl:
type: boolean
title: Decode URL
description: Decode the URL before sending requests (including pagination
requests)
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA
(such as self-signed certificates)
captureHeaders:
type: boolean
title: Capture response headers
description: Enable to add response headers to the resHeaders field under the
__collectible object
stopOnEmptyResults:
type: boolean
title: Stop on empty results
description: Stop pagination when the Event Breaker produces no events
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
retryRules:
type: object
required:
- type
properties:
type:
$ref: "#/components/schemas/RetryTypeOptionsHealthCheckCollectorConfRetryRules"
allOf:
- oneOf:
- $ref: "#/components/schemas/RestRetryRulesTypeNone"
- $ref: "#/components/schemas/RestRetryRulesTypeStatic"
- $ref: "#/components/schemas/RestRetryRulesTypeBackoff"
discriminator:
propertyName: type
mapping:
none: "#/components/schemas/RestRetryRulesTypeNone"
static: "#/components/schemas/RestRetryRulesTypeStatic"
backoff: "#/components/schemas/RestRetryRulesTypeBackoff"
microsoftGraphDelta:
type: object
description: Internal opt-in for the Microsoft Graph deltaLink state-tracking
hook. Set programmatically by the Microsoft Graph source when the
configured URL targets a /delta endpoint; not user-configurable.
properties:
deltaLinkAttribute:
type: string
description: Response-body field name to extract as the delta link (typically
'@odata.deltaLink')
__scheduling:
type: object
properties:
stateTracking:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Track collection progress between consecutive scheduled executions
username:
type: string
title: Username
description: Username
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
password:
type: string
title: Password
description: Password
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your credentials
loginUrl:
type: string
title: Login URL
description: URL to use for login API call. This call is expected to be a POST.
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
loginBody:
type: string
title: POST body
description: Template for POST body to send with login request. ${username} and
${password} are used to specify location of these attributes in the
message. For x-www-form-urlencoded bodies, wrap values with
${C.Encode.uri(password)} to preserve special characters like +, &,
and =.
getAuthTokenFromHeader:
type: boolean
title: Get auth token from header
description: Extract the auth token from the HTTP 'Authorization' response
header instead of the standard JSON body of the login response
authHeaderKey:
type: string
title: Authorization header
description: Authorization header key to pass in Discover and Collect calls.
Defaults to the literal name 'Authorization'.
authHeaderExpr:
type: string
title: Authorize expression
description: JavaScript expression used to compute the Authorization header to
pass in Discover and Collect calls. The value ${token} is used to
reference the token obtained from login.
authRequestHeaders:
title: Authentication headers
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
description: Authentication headers
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are OK. Leave blank if the response content type is text/plain; the
entire response body will be used to derive the authorization
header.
clientSecretParamName:
type: string
title: Client secret parameter
description: Defaults to 'client_secret'. Automatically added to request
parameters using the value specified.
clientSecretParamValue:
type: string
title: Client secret value
description: Secret value to add to HTTP requests as the 'client secret'
parameter. Value is stored encrypted on disk and automatically added
to request parameters.
__template_clientSecretParamValue:
type: string
description: Binds 'clientSecretParamValue' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'clientSecretParamValue' at runtime.
authRequestParams:
title: Extra authentication parameters
description: OAuth request parameters added to the POST body. The Content-Type
header will automatically be set to
application/x-www-form-urlencoded.
type: array
items:
$ref: "#/components/schemas/CollectRequestParamConfRestCollectMethodGet"
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, the Collector uses the refresh
token to obtain new access tokens without re-sending credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: The Collector will update its stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use.
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, the Collector sends
only grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
th"
textSecret:
type: string
title: Client secret value (text secret)
description: Select or create a text secret that contains the client secret's
value
scopes:
type: array
title: Scopes
description: Scopes to use during authentication. See [Google's
docs](https://developers.google.com/identity/protocols/oauth2/scopes)
for more information.
minItems: 1
items:
type: string
minLength: 1
serviceAccountCredentials:
type: string
title: Service account credentials
description: Contents of Google Cloud service account credentials (JSON keys)
file. To upload a file, click the upload icon in this field's upper
right.
minLength: 1
__template_serviceAccountCredentials:
type: string
description: Binds 'serviceAccountCredentials' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serviceAccountCredentials' at runtime.
subject:
type: string
title: Impersonated account's email address
description: Email address of a user account with Super Admin permissions to the
resources the collector will retrieve
__template_subject:
type: string
description: Binds 'subject' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'subject' at runtime.
hmacFunctionId:
type: string
title: HMAC Function
description: Select or create an HMAC Function to use with authentication
__template_collectUrl:
type: string
description: Binds 'collectUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'collectUrl' at runtime.
allOf:
- oneOf:
- $ref: "#/components/schemas/RestCollectMethodGet"
- $ref: "#/components/schemas/RestCollectMethodPost"
- $ref: "#/components/schemas/RestCollectMethodPostWithBody"
- $ref: "#/components/schemas/RestCollectMethodOther"
discriminator:
propertyName: collectMethod
mapping:
get: "#/components/schemas/RestCollectMethodGet"
post: "#/components/schemas/RestCollectMethodPost"
post_with_body: "#/components/schemas/RestCollectMethodPostWithBody"
other: "#/components/schemas/RestCollectMethodOther"
- oneOf:
- $ref: "#/components/schemas/RestAuthenticationNone"
- $ref: "#/components/schemas/RestAuthenticationBasic"
- $ref: "#/components/schemas/RestAuthenticationBasicSecret"
- $ref: "#/components/schemas/RestAuthenticationLogin"
- $ref: "#/components/schemas/RestAuthenticationLoginSecret"
- $ref: "#/components/schemas/RestAuthenticationOauth"
- $ref: "#/components/schemas/RestAuthenticationOauthSecret"
- $ref: "#/components/schemas/RestAuthenticationGoogleOauth"
- $ref: "#/components/schemas/RestAuthenticationGoogleOauthSecret"
- $ref: "#/components/schemas/RestAuthenticationHmac"
discriminator:
propertyName: authentication
mapping:
none: "#/components/schemas/RestAuthenticationNone"
basic: "#/components/schemas/RestAuthenticationBasic"
basicSecret: "#/components/schemas/RestAuthenticationBasicSecret"
login: "#/components/schemas/RestAuthenticationLogin"
loginSecret: "#/components/schemas/RestAuthenticationLoginSecret"
oauth: "#/components/schemas/RestAuthenticationOauth"
oauthSecret: "#/components/schemas/RestAuthenticationOauthSecret"
google_oauth: "#/components/schemas/RestAuthenticationGoogleOauth"
google_oauthSecret: "#/components/schemas/RestAuthenticationGoogleOauthSecret"
hmac: "#/components/schemas/RestAuthenticationHmac"
CollectorRest:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- rest
description: Collector type
conf:
$ref: "#/components/schemas/RestCollectorConf"
description: Rest collector configuration
S3PartitioningSchemeDdss:
type: object
properties:
partitioningScheme:
enum:
- ddss
type: string
description: Discriminator value.
S3PartitioningSchemeNone:
type: object
properties:
partitioningScheme:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
recurse:
type: boolean
title: Recursive
description: Traverse and include files from subdirectories. Leave this option
enabled to ensure that all nested directories are searched and their
contents collected.
S3AwsAuthenticationMethodAuto:
type: object
properties:
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthTypeOptionsGoogleCloudStorageAuthTypeAuto"
S3AwsAuthenticationMethodManual:
type: object
properties:
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeManual"
awsApiKey:
type: string
title: Access key
description: Access key. If not present, will fall back to
env.AWS_ACCESS_KEY_ID, or to the metadata endpoint for IAM creds.
Optional when running on AWS. This value can be a constant or a
JavaScript expression.
awsSecretKey:
type: string
title: Secret key
description: Secret key. If not present, will fall back to
env.AWS_SECRET_ACCESS_KEY, or to the metadata endpoint for IAM
creds. Optional when running on AWS. This value can be a constant or
a JavaScript expression.
S3AwsAuthenticationMethodSecret:
type: object
properties:
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthTypeOptionsAzureBlobAuthTypeSecret"
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references AWS access key and
secret key.
S3CollectorConf:
type: object
title: ""
required:
- bucket
properties:
outputName:
type: string
title: Auto-populate from
description: Name of the predefined Destination that will be used to
auto-populate Collector settings
bucket:
type: string
title: S3 bucket
minLength: 1
description: S3 Bucket from which to collect data
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit (MB)
description: Maximum file size for each Parquet chunk
maximum: 100
minimum: 1
parquetChunkDownloadTimeout:
type: number
title: Parquet chunk download timeout (seconds)
description: Maximum time allowed for downloading a Parquet chunk. Processing
will stop if a chunk cannot be downloaded within the time specified.
maximum: 3600
minimum: 1
region:
type: string
title: Region
description: Region from which to retrieve data
path:
type: string
title: Path
description: Directory where data will be collected. Templating (such as
'myDir/${datacenter}/${host}/${app}/') and time-based tokens (such
as 'myOtherDir/${_time:%Y}/${_time:%m}/${_time:%d}/') are supported.
Can be a constant (enclosed in quotes) or a JavaScript expression.
minLength: 1
partitioningScheme:
type: string
title: Partitioning scheme
description: Partitioning scheme used for this dataset. Using a known scheme
like DDSS enables more efficient data reading and retrieval.
enum:
- none
- ddss
x-speakeasy-enum-descriptions:
- Defined in Path
- DDSS
x-speakeasy-unknown-values: allow
extractors:
type: array
title: Path extractors
additionalProperties: false
items:
type: object
required:
- key
- expression
properties:
key:
type: string
title: Token
description: A token from the template path, such as epoch
expression:
type: string
title: Extractor Expression
description: 'JavaScript expression that receives token under "value" variable,
and evaluates to populate event fields. Example: {date: new
Date(+value*1000)}'
description: 'Allows using template tokens as context for expressions that
enrich discovery results. For example, given a template
/path/${epoch}, an extractor under key "epoch" with an expression
{date: new Date(+value*1000)}, will enrich discovery results with a
human readable "date" field.'
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
endpoint:
type: string
title: Endpoint
description: "Must point to an S3-compatible endpoint. If empty, defaults to an
AWS region-specific endpoint. "
enableAssumeRole:
type: boolean
title: Enable Assume Role
description: Use AssumeRole credentials
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
maxBatchSize:
type: number
title: Batch size limit (objects)
description: Maximum number of metadata objects to batch before recording as
results
minimum: 1
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests to improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA
(such as a self-signed certificate)
verifyPermissions:
type: boolean
title: Verify bucket permissions
description: 'Disable if you can access files within the bucket but not the
bucket itself. Resolves errors of the form "discover task
initialization failed...error: Forbidden".'
disableTimeFilter:
type: boolean
title: Disable time filter
description: Disable Collector event time filtering when a date range is specified
awsApiKey:
type: string
title: Access key
description: Access key. If not present, will fall back to
env.AWS_ACCESS_KEY_ID, or to the metadata endpoint for IAM creds.
Optional when running on AWS. This value can be a constant or a
JavaScript expression.
awsSecretKey:
type: string
title: Secret key
description: Secret key. If not present, will fall back to
env.AWS_SECRET_ACCESS_KEY, or to the metadata endpoint for IAM
creds. Optional when running on AWS. This value can be a constant or
a JavaScript expression.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references AWS access key and
secret key.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
allOf:
- oneOf:
- $ref: "#/components/schemas/S3PartitioningSchemeDdss"
- $ref: "#/components/schemas/S3PartitioningSchemeNone"
discriminator:
propertyName: partitioningScheme
mapping:
ddss: "#/components/schemas/S3PartitioningSchemeDdss"
none: "#/components/schemas/S3PartitioningSchemeNone"
- oneOf:
- $ref: "#/components/schemas/S3AwsAuthenticationMethodAuto"
- $ref: "#/components/schemas/S3AwsAuthenticationMethodManual"
- $ref: "#/components/schemas/S3AwsAuthenticationMethodSecret"
discriminator:
propertyName: awsAuthenticationMethod
mapping:
auto: "#/components/schemas/S3AwsAuthenticationMethodAuto"
manual: "#/components/schemas/S3AwsAuthenticationMethodManual"
secret: "#/components/schemas/S3AwsAuthenticationMethodSecret"
CollectorS3:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- s3
description: Collector type
conf:
$ref: "#/components/schemas/S3CollectorConf"
description: S3 collector configuration
ScriptCollectorConf:
type: object
title: ""
required:
- discoverScript
- collectScript
properties:
discoverScript:
type: string
title: Discover Script
minLength: 1
description: Script to discover what to collect. Should output one task per line
in stdout.
collectScript:
type: string
title: Collect Script
minLength: 1
description: Script to run to perform data collections. Task passed in as
$CRIBL_COLLECT_ARG. Should output results to stdout.
shell:
type: string
title: Shell
description: Shell to use to execute scripts.
envVars:
type: array
title: Environment Variables
description: Environment variables to expose to the discover and collect scripts.
additionalProperties: false
items:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: Environment variable name
pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
value:
type: string
title: Value
description: JavaScript expression to compute environment variable's value,
enclosed in quotes or backticks. (Can evaluate to a constant.)
CollectorScript:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- script
description: Collector type
conf:
$ref: "#/components/schemas/ScriptCollectorConf"
description: Script collector configuration
SplunkAuthenticationNone:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthTypeOptionsRedisAuthTypeNone"
SplunkAuthenticationBasic:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationBasic"
username:
type: string
title: Username
description: Basic authentication username
password:
type: string
title: Password
description: Basic authentication password
required:
- username
- password
SplunkAuthenticationBasicSecret:
type: object
properties:
authentication:
$ref: "#/components/schemas/AuthenticationOptionsHealthCheckAuthenticationBasic\
Secret"
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your credentials
required:
- credentialsSecret
SplunkAuthenticationToken:
type: object
properties:
authentication:
enum:
- token
type: string
description: Discriminator value.
token:
type: string
title: Bearer token
description: Bearer token
required:
- token
SplunkAuthenticationTokenSecret:
type: object
properties:
authentication:
enum:
- tokenSecret
type: string
description: Discriminator value.
tokenSecret:
type: string
title: Bearer token secret
description: Select or create a stored secret that references your Bearer token
required:
- tokenSecret
SplunkRetryRulesTypeNone:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeNone"
SplunkRetryRulesTypeStatic:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeStatic"
interval:
type: number
title: Wait (ms)
description: Time interval between retries. Maximum allowed value is 20,000 ms
(1/3 minute).
minimum: 0
maximum: 20000
limit:
type: number
title: Retry limit
description: The maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
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
items:
type: number
minimum: 100
maximum: 599
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.
retryConnectTimeout:
type: boolean
title: Retry connection timeout
description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
error occurs
retryConnectReset:
type: boolean
title: Retry connection reset
description: Retry request when a connection reset error (ECONNRESET) error occurs
SplunkRetryRulesTypeBackoff:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsHealthCheckRetryRulesTypeBackoff"
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
limit:
type: number
title: Retry limit
description: The maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
multiplier:
type: number
title: Backoff multiplier
description: Base for exponential backoff. For example, base 2 means that
retries will occur after 2, then 4, then 8 seconds, and so on.
minimum: 1
maximum: 20
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
items:
type: number
minimum: 100
maximum: 599
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.
retryConnectTimeout:
type: boolean
title: Retry connection timeout
description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
error occurs
retryConnectReset:
type: boolean
title: Retry connection reset
description: Retry request when a connection reset error (ECONNRESET) error occurs
SplunkCollectorConf:
type: object
title: ""
required:
- search
- searchHead
- endpoint
- authentication
- outputMode
properties:
searchHead:
type: string
title: Search head
description: Search head base URL. Can be an expression. Default is
https://localhost:8089.
search:
type: string
title: Search
description: "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'"
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'"
endpoint:
type: string
title: Search endpoint
description: REST API used to create a search
outputMode:
$ref: "#/components/schemas/OutputModeOptionsSplunkCollectorConf"
collectRequestParams:
title: Extra parameters
description: Optional collect request parameters
type: array
items:
type: object
required:
- name
- value
properties:
name:
title: Parameter Name
type: string
description: Parameter Name
value:
title: Value
type: string
description: JavaScript expression to compute the parameter's value, normally
enclosed in backticks (`${earliest}`). If a constant, use
single quotes ('earliest'). Values without delimiters
(earliest) are evaluated as strings.
collectRequestHeaders:
title: Extra headers
description: Optional collect request headers
type: array
items:
type: object
required:
- name
- value
properties:
name:
type: string
title: Header Name
description: Header Name
value:
type: string
title: Value
description: JavaScript expression to compute the header's value, normally
enclosed in backticks (`${earliest}`). If a constant, use
single quotes ('earliest'). Values without delimiters
(earliest) are evaluated as strings.
authentication:
type: string
title: Authentication
description: Authentication method for Discover and Collect REST calls
enum:
- none
- basic
- basicSecret
- token
- tokenSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Bearer Token
- Bearer Token (text secret)
x-speakeasy-unknown-values: allow
timeout:
type: number
title: Request timeout (secs)
description: HTTP request inactivity timeout. Use 0 for no timeout.
minimum: 0
maximum: 1800
useRoundRobinDns:
type: boolean
title: Round-robin DNS
description: Use round-robin DNS lookup. Suitable when DNS server returns
multiple addresses in sort order.
disableTimeFilter:
type: boolean
title: Disable time filter
description: Disable collector event time filtering when a date range is specified
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA
(such as self-signed certificates)
handleEscapedChars:
type: boolean
title: Preserve escaped characters
description: Escape characters (\") in search queries will be passed directly to
Splunk
retryRules:
type: object
required:
- type
properties:
type:
$ref: "#/components/schemas/RetryTypeOptionsHealthCheckCollectorConfRetryRules"
allOf:
- oneOf:
- $ref: "#/components/schemas/SplunkRetryRulesTypeNone"
- $ref: "#/components/schemas/SplunkRetryRulesTypeStatic"
- $ref: "#/components/schemas/SplunkRetryRulesTypeBackoff"
discriminator:
propertyName: type
mapping:
none: "#/components/schemas/SplunkRetryRulesTypeNone"
static: "#/components/schemas/SplunkRetryRulesTypeStatic"
backoff: "#/components/schemas/SplunkRetryRulesTypeBackoff"
username:
type: string
title: Username
description: Basic authentication username
password:
type: string
title: Password
description: Basic authentication password
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a stored secret that references your credentials
token:
type: string
title: Bearer token
description: Bearer token
tokenSecret:
type: string
title: Bearer token secret
description: Select or create a stored secret that references your Bearer token
loginUrl:
type: string
title: Login URL
description: URL to use for login API call. This call is expected to be a POST.
loginBody:
type: string
title: POST body
description: Template for POST body to send with login request. ${username} and
${password} are used to specify location of these attributes in the
message.
tokenRespAttribute:
type: string
title: Token attribute
description: Path to token attribute in login response body. Nested attributes
are allowed.
authHeaderExpr:
type: string
title: Authorize Expression
description: JavaScript expression to compute the Authorization header to pass
in discover and collect calls. The value ${token} is used to
reference the token obtained from login.
__template_searchHead:
type: string
description: Binds 'searchHead' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'searchHead' at runtime.
__template_search:
type: string
description: Binds 'search' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'search' at runtime.
__template_earliest:
type: string
description: Binds 'earliest' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'earliest' at runtime.
__template_latest:
type: string
description: Binds 'latest' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'latest' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_outputMode:
type: string
description: Binds 'outputMode' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'outputMode' at runtime.
allOf:
- oneOf:
- $ref: "#/components/schemas/SplunkAuthenticationNone"
- $ref: "#/components/schemas/SplunkAuthenticationBasic"
- $ref: "#/components/schemas/SplunkAuthenticationBasicSecret"
- $ref: "#/components/schemas/SplunkAuthenticationToken"
- $ref: "#/components/schemas/SplunkAuthenticationTokenSecret"
discriminator:
propertyName: authentication
mapping:
none: "#/components/schemas/SplunkAuthenticationNone"
basic: "#/components/schemas/SplunkAuthenticationBasic"
basicSecret: "#/components/schemas/SplunkAuthenticationBasicSecret"
token: "#/components/schemas/SplunkAuthenticationToken"
tokenSecret: "#/components/schemas/SplunkAuthenticationTokenSecret"
CollectorSplunk:
allOf:
- $ref: "#/components/schemas/CollectorBase"
- type: object
properties:
type:
type: string
enum:
- splunk
description: Collector type
conf:
$ref: "#/components/schemas/SplunkCollectorConf"
description: Splunk collector configuration
Collector:
description: Collector configuration
oneOf:
- $ref: "#/components/schemas/CollectorAzureBlob"
- $ref: "#/components/schemas/CollectorCriblLake"
- $ref: "#/components/schemas/CollectorDatabase"
- $ref: "#/components/schemas/CollectorFilesystem"
- $ref: "#/components/schemas/CollectorGoogleCloudStorage"
- $ref: "#/components/schemas/CollectorHealthCheck"
- $ref: "#/components/schemas/CollectorRest"
- $ref: "#/components/schemas/CollectorS3"
- $ref: "#/components/schemas/CollectorScript"
- $ref: "#/components/schemas/CollectorSplunk"
discriminator:
propertyName: type
mapping:
azure_blob: "#/components/schemas/CollectorAzureBlob"
cribl_lake: "#/components/schemas/CollectorCriblLake"
database: "#/components/schemas/CollectorDatabase"
filesystem: "#/components/schemas/CollectorFilesystem"
google_cloud_storage: "#/components/schemas/CollectorGoogleCloudStorage"
health_check: "#/components/schemas/CollectorHealthCheck"
rest: "#/components/schemas/CollectorRest"
s3: "#/components/schemas/CollectorS3"
script: "#/components/schemas/CollectorScript"
splunk: "#/components/schemas/CollectorSplunk"
RbacResource:
type: string
enum:
- groups
- datasets
- dataset-providers
- projects
- dashboards
- macros
- notebooks
- notebook-templates
- apps
x-speakeasy-unknown-values: allow
ResourcePolicy:
type: object
properties:
gid:
type: string
description: Unique identifier for the group that owns the resource.
id:
type: string
description: Unique identifier for the resource. Omitted for resource type
groups.
policy:
type: string
description: String that defines the access control policy for the resource.
type:
$ref: "#/components/schemas/RbacResource"
description: Resource type that the access control policy applies to.
example: projects
required:
- gid
- policy
- type
UserAccessControlList:
type: object
properties:
perms:
type: array
items:
$ref: "#/components/schemas/ResourcePolicy"
user:
type: string
required:
- perms
- user
DatabaseConnectionAuthType:
type: string
enum:
- configObj
- connectionString
- secret
- secrets
x-speakeasy-unknown-values: allow
DatabaseConnectionType:
type: string
enum:
- mysql
- oracle
- postgres
- sqlserver
x-speakeasy-unknown-values: allow
SecureVersion:
type: string
enum:
- TLSv1.3
- TLSv1.2
- TLSv1.1
- TLSv1
x-speakeasy-unknown-values: allow
TLSClientParams:
type: object
properties:
caPath:
type: string
description: Path to the Certificate Authority (CA) certificate file in PEM
format.
certPath:
type: string
description: Path to the client certificate file in PEM format.
certificateName:
type: string
description: Name of a certificate stored in Cribl.
disabled:
type: boolean
description: If true, TLS is disabled for the connection.
maxVersion:
$ref: "#/components/schemas/SecureVersion"
description: Maximum TLS version to allow for the connection.
minVersion:
$ref: "#/components/schemas/SecureVersion"
description: Minimum TLS version to allow for the connection.
passphrase:
type: string
description: Passphrase for the private key.
privKeyPath:
type: string
description: Path to the private key file in PEM format.
rejectUnauthorized:
type: boolean
description: If true, reject connections to servers with unverified
TLS certificates.
servername:
type: string
description: Server name for TLS Server Name Indication (SNI) extension.
required:
- disabled
description: TLS client connection settings.
DatabaseConnectionConfig:
type: object
properties:
authType:
$ref: "#/components/schemas/DatabaseConnectionAuthType"
description: Authentication method for the Database Connection. Determines how
credentials are provided.
example: connectionString
configObj:
type: string
description: JSON configuration object for advanced SQL Server connection
settings.
example:
server: sqlserver.example.com
database: Reporting
user: yourUsername
password: yourPassword
options:
trustServerCertificate: false
connectTimeout: 20000
connectionString:
type: string
description: Database connection string with embedded credentials or server
information.
example: mysql://yourUsername:yourPassword@mysql.example.com:3306/production?ssl=true
connectionTimeout:
type: integer
description: Maximum time (in milliseconds) to wait when establishing the
database connection.
minimum: 1000
maximum: 60000
example: 10000
credsSecrets:
type: string
description: Name of the stored credentials secret containing username and
password. Used with Oracle connections.
example: oracle-production-credentials
databaseType:
$ref: "#/components/schemas/DatabaseConnectionType"
description: Type of database engine for the connection.
example: mysql
description:
type: string
description: Brief description of the Database Connection.
example: Production MySQL database for customer data
id:
type: string
description: Unique identifier for the Database Connection.
pattern: ^[a-zA-Z0-9_\\-]+$
example: mysql-prod-db
password:
type: string
description: Database password for authentication. Used with Oracle connections.
example: yourPassword
requestTimeout:
type: integer
description: Maximum time (in milliseconds) to wait for a database query to
complete. Applies to SQL Server connections only.
minimum: 1000
example: 30000
tags:
type: string
description: Comma-separated list of tags for categorizing and filtering
Database Connections.
example: production,mysql,customer-data
textSecret:
type: string
description: Name of the stored text secret containing the connection string.
example: mysql-production-connection
tls:
$ref: "#/components/schemas/TLSClientParams"
user:
type: string
description: Database username for authentication. Used with Oracle connections.
example: yourUsername
required:
- authType
- databaseType
- description
- id
DatabaseConnectionResponseEnvelope:
type: object
properties:
count:
type: integer
description: Number of Database Connections returned in the response envelope.
minimum: 0
example: 1
items:
type: array
items:
$ref: "#/components/schemas/DatabaseConnectionConfig"
description: Database Connections returned in the response envelope.
required:
- count
- items
RestApiJsonError:
type: object
properties:
details:
type: object
additionalProperties: true
description: Optional structured details about the error (e.g. validation
failures).
message:
type: string
description: Human-readable message or serialized validation details for the
error.
status:
type: string
const: error
description: Always error for API error responses.
required:
- message
- status
description: JSON body returned for many REST failures that use
RESTEndpoint.sendError (and similar handlers).
CountedFunctionResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/FunctionResponse"
PaginatedFunctionResponse:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/FunctionResponse"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
InputCollection:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- collection
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
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.
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
minimum: 10
maximum: 43200000
preprocess:
$ref: "#/components/schemas/PreprocessType"
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])?$
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
output:
type: string
title: Destination
description: Destination to send results to
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
InputKafka:
type: object
required:
- type
- brokers
- topics
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptions"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
items:
type: string
minLength: 1
groupId:
type: string
title: Group ID
description: The consumer group to which this instance belongs. Defaults to
'Cribl'.
fromBeginning:
type: boolean
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:
$ref: "#/components/schemas/KafkaSchemaRegistryAuthenticationType"
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a connection to complete successfully
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
sasl:
$ref: "#/components/schemas/AuthenticationType"
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
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.
minimum: 1000
maximum: 3600000
rebalanceTimeout:
type: number
title: Rebalance timeout (ms)
description: |-
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.
minimum: 1000
maximum: 3600000
heartbeatInterval:
type: number
title: Heartbeat interval (ms)
description: |-
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.
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
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
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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_brokers:
type: string
description: Binds 'brokers' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'brokers' at runtime.
__template_topics:
type: string
description: Binds 'topics' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topics' at runtime.
__template_groupId:
type: string
description: Binds 'groupId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'groupId' at runtime.
InputMsk:
type: object
required:
- type
- brokers
- topics
- region
- awsAuthenticationMethod
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsMsk"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
items:
type: string
minLength: 1
groupId:
type: string
title: Group ID
description: The consumer group to which this instance belongs. Defaults to
'Cribl'.
fromBeginning:
type: boolean
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.
minimum: 1000
maximum: 3600000
rebalanceTimeout:
type: number
title: Rebalance timeout (ms)
description: |-
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.
minimum: 1000
maximum: 3600000
heartbeatInterval:
type: number
title: Heartbeat interval (ms)
description: |-
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.
minimum: 1000
maximum: 3600000
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
kafkaSchemaRegistry:
$ref: "#/components/schemas/KafkaSchemaRegistryAuthenticationType"
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a connection to complete successfully
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for MSK
description: Use Assume Role credentials to access MSK
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
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
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
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
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
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_brokers:
type: string
description: Binds 'brokers' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'brokers' at runtime.
__template_topics:
type: string
description: Binds 'topics' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topics' at runtime.
__template_groupId:
type: string
description: Binds 'groupId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'groupId' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
InputHttp:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- http
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
type: string
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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.
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.
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.
pattern: ^/|^$
splunkHecAcks:
type: boolean
title: Enable Splunk HEC acknowledgements
description: Enable Splunk HEC acknowledgements
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
authTokensExt:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
$ref: "#/components/schemas/AuthTokensExtConfInputHttp"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_authTokens:
type: string
description: Binds 'authTokens' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'authTokens' at runtime.
__template_criblAPI:
type: string
description: Binds 'criblAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'criblAPI' at runtime.
__template_elasticAPI:
type: string
description: Binds 'elasticAPI' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'elasticAPI' at runtime.
__template_splunkHecAPI:
type: string
description: Binds 'splunkHecAPI' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'splunkHecAPI' at runtime.
InputSplunk:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsSplunk"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to establish a
connection
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process.
Use 0 for unlimited.
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.
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.
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.
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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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
description: Description
maxS2Sversion:
type: string
title: Max S2S version
description: The highest S2S protocol version to advertise during handshake
enum:
- v3
- v4
x-speakeasy-enum-descriptions:
- v3
- v4
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
useFwdTimezone:
type: boolean
title: Use Universal Forwarder time zone
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`.
extractMetrics:
type: boolean
title: Extract metrics
description: Extract and process Splunk-generated metrics as Cribl metrics
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.
enum:
- disabled
- auto
- always
x-speakeasy-enum-descriptions:
- Disabled
- Automatic
- Always
x-speakeasy-unknown-values: allow
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_maxS2Sversion:
type: string
description: Binds 'maxS2Sversion' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'maxS2Sversion' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
InputSplunkSearch:
type: object
required:
- type
- authType
- searchHead
- search
- cronSchedule
- endpoint
- outputMode
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- splunk_search
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
searchHead:
title: Search head
type: string
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'"
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'"
cronSchedule:
type: string
title: Cron schedule
description: A cron schedule on which to run this job
endpoint:
type: string
title: Search endpoint
description: REST API used to create a search
outputMode:
$ref: "#/components/schemas/OutputModeOptionsSplunkCollectorConf"
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
description: Parameter Name
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
description: 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
useRoundRobinDns:
type: boolean
title: Round-robin DNS
description: When a DNS server returns multiple addresses, @{product} will cycle
through them in the order returned
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA
(such as self-signed certificates)
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
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]?$
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
retryRules:
$ref: "#/components/schemas/RetryRulesType"
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
minimum: 10
maximum: 43200000
authType:
type: string
title: Authentication type
description: Splunk Search authentication type
enum:
- none
- basic
- credentialsSecret
- token
- textSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Token
- Token (text secret)
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_searchHead:
type: string
description: Binds 'searchHead' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'searchHead' at runtime.
__template_search:
type: string
description: Binds 'search' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'search' at runtime.
__template_earliest:
type: string
description: Binds 'earliest' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'earliest' at runtime.
__template_latest:
type: string
description: Binds 'latest' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'latest' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_logLevel:
type: string
description: Binds 'logLevel' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logLevel' at runtime.
InputSplunkHec:
type: object
required:
- type
- host
- port
- splunkHecAPI
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- splunk_hec
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
type: object
required:
- token
properties:
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
tokenSecret:
type: string
title: Token secret (text secret)
description: Select or create a stored text secret
token:
type: string
title: Token
description: "Shared secret to be provided by any client (Authorization:
)"
enabled:
type: boolean
title: Enable token
description: If true, the token is active and can be used for authentication.
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
minimum: 1
maximum: 600
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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.
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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
minimum: 10
maximum: 43200000
useFwdTimezone:
type: boolean
title: Use Universal Forwarder time zone (S2S only)
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`.
extractMetrics:
type: boolean
title: Extract metrics (S2S only)
description: Extract and process Splunk-generated metrics as Cribl metrics
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 (.http.perToken) and summary
(.http.summary) request metrics
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_splunkHecAPI:
type: string
description: Binds 'splunkHecAPI' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'splunkHecAPI' at runtime.
InputAzureBlob:
type: object
required:
- type
- queueName
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsAzureblob"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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: .*"
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.
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.
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."
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
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
minimum: 10
maximum: 43200000
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit (MB)
description: Maximum file size for each Parquet chunk
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.
maximum: 3600
minimum: 1
authType:
$ref: "#/components/schemas/AuthenticationMethodOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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:
$ref: "#/components/schemas/CertificateTypeAzureBlobAuthTypeClientCert"
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_connectionString:
type: string
description: Binds 'connectionString' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'connectionString' at runtime.
__template_storageAccountName:
type: string
description: Binds 'storageAccountName' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'storageAccountName' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_azureCloud:
type: string
description: Binds 'azureCloud' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'azureCloud' at runtime.
InputElastic:
type: object
required:
- type
- host
- port
- elasticAPI
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- elastic
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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//_bulk. Other entries are
faked as success.
pattern: ^/
authType:
type: string
title: Authentication type
enum:
- none
- basic
- credentialsSecret
- authTokens
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Auth Tokens
description: Authentication type
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
x-speakeasy-unknown-values: allow
extraHttpHeaders:
type: array
title: Extra HTTP headers
description: Headers to add to all events
items:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
proxyMode:
type: object
title: ""
required:
- enabled
properties:
enabled:
type: boolean
title: Enable proxy mode
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
description: Enter credentials directly, or select a stored secret
x-speakeasy-unknown-values: allow
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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)
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
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
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_elasticAPI:
type: string
description: Binds 'elasticAPI' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'elasticAPI' at runtime.
__template_authTokens:
type: string
description: Binds 'authTokens' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'authTokens' at runtime.
InputConfluentCloud:
type: object
required:
- type
- brokers
- topics
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsConfluentcloud"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
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
items:
type: string
minLength: 1
groupId:
type: string
title: Group ID
description: The consumer group to which this instance belongs. Defaults to
'Cribl'.
fromBeginning:
type: boolean
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:
$ref: "#/components/schemas/KafkaSchemaRegistryAuthenticationType"
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a connection to complete successfully
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
sasl:
$ref: "#/components/schemas/AuthenticationType"
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.
minimum: 1000
maximum: 3600000
rebalanceTimeout:
type: number
title: Rebalance timeout (ms)
description: |-
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.
minimum: 1000
maximum: 3600000
heartbeatInterval:
type: number
title: Heartbeat interval (ms)
description: |-
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.
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
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
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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_brokers:
type: string
description: Binds 'brokers' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'brokers' at runtime.
__template_topics:
type: string
description: Binds 'topics' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topics' at runtime.
__template_groupId:
type: string
description: Binds 'groupId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'groupId' at runtime.
InputGrafana:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- grafana
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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.
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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://:/api/prom/push'. Either this
field or 'Logs API endpoint' must be configured."
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://:/loki/api/v1/push'. Either
this field or 'Remote Write API endpoint' must be configured."
pattern: ^/
prometheusAuth:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthenticationTypeOptionsPrometheusAuth"
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
lokiAuth:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthenticationTypeOptionsLokiAuth"
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_prometheusAPI:
type: string
description: Binds 'prometheusAPI' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'prometheusAPI' at runtime.
__template_lokiAPI:
type: string
description: Binds 'lokiAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'lokiAPI' at runtime.
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
description: Source type identifier.
enum:
- loki
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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://:/loki/api/v1/push'."
pattern: ^/
authType:
$ref: "#/components/schemas/AuthenticationTypeOptionsLokiAuth"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_lokiAPI:
type: string
description: Binds 'lokiAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'lokiAPI' at runtime.
InputPrometheusRw:
type: object
required:
- type
- host
- port
- prometheusAPI
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- prometheus_rw
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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://:/write."
pattern: ^/
authType:
$ref: "#/components/schemas/AuthenticationTypeOptionsPrometheusAuth"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_prometheusAPI:
type: string
description: Binds 'prometheusAPI' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'prometheusAPI' at runtime.
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
InputPrometheus:
type: object
required:
- type
- interval
- logLevel
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsPrometheus"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
dimensionList:
type: array
title: Extra dimensions
minItems: 0
description: Other dimensions to include in events
items:
type: string
title: dimension
fieldPerMetric:
type: boolean
title: Use field per metric
description: "When enabled, each metric name is used as the event field key
(example: go_threads: 9) instead of the default _metric/_value
format."
discoveryType:
title: Discovery type
type: string
enum:
- static
- dns
- ec2
- http_sd
x-speakeasy-enum-descriptions:
- Static
- DNS
- AWS EC2
- HTTP SD
description: Target discovery mechanism. Use static to manually enter a list of
targets.
x-speakeasy-unknown-values: allow
interval:
type: number
title: Poll interval
description: How often, in minutes, to scrape targets for metrics. Maximum of 60
minutes. 60 must be evenly divisible by the value you enter.
minimum: 1
maximum: 60
logLevel:
$ref: "#/components/schemas/LogLevelOptions"
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
timeout:
type: number
title: HTTP connection timeout
description: Time, in seconds, before aborting HTTP connection attempts; use 0
for no timeout
minimum: 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
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]?$
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsSasl"
description:
type: string
title: Description
description: Optional description for this configuration.
targetList:
type: array
title: Targets
minItems: 1
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:
$ref: "#/components/schemas/RecordTypeOptions"
scrapePort:
type: number
title: Metrics port
description: The port number in the metrics URL for discovered targets
minimum: 1
maximum: 65535
nameList:
type: array
title: DNS names
minItems: 1
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
x-speakeasy-unknown-values: allow
scrapePath:
type: string
title: Metrics path
description: Path to use when collecting metrics from discovered targets
pattern: ^/.*
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsApiKey:
type: string
title: Access key
description: Access key
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. Disable to use the
private IP address.
searchFilter:
title: Search filter
description: Filter to apply when searching for EC2 instances
type: array
items:
$ref: "#/components/schemas/SearchFilterConfInputPrometheus"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
enableAssumeRole:
type: boolean
title: Enable for EC2
description: Use Assume Role credentials to access EC2
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
httpDiscoveryUrl:
type: string
title: Discovery URL
description: URL to fetch target groups from (must be http or https)
pattern: ^https?://
httpDiscoveryHeaders:
type: array
title: HTTP headers
description: Extra headers to send with the discovery request
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
httpDiscoveryRejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject TLS certificates that cannot be verified for the discovery
endpoint. Falls back to the source-level setting if not specified.
maxResponseBodySize:
type: string
title: Max response body size
description: Maximum size of the HTTP SD response body. Responses exceeding this
limit will be rejected. Defaults to 20 MB.
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
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_dimensionList:
type: string
description: Binds 'dimensionList' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'dimensionList' at runtime.
__template_discoveryType:
type: string
description: Binds 'discoveryType' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'discoveryType' at runtime.
__template_logLevel:
type: string
description: Binds 'logLevel' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logLevel' at runtime.
__template_targetList:
type: string
description: Binds 'targetList' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'targetList' at runtime.
__template_nameList:
type: string
description: Binds 'nameList' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'nameList' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
dimensionList:
type: array
title: Extra Dimensions
minItems: 0
description: Other dimensions to include in events
items:
type: string
title: dimension
fieldPerMetric:
type: boolean
title: Use field per metric
description: "When enabled, each metric name is used as the event field key
(example: go_threads: 9) instead of the default _metric/_value
format."
discoveryType:
title: Discovery type
type: string
enum:
- static
- dns
- ec2
- k8s-node
- k8s-pods
- k8s-service-monitor
- http_sd
x-speakeasy-enum-descriptions:
- Static
- DNS
- AWS EC2
- Kubernetes Node
- Kubernetes Pods
- Kubernetes Service Monitor (v4.18+)
- HTTP SD
description: Target discovery mechanism. Use static to manually enter a list of
targets.
x-speakeasy-unknown-values: allow
interval:
type: number
title: Poll Interval
description: How often in seconds to scrape targets for metrics.
minimum: 2
timeout:
type: number
title: HTTP Connection Timeout
description: Timeout, in milliseconds, before aborting HTTP connection attempts;
1-60000 or 0 to disable
maximum: 60000
minimum: 0
persistence:
$ref: "#/components/schemas/DiskSpoolingType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
authType:
title: Authentication method
type: string
enum:
- manual
- secret
- kubernetes
description: Enter credentials directly, or select a stored secret
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
targets:
type: array
title: Targets
minItems: 1
items:
type: object
required:
- host
properties:
protocol:
$ref: "#/components/schemas/ProtocolOptionsTargetsItems"
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
path:
type: string
title: Path
description: Path to use when collecting metrics from discovered targets
pattern: ^/.*
description: Targets
recordType:
$ref: "#/components/schemas/RecordTypeOptions"
scrapePort:
type: number
title: Port
description: The port number in the metrics URL for discovered targets.
minimum: 1
maximum: 65535
nameList:
type: array
title: DNS names
minItems: 1
description: List of DNS names to resolve
items:
type: string
title: DNS names
scrapeProtocol:
$ref: "#/components/schemas/ProtocolOptionsTargetsItems"
scrapePath:
type: string
title: Path
description: Path to use when collecting metrics from discovered targets
pattern: ^/.*
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsApiKey:
type: string
title: Access key
description: Access key
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. Disable to use the
private IP address.
searchFilter:
title: Search filter
description: Filter to apply when searching for EC2 instances
type: array
items:
$ref: "#/components/schemas/SearchFilterConfInputPrometheus"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for EC2
description: Use Assume Role credentials to access EC2
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
serviceMonitorNamespace:
type: string
title: ServiceMonitor Namespace
description: "Namespace to search for ServiceMonitor resources. Leave empty to
search in all namespaces. Note: Kubernetes Service Monitor discovery
requires Cribl Edge version 4.18 or greater. Nodes running an older
version with this option configured will report an error due to
configuration schema validation failure."
scrapeProtocolExpr:
type: string
title: Protocol
description: Protocol to use when collecting metrics
scrapePortExpr:
type: string
title: Port
description: The port number in the metrics URL for discovered targets.
scrapePathExpr:
type: string
title: Path
description: Path to use when collecting metrics from discovered targets
podFilter:
type: array
title: Filter Rules
description: |
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
httpDiscoveryUrl:
type: string
title: Discovery URL
description: URL to fetch target groups from (must be http or https)
pattern: ^https?://
httpDiscoveryHeaders:
type: array
title: HTTP headers
description: Extra headers to send with the discovery request
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
httpDiscoveryRejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject TLS certificates that cannot be verified for the discovery
endpoint. Falls back to the source-level setting if not specified.
maxResponseBodySize:
type: string
title: Max response body size
description: Maximum size of the HTTP SD response body. Responses exceeding this
limit will be rejected. Defaults to 20 MB.
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
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_dimensionList:
type: string
description: Binds 'dimensionList' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'dimensionList' at runtime.
__template_nameList:
type: string
description: Binds 'nameList' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'nameList' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
planType:
$ref: "#/components/schemas/SubscriptionPlanOptions"
tenantId:
type: string
title: Tenant ID
description: Microsoft 365 Azure Tenant ID
appId:
type: string
title: App ID
description: Microsoft 365 Azure Application ID
timeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout, use 0 to disable
minimum: 0
maximum: 2400
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
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]?$
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
items:
type: object
properties:
contentType:
type: string
title: Content Type
description: Microsoft 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
description: Interval
logLevel:
$ref: "#/components/schemas/LogLevelOptionsContentConfigItems"
enabled:
type: boolean
title: Enabled
description: Enabled
description: "Enable Microsoft 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
Microsoft 365 events are available for retrieval.
minimum: 0
maximum: 7200
retryRules:
$ref: "#/components/schemas/RetryRulesTypeCodesEnableHeader"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsManualSecret"
description:
type: string
title: Description
description: Optional description for this configuration.
clientSecret:
type: string
title: Client secret
description: Microsoft 365 Azure client secret
textSecret:
type: string
title: Client secret (text secret)
description: Select or create a stored text secret
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_planType:
type: string
description: Binds 'planType' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'planType' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_appId:
type: string
description: Binds 'appId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'appId' at runtime.
__template_publisherIdentifier:
type: string
description: Binds 'publisherIdentifier' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'publisherIdentifier' at runtime.
__template_clientSecret:
type: string
description: Binds 'clientSecret' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientSecret' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
planType:
$ref: "#/components/schemas/SubscriptionPlanOptions"
tenantId:
type: string
title: Tenant ID
description: Microsoft 365 Azure Tenant ID
appId:
type: string
title: App ID
description: Microsoft 365 Azure Application ID
timeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout, use 0 to disable
minimum: 0
maximum: 2400
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
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]?$
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
contentConfig:
type: array
title: Content Types
items:
type: object
properties:
contentType:
type: string
title: Content Type
description: Microsoft 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
description: Interval
logLevel:
$ref: "#/components/schemas/LogLevelOptionsContentConfigItems"
enabled:
type: boolean
title: Enabled
description: Enabled
description: "Enable Microsoft 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:
$ref: "#/components/schemas/RetryRulesTypeCodesEnableHeader"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsManualSecret"
description:
type: string
title: Description
description: Optional description for this configuration.
clientSecret:
type: string
title: Client secret
description: Microsoft 365 Azure client secret
textSecret:
type: string
title: Client secret (text secret)
description: Select or create a stored text secret
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_planType:
type: string
description: Binds 'planType' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'planType' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_appId:
type: string
description: Binds 'appId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'appId' at runtime.
__template_clientSecret:
type: string
description: Binds 'clientSecret' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientSecret' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
url:
title: Report URL
type: string
description: URL to use when retrieving report data.
interval:
type: integer
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
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
disableTimeFilter:
type: boolean
title: Disable time filter
description: Disables time filtering of events when a date range is specified.
authType:
title: Authentication method
type: string
enum:
- manual
- secret
- oauth
- oauthSecret
- oauthCert
description: Select authentication method.
x-speakeasy-unknown-values: allow
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
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]?$
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
rescheduleDroppedTasks:
type: boolean
title: Reschedule tasks
description: Reschedule tasks that failed with non-fatal errors
maxTaskReschedule:
type: number
title: Task reschedule limit
description: Maximum number of times a task can be rescheduled
minimum: 1
logLevel:
$ref: "#/components/schemas/LogLevelOptionsDebugError"
retryRules:
$ref: "#/components/schemas/RetryRulesTypeCodesEnableHeader"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
planType:
$ref: "#/components/schemas/SubscriptionPlanOptions"
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:
$ref: "#/components/schemas/CertOptionsType"
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_resource:
type: string
description: Binds 'resource' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'resource' at runtime.
__template_planType:
type: string
description: Binds 'planType' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'planType' at runtime.
InputMicrosoftGraph:
type: object
required:
- type
- url
- interval
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- microsoft_graph
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
url:
title: Endpoint
type: string
description: Microsoft Graph API endpoint URL. (ex.
https://graph.microsoft.com/v1.0/admin/exchange/tracing/messageTraces)
interval:
type: integer
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
startDate:
title: Date range start
type: string
description: "Backward offset for the search range's head. (E.g.: -3h@h)
Microsoft Graph 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)
Microsoft Graph 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
disableTimeFilter:
type: boolean
title: Disable time filter
description: Disables time filtering of events when a date range is specified.
maxPages:
type: integer
title: Page limit
description: Maximum number of pages to retrieve per collection task. Set to 0
to retrieve all pages.
minimum: 0
authType:
title: Authentication method
type: string
enum:
- oauth
- oauthSecret
- oauthCert
description: Select authentication method.
x-speakeasy-unknown-values: allow
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
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]?$
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
rescheduleDroppedTasks:
type: boolean
title: Reschedule tasks
description: Reschedule tasks that failed with non-fatal errors
maxTaskReschedule:
type: number
title: Task reschedule limit
description: Maximum number of times a task can be rescheduled
minimum: 1
logLevel:
$ref: "#/components/schemas/LogLevelOptionsDebugError"
retryRules:
$ref: "#/components/schemas/RetryRulesTypeCodesEnableHeader"
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
minimum: 10
maximum: 43200000
description:
type: string
title: Description
description: Optional description for this configuration.
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.
planType:
type: string
title: Subscription plan
description: Microsoft 365 subscription plan for your organization, typically
Microsoft 365 Enterprise
enum:
- enterprise_gcc
- gcc
- gcc_high
- dod
- china
x-speakeasy-enum-descriptions:
- Microsoft 365 Enterprise
- Microsoft 365 GCC
- Microsoft 365 GCC High
- Microsoft 365 DoD
- Microsoft 365 China (21Vianet)
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:
$ref: "#/components/schemas/CertOptionsType"
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_resource:
type: string
description: Binds 'resource' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'resource' at runtime.
__template_planType:
type: string
description: Binds 'planType' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'planType' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
items:
type: string
minLength: 1
groupId:
type: string
title: Group ID
description: The consumer group this instance belongs to. Default is 'Cribl'.
fromBeginning:
type: boolean
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
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
sasl:
$ref: "#/components/schemas/AuthenticationTypeUse"
tls:
$ref: "#/components/schemas/TlsSettingsClientSideType"
sessionTimeout:
type: number
title: Session timeout (ms)
description: |-
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).
minimum: 6000
maximum: 300000
rebalanceTimeout:
type: number
title: Rebalance timeout (ms)
description: |-
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).
minimum: 1000
maximum: 3600000
heartbeatInterval:
type: number
title: Heartbeat interval (ms)
description: |-
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).
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
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
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
minimizeDuplicates:
type: boolean
title: Minimize duplicates
description: Minimize duplicate events by starting only one consumer for each
topic partition
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_brokers:
type: string
description: Binds 'brokers' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'brokers' at runtime.
__template_topics:
type: string
description: Binds 'topics' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topics' at runtime.
__template_groupId:
type: string
description: Binds 'groupId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'groupId' at runtime.
InputEventhubAmqp:
type: object
required:
- type
- consumerGroup
- checkpointing
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- eventhub_amqp
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
eventHubName:
type: string
title: Event Hub name
description: The name of the Event Hub to consume from
minLength: 1
consumerGroup:
type: string
title: Consumer group
description: The consumer group this instance belongs to. Default is '$Default'.
minLength: 1
auth:
type: object
required:
- mechanism
properties:
mechanism:
type: string
enum:
- connection-string
- oauth-bearer
x-speakeasy-enum-descriptions:
- Connection String
- OAuth Bearer
title: Authentication mechanism
description: Authentication mechanism
x-speakeasy-unknown-values: allow
textSecret:
type: string
title: Connection string (text secret)
description: Select or create a stored text secret
clientSecretAuthType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuth"
clientTextSecret:
type: string
title: Client Secret (text secret)
description: Select or create a stored text secret
certificate:
type: object
required:
- certificateName
- certPath
- privKeyPath
properties:
certificateName:
type: string
title: Certificate
description: The certificate you registered as credentials for your app in the
Azure portal
certPath:
type: string
title: Certificate path
description: Path on server containing certificates to use. PEM format. Can
reference $ENV_VARS.
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
oauthEndpoint:
$ref: "#/components/schemas/MicrosoftEntraIdAuthenticationEndpointOptionsSasl"
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
fullyQualifiedNamespace:
type: string
title: Fully qualified namespace
description: The fully qualified Event Hubs namespace that the consumer is
associated with. This is likely to be similar to
{yournamespace}.servicebus.windows.net.
__template_oauthEndpoint:
type: string
description: Binds 'oauthEndpoint' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'oauthEndpoint' at
runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_fullyQualifiedNamespace:
type: string
description: Binds 'fullyQualifiedNamespace' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'fullyQualifiedNamespace' at runtime.
checkpointing:
type: object
required:
- blobStore
properties:
blobStore:
type: object
title: Azure Blob Storage
required:
- containerName
properties:
containerName:
type: string
title: Container name
description: Azure Blob Storage container used to store checkpoints. Must be
3–63 lowercase alphanumeric characters or hyphens.
minLength: 3
maxLength: 63
pattern: ^[a-z0-9](-?[a-z0-9])*$
authType:
title: Authentication method
type: string
enum:
- secret
- clientSecret
- clientCert
- clientAssertion
- clientAssertion_rpc
description: Authentication method
x-speakeasy-unknown-values: allow
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:
$ref: "#/components/schemas/CertificateTypeAzureBlobAuthTypeClientCert"
__template_storageAccountName:
type: string
description: Binds 'storageAccountName' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or
'cribl.'/'edge.' prefixed ID (group-scoped). Variable value
overrides 'storageAccountName' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at
runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at
runtime.
__template_azureCloud:
type: string
description: Binds 'azureCloud' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'azureCloud' at
runtime.
description: Azure Blob Storage
fromBeginning:
type: boolean
title: From beginning
description: Start reading from earliest available data; relevant only during
initial subscription
maxBatchSize:
type: integer
minimum: 1
title: Max batch size
description: Maximum number of events in each batch delivered to the consumer
maxWaitTimeInSeconds:
type: integer
minimum: 1
title: Max wait time (secs)
description: Maximum time to wait for a batch of events before delivering a
partial batch
prefetchCount:
type: integer
minimum: 1
title: Prefetch count
description: Number of events to prefetch from the service for processing
maxRetries:
type: integer
minimum: 0
title: Retry limit
description: Maximum number of retries per operation
initialBackoff:
type: integer
minimum: 300
title: Initial retry interval (ms)
description: Initial delay before the first retry, in milliseconds
maxBackoff:
type: integer
minimum: 30000
title: Backoff limit (ms)
description: Maximum delay between retries, in milliseconds
timeoutInMs:
type: integer
minimum: 1000
title: Request timeout (ms)
description: Maximum time to wait for a request to complete
connectionInitialBackoff:
type: integer
minimum: 1
title: Connection initial retry interval (ms)
description: Initial delay before the first reconnection attempt, in milliseconds
connectionMaxBackoff:
type: integer
minimum: 1
title: Connection backoff limit (ms)
description: Maximum delay between reconnection attempts, in milliseconds
connectionTimeoutInMs:
type: integer
minimum: 1000
title: Connection timeout (ms)
description: Maximum time to wait for a connection to complete
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
InputExec:
type: object
required:
- type
- command
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
enum:
- exec
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: Disabled
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
command:
type: string
title: Command
description: Command to execute; supports Bourne shell (or CMD on Windows) syntax
script:
type: string
title: Script
description: Optional script content to pipe into the command's stdin. The stdin
stream is closed after the script is written.
retries:
type: number
title: Retry limit
description: Maximum number of retry attempts in the event that the command fails
minimum: 0
scheduleType:
title: Schedule type
type: string
enum:
- interval
- cronSchedule
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
minimum: 10
maximum: 43200000
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
interval:
type: number
title: Interval
description: Interval between command executions in seconds.
minimum: 1
cronSchedule:
type: string
title: Schedule
description: Cron schedule to execute the command on.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
InputFirehose:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- firehose
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
type: string
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_authTokens:
type: string
description: Binds 'authTokens' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'authTokens' at runtime.
InputGooglePubsub:
type: object
required:
- type
- subscriptionName
- topicName
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsGooglepubsub"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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.
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
createTopic:
type: boolean
title: Create topic
description: Create topic if it does not exist
createSubscription:
type: boolean
title: Create subscription
description: Create subscription if it does not exist
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:
$ref: "#/components/schemas/GoogleAuthenticationMethodOptions"
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
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.
minimum: 1
maximum: 100
requestTimeout:
type: number
title: Request timeout (ms)
description: Pull request timeout, in milliseconds
minimum: 10000
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_topicName:
type: string
description: Binds 'topicName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topicName' at runtime.
__template_subscriptionName:
type: string
description: Binds 'subscriptionName' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'subscriptionName' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
InputCribl:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- cribl
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
filter:
type: string
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
InputCriblTcp:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsCribltcp"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process.
Use 0 for unlimited.
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.
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.
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.
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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
enableLoadBalancing:
type: boolean
title: Enable load balancing
description: Load balance traffic across all Worker Processes
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:
$ref: "#/components/schemas/AuthTokenConfInputCriblTcp"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputCriblHttp:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- cribl_http
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
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:
$ref: "#/components/schemas/AuthTokenConfInputCriblTcp"
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputCriblLakeHttp:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- cribl_lake_http
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
type: string
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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.
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.
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.
pattern: ^/|^$
splunkHecAcks:
type: boolean
title: Enable Splunk HEC acknowledgements
description: Enable Splunk HEC acknowledgements
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
authTokensExt:
type: array
title: Auth tokens
items:
type: object
required:
- token
properties:
token:
type: string
title: Token
description: Token
description:
type: string
metadata:
type: array
title: Fields
description: Fields to add to events referencing this token
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
splunkHecMetadata:
type: object
properties:
enabled:
type: boolean
title: Splunk HEC
description: When enabled, the token value is available on events as __hecToken
defaultDataset:
type: string
allowedIndexesAtToken:
type: array
minItems: 0
items:
type: string
minLength: 1
elasticsearchMetadata:
type: object
properties:
enabled:
title: Elasticsearch
type: boolean
description: Elasticsearch
defaultDataset:
type: string
description: Auth tokens
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_authTokens:
type: string
description: Binds 'authTokens' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'authTokens' at runtime.
__template_criblAPI:
type: string
description: Binds 'criblAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'criblAPI' at runtime.
__template_elasticAPI:
type: string
description: Binds 'elasticAPI' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'elasticAPI' at runtime.
__template_splunkHecAPI:
type: string
description: Binds 'splunkHecAPI' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'splunkHecAPI' at runtime.
InputTcpjson:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsTcpjson"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to establish a
connection
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process.
Use 0 for unlimited.
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.
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.
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.
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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
enableLoadBalancing:
type: boolean
title: Enable load balancing
description: Load balance traffic across all Worker Processes
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputSystemMetrics:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- system_metrics
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
interval:
type: number
minimum: 1
title: Polling interval
description: Time, in seconds, between consecutive metric collections. Default
is 10 seconds.
host:
type: object
properties:
mode:
$ref: "#/components/schemas/ModeOptionsHost"
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
x-speakeasy-unknown-values: allow
processes:
type: boolean
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
x-speakeasy-unknown-values: allow
perCpu:
type: boolean
title: Per-CPU metrics
description: Generate metrics for each CPU
detail:
type: boolean
title: Detailed metrics
description: Generate metrics for all CPU states
time:
type: boolean
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
x-speakeasy-unknown-values: allow
detail:
type: boolean
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
x-speakeasy-unknown-values: allow
detail:
type: boolean
title: Detailed metrics
description: Generate full network metrics
protocols:
type: boolean
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."
items:
type: string
perInterface:
type: boolean
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
x-speakeasy-unknown-values: allow
detail:
type: boolean
title: Detailed metrics
description: Generate full disk metrics
inodes:
type: boolean
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."
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."
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."
items:
type: string
perDevice:
type: boolean
title: Per-device metrics
description: Generate separate metrics for each device
process:
$ref: "#/components/schemas/ProcessType"
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
x-speakeasy-unknown-values: allow
dockerSocket:
type: array
title: Docker socket
description: Full paths for Docker's UNIX-domain socket
items:
type: string
dockerTimeout:
type: number
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
description: Expression
allContainers:
type: boolean
title: All containers
description: Include stopped and paused containers
perDevice:
type: boolean
title: Per-device metrics
description: Generate separate metrics for each device
detail:
type: boolean
title: Detailed metrics
description: Generate full container metrics
gpu:
$ref: "#/components/schemas/GpuType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
persistence:
type: object
title: persistence
properties:
enable:
type: boolean
title: Enable disk spooling
description: Spool metrics to disk for Cribl Edge and Search
timeWindow:
type: string
title: Bucket time span
description: Time span for each file bucket
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})?$
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]$
compress:
$ref: "#/components/schemas/DataCompressionFormatOptionsPersistence"
destPath:
type: string
title: Path location
description: Path to use to write metrics. Defaults to
$CRIBL_HOME/state/system_metrics
description: persistence
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
InputSystemState:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- system_state
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
interval:
type: number
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
description: Enabled
interfaces:
type: object
title: Interfaces
description: Creates events for each of the host’s network interfaces
properties:
enable:
type: boolean
title: Enabled
description: Enabled
disk:
type: object
title: Disks & File Systems
description: Creates events for physical disks, partitions, and file systems
properties:
enable:
type: boolean
title: Enabled
description: Enabled
metadata:
type: object
title: Host Info
description: Creates events based on the host system’s current state
properties:
enable:
type: boolean
title: Enabled
description: Enabled
routes:
type: object
title: Routes
description: Creates events based on entries collected from the host’s network
routes
properties:
enable:
type: boolean
title: Enabled
description: Enabled
dns:
type: object
title: DNS
description: Creates events for DNS resolvers and search entries
properties:
enable:
type: boolean
title: Enabled
description: Enabled
user:
type: object
title: Users & Groups
description: Creates events for local users and groups
properties:
enable:
type: boolean
title: Enabled
description: Enabled
firewall:
type: object
title: Firewall
description: Creates events for Firewall rules entries
properties:
enable:
type: boolean
title: Enabled
description: Enabled
services:
type: object
title: Services
description: Creates events from the list of services
properties:
enable:
type: boolean
title: Enabled
description: Enabled
ports:
type: object
title: Listening Ports
description: Creates events from list of listening ports
properties:
enable:
type: boolean
title: Enabled
description: Enabled
loginUsers:
type: object
title: Logged-In Users
description: Creates events from list of logged-in users
properties:
enable:
type: boolean
title: Enabled
description: Enabled
persistence:
type: object
properties:
enable:
type: boolean
title: Enable disk spooling
description: Spool metrics to disk for Cribl Edge and Search
timeWindow:
type: string
title: Bucket time span
description: Time span for each file bucket
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})?$
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]$
compress:
$ref: "#/components/schemas/DataCompressionFormatOptionsPersistence"
destPath:
type: string
title: Path location
description: Path to use to write metrics. Defaults to
$CRIBL_HOME/state/system_state
disableNativeModule:
type: boolean
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)
disableNativeLastLogModule:
type: boolean
title: Use legacy collection for LastLog
description: Enable only to collect LastLog data via legacy implementation. This
option will be removed in a future release. Please contact Support
before enabling. [Learn
more](https://docs.cribl.io/edge/sources-system-state/#advanced-tab)
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
InputKubeMetrics:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- kube_metrics
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
interval:
type: number
minimum: 1
title: Polling interval
description: Time, in seconds, between consecutive metrics collections. Default
is 15 secs.
scrapeKubelet:
type: boolean
title: Collect kubelet metrics
description: Enable to scrape kubelet metrics from
https://:10250/metrics. Requires Edge to run as a DaemonSet
with direct network access to the node.
scrapeCadvisor:
type: boolean
title: Collect cAdvisor metrics
description: Scrape cAdvisor container metrics from
https://:10250/metrics/cadvisor. Requires Edge to run as a
DaemonSet with direct network access to the Node.
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:
$ref: "#/components/schemas/RuleConfInputKubeMetrics"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
persistence:
type: object
title: persistence
properties:
enable:
type: boolean
title: Enable disk spooling
description: Spool metrics on disk for Cribl Search
timeWindow:
type: string
title: Bucket time span
description: Time span for each file bucket
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})?$
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]$
compress:
$ref: "#/components/schemas/DataCompressionFormatOptionsPersistence"
destPath:
type: string
title: Path location
description: Path to use to write metrics. Defaults to $CRIBL_HOME/state/
description: persistence
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
InputKubeLogs:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- kube_logs
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
interval:
type: number
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
timestamps:
type: boolean
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.
lineBufferLimit:
type: number
minimum: 1024
title: Line buffer limit
description: Maximum bytes to buffer while reassembling a single log line. A
line that exceeds this size is flushed as-is, either whole or
partially. The default is 1048576 (1 MB).
__LBDisableAssembly:
type: boolean
description: Internal flag to disable LB worker payload reassembly.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
persistence:
$ref: "#/components/schemas/DiskSpoolingType"
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
minimum: 10
maximum: 43200000
enableLoadBalancing:
type: boolean
title: Enable load balancing
description: Load balance traffic across all Worker Processes
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
InputKubeEvents:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- kube_events
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
rules:
type: array
title: Filter Rules
description: Filtering on event fields
items:
$ref: "#/components/schemas/RuleConfInputKubeMetrics"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
InputWindowsMetrics:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- windows_metrics
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
interval:
type: number
minimum: 1
title: Polling interval
description: Time, in seconds, between consecutive metric collections. Default
is 10 seconds.
host:
type: object
properties:
mode:
$ref: "#/components/schemas/ModeOptionsHost"
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
x-speakeasy-unknown-values: allow
detail:
type: boolean
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
x-speakeasy-unknown-values: allow
perCpu:
type: boolean
title: Per-CPU metrics
description: Generate metrics for each CPU
detail:
type: boolean
title: Detailed metrics
description: Generate metrics for all CPU states
time:
type: boolean
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
x-speakeasy-unknown-values: allow
detail:
type: boolean
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
x-speakeasy-unknown-values: allow
detail:
type: boolean
title: Detailed metrics
description: Generate full network metrics
protocols:
type: boolean
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.
items:
type: string
perInterface:
type: boolean
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
x-speakeasy-unknown-values: allow
perVolume:
type: boolean
title: Per volume metrics
description: Generate separate metrics for each volume
detail:
type: boolean
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."
items:
type: string
process:
$ref: "#/components/schemas/ProcessType"
gpu:
$ref: "#/components/schemas/GpuType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
persistence:
type: object
title: persistence
properties:
enable:
type: boolean
title: Enable disk spooling
description: Spool metrics to disk for Cribl Edge and Search
timeWindow:
type: string
title: Bucket time span
description: Time span for each file bucket
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})?$
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]$
compress:
$ref: "#/components/schemas/DataCompressionFormatOptionsPersistence"
destPath:
type: string
title: Path location
description: Path to use to write metrics. Defaults to
$CRIBL_HOME/state/windows_metrics
description: persistence
disableNativeModule:
type: boolean
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
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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: .*"
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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
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."
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).
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.
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.
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.
includeSqsMetadata:
type: boolean
title: Include notification metadata
description: Attach SQS notification metadata to a __sqsMetadata field on each
event
enableAssumeRole:
type: boolean
title: Enable for Amazon S3
description: Use Assume Role credentials to access Amazon S3
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
enableSQSAssumeRole:
type: boolean
title: Enable for Amazon SQS
description: Use Assume Role credentials when accessing Amazon SQS
sharedCredentials:
type: boolean
title: Share credentials for SQS and S3
description: Use the same credential settings for S3 and SQS
sharedAssumeRoleArn:
type: boolean
title: Share AssumeRole ARN settings
description: Use the same settings for S3 and SQS
preprocess:
$ref: "#/components/schemas/PreprocessType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
checkpointing:
$ref: "#/components/schemas/CheckpointingType"
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.
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
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAssumeRoleArn:
type: string
title: SQS AssumeRole ARN
description: Amazon Resource Name (ARN) of the role to assume
pattern: "^arn:"
minLength: 20
SQSAssumeRoleExternalId:
type: string
title: SQS External ID
description: External ID to use when assuming role
SQSDurationSeconds:
type: number
title: SQS 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
SQSAwsAuthenticationMethod:
$ref: "#/components/schemas/SqsAuthenticationMethodOptions"
SQSAwsSecret:
type: string
title: SQS secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAwsSecretKey:
type: string
title: SQS secret key
description: SQS secret key
tagAfterProcessing:
$ref: "#/components/schemas/TagAfterProcessingOptions"
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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_awsAccountId:
type: string
description: Binds 'awsAccountId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsAccountId' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_SQSAssumeRoleArn:
type: string
description: Binds 'SQSAssumeRoleArn' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleArn' at runtime.
__template_SQSAssumeRoleExternalId:
type: string
description: Binds 'SQSAssumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleExternalId' at runtime.
__template_SQSAwsSecretKey:
type: string
description: Binds 'SQSAwsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'SQSAwsSecretKey' at
runtime.
InputDatadogAgent:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- datadog_agent
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
extractMetrics:
type: boolean
title: Extract metrics
description: Extract each incoming metric to multiple events, one per data
point. Recommended when sending metrics to a statsd-type output. If
sending metrics to DatadogHQ or any destination that accepts
arbitrary JSON, leave disabled.
samplingRate:
type: number
title: Global sampling rate
description: The rate_by_service hint sent to connected tracers as the catch-all
sampling rate. Applies to any service/environment not explicitly
listed in Per-Service Sampling Rules. 1.0 = keep all traces
(default); 0.0 = suggest dropping all.
minimum: 0
maximum: 1
samplingRules:
type: array
title: Per-service sampling rules
description: Per-service sampling rate hints. Each row maps to a
"service:,env:" key in the rate_by_service response sent to
tracers.
minItems: 0
items:
type: object
required:
- service
- environment
- rate
properties:
service:
type: string
title: Service
description: Datadog service name
minLength: 1
environment:
type: string
title: Environment
description: "Datadog environment name (example: prod, staging)"
minLength: 1
rate:
type: number
title: Rate
description: Sampling rate for this service/environment combination (0.0–1.0)
minimum: 0
maximum: 1
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
proxyMode:
type: object
title: ""
required:
- enabled
properties:
enabled:
type: boolean
title: Forward API key validation requests
description: Forward key validation requests from the Datadog Agent to the
Datadog API. If disabled, Stream handles key validation requests
locally 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 (such as self-signed certificates)
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputDatagen:
type: object
required:
- type
- samples
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- datagen
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
samples:
title: Datagens
type: array
minItems: 1
items:
type: object
required:
- sample
- eventsPerSec
properties:
sample:
type: string
title: Data Generator File Name
description: 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.
minimum: 1
description: Datagens
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
InputHttpRaw:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- http_raw
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
type: string
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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
minimum: 10
maximum: 43200000
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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.
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.
items:
type: string
minLength: 1
authTokensExt:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
$ref: "#/components/schemas/AuthTokensExtConfInputHttp"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_authTokens:
type: string
description: Binds 'authTokens' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'authTokens' at runtime.
__template_allowedPaths:
type: string
description: Binds 'allowedPaths' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'allowedPaths' at runtime.
InputKinesis:
type: object
required:
- type
- streamName
- region
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsKinesis"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
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.
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
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
x-speakeasy-unknown-values: allow
getRecordsLimit:
type: number
title: Records limit per call
description: Maximum number of records per getRecords call
minimum: 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
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
x-speakeasy-unknown-values: allow
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for Kinesis stream
description: Use Assume Role credentials to access Kinesis stream
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
verifyKPLCheckSums:
type: boolean
title: Verify KPL checksums
description: Verify Kinesis Producer Library (KPL) event checksums
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_streamName:
type: string
description: Binds 'streamName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamName' at runtime.
__template_shardIteratorType:
type: string
description: Binds 'shardIteratorType' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'shardIteratorType' at runtime.
__template_payloadFormat:
type: string
description: Binds 'payloadFormat' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'payloadFormat' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
InputCriblmetrics:
type: object
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- criblmetrics
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
prefix:
type: string
title: Metric name prefix
description: A prefix that is applied to the metrics provided by Cribl Stream
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)`."
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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.
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.
minimum: 0
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to send data
enableProxyHeader:
type: boolean
title: Enable proxy protocol
description: Enable if the connection is proxied by a device that supports Proxy
Protocol V1 or V2
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_udpPort:
type: string
description: Binds 'udpPort' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'udpPort' at runtime.
__template_tcpPort:
type: string
description: Binds 'tcpPort' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tcpPort' at runtime.
InputS3:
type: object
required:
- type
- queueName
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsS3"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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: .*"
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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
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."
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).
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.
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.
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.
includeSqsMetadata:
type: boolean
title: Include notification metadata
description: Attach SQS notification metadata to a __sqsMetadata field on each
event
enableAssumeRole:
type: boolean
title: Enable for Amazon S3
description: Use Assume Role credentials to access Amazon S3
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
enableSQSAssumeRole:
type: boolean
title: Enable for Amazon SQS
description: Use Assume Role credentials when accessing Amazon SQS
sharedCredentials:
type: boolean
title: Share credentials for SQS and S3
description: Use the same credential settings for S3 and SQS
sharedAssumeRoleArn:
type: boolean
title: Share AssumeRole ARN settings
description: Use the same settings for S3 and SQS
preprocess:
$ref: "#/components/schemas/PreprocessType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit (MB)
description: Maximum file size for each Parquet chunk
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.
maximum: 3600
minimum: 1
checkpointing:
$ref: "#/components/schemas/CheckpointingType"
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.
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.
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAssumeRoleArn:
type: string
title: SQS AssumeRole ARN
description: Amazon Resource Name (ARN) of the role to assume
pattern: "^arn:"
minLength: 20
SQSAssumeRoleExternalId:
type: string
title: SQS External ID
description: External ID to use when assuming role
SQSDurationSeconds:
type: number
title: SQS 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
SQSAwsAuthenticationMethod:
$ref: "#/components/schemas/SqsAuthenticationMethodOptions"
SQSAwsSecret:
type: string
title: SQS secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAwsSecretKey:
type: string
title: SQS secret key
description: SQS 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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_awsAccountId:
type: string
description: Binds 'awsAccountId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsAccountId' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_SQSAssumeRoleArn:
type: string
description: Binds 'SQSAssumeRoleArn' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleArn' at runtime.
__template_SQSAssumeRoleExternalId:
type: string
description: Binds 'SQSAssumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleExternalId' at runtime.
__template_SQSAwsSecretKey:
type: string
description: Binds 'SQSAwsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'SQSAwsSecretKey' at
runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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: .*"
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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
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."
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).
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.
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.
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.
includeSqsMetadata:
type: boolean
title: Include notification metadata
description: Attach SQS notification metadata to a __sqsMetadata field on each
event
enableAssumeRole:
type: boolean
title: Enable for Amazon S3
description: Use Assume Role credentials to access Amazon S3
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
enableSQSAssumeRole:
type: boolean
title: Enable for Amazon SQS
description: Use Assume Role credentials when accessing Amazon SQS
sharedCredentials:
type: boolean
title: Share credentials for SQS and S3
description: Use the same credential settings for S3 and SQS
sharedAssumeRoleArn:
type: boolean
title: Share AssumeRole ARN settings
description: Use the same settings for S3 and SQS
preprocess:
$ref: "#/components/schemas/PreprocessType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit (MB)
description: Maximum file size for each Parquet chunk
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.
maximum: 3600
minimum: 1
checkpointing:
$ref: "#/components/schemas/CheckpointingType"
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.
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"
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.
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
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAssumeRoleArn:
type: string
title: SQS AssumeRole ARN
description: Amazon Resource Name (ARN) of the role to assume
pattern: "^arn:"
minLength: 20
SQSAssumeRoleExternalId:
type: string
title: SQS External ID
description: External ID to use when assuming role
SQSDurationSeconds:
type: number
title: SQS 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
SQSAwsAuthenticationMethod:
$ref: "#/components/schemas/SqsAuthenticationMethodOptions"
SQSAwsSecret:
type: string
title: SQS secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAwsSecretKey:
type: string
title: SQS secret key
description: SQS secret key
tagAfterProcessing:
$ref: "#/components/schemas/TagAfterProcessingOptions"
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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_awsAccountId:
type: string
description: Binds 'awsAccountId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsAccountId' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_SQSAssumeRoleArn:
type: string
description: Binds 'SQSAssumeRoleArn' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleArn' at runtime.
__template_SQSAssumeRoleExternalId:
type: string
description: Binds 'SQSAssumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleExternalId' at runtime.
__template_SQSAwsSecretKey:
type: string
description: Binds 'SQSAwsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'SQSAwsSecretKey' at
runtime.
InputSnmp:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsSnmp"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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.
port:
type: number
title: UDP port
maximum: 65535
description: UDP port to receive SNMP traps on. Defaults to 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
description: Enabled
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.
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
description: V3 name
authProtocol:
$ref: "#/components/schemas/AuthenticationProtocolOptionsV3User"
authKey:
type: string
title: V3 authentication key
description: V3 authentication key
privProtocol:
$ref: "#/components/schemas/PrivacyProtocolOptionsSnmpTrapSerializeV3UserAuthPr\
otocolNotNone"
privKey:
type: string
title: V3 privacy key
description: V3 privacy key
maxBufferSize:
type: number
title: Buffer size limit (events)
description: Maximum number of events to buffer when downstream is blocking.
minimum: 0
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to send data
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputOpenTelemetry:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- open_telemetry
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
minimum: 0
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.
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.
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.).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist.
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
protocol:
type: string
title: Protocol
description: Select whether to leverage gRPC or HTTP for OpenTelemetry
enum:
- grpc
- http
x-speakeasy-enum-descriptions:
- gRPC
- HTTP
x-speakeasy-unknown-values: allow
extractSpans:
type: boolean
title: Extract spans
description: Enable to extract each incoming span to a separate event
extractMetrics:
type: boolean
title: Extract metrics
description: Enable to extract each incoming Gauge or IntGauge metric to
multiple events, one per data point
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
x-speakeasy-unknown-values: allow
authType:
type: string
title: Authentication type
description: OpenTelemetry authentication type
enum:
- none
- basic
- credentialsSecret
- token
- textSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Token
- Token (text secret)
x-speakeasy-unknown-values: allow
authMethodsExt:
type: array
title: Auth methods
description: Shared secrets to authenticate clients. Supports Bearer tokens and
Basic auth. If empty, unauthenticated access is permitted.
minItems: 0
items:
type: object
required:
- authType
properties:
authType:
type: string
title: Authentication type
enum:
- token
- tokenSecret
- basic
- basicSecret
x-speakeasy-enum-descriptions:
- Token
- Token (secret)
- Basic
- Basic (credentials secret)
description: Authentication type
x-speakeasy-unknown-values: allow
token:
type: string
minLength: 1
pattern: .*\S.*
title: Token
description: Bearer token for Authorization header
description:
type: string
title: Description
description: Description
metadata:
type: array
title: Fields
description: Fields to add to events referencing this auth method
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
enabled:
type: boolean
title: Enable
description: Enable
tokenSecret:
type: string
title: Token secret (text secret)
description: Select or create a stored text secret
minLength: 1
username:
type: string
minLength: 1
pattern: .*\S.*
title: Username
description: Username
password:
type: string
minLength: 1
pattern: .*\S.*
title: Password
description: Password
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a secret that references your credentials
minLength: 1
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process.
Use 0 for unlimited.
minimum: 0
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
extractLogs:
type: boolean
title: Extract logs
description: Enable to extract each incoming log record to a separate event
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_protocol:
type: string
description: Binds 'protocol' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'protocol' at runtime.
__template_otlpVersion:
type: string
description: Binds 'otlpVersion' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'otlpVersion' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process.
Use 0 for unlimited.
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.
minimum: 1
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputSqs:
type: object
required:
- type
- queueName
- queueType
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsSqs"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for SQS
description: Use Assume Role credentials to access SQS
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
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."
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).
minimum: 0
maximum: 43200
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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.
minimum: 1
maximum: 20
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
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.
minimum: 1
maximum: 100
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_queueType:
type: string
description: Binds 'queueType' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueType' at runtime.
__template_awsAccountId:
type: string
description: Binds 'awsAccountId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsAccountId' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
InputSyslog:
type: object
required:
- type
- host
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsSyslog"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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.
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.
minimum: 0
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to send data
timestampTimezone:
type: string
title: Default timezone
description: Timezone to assign to timestamps without timezone info
singleMsgUdpPackets:
type: boolean
title: Single msg per UDP
description: Treat UDP packet data received as full syslog message
enableProxyHeader:
type: boolean
title: Enable proxy protocol
description: Enable if the connection is proxied by a device that supports Proxy
Protocol V1 or V2
keepFieldsList:
type: array
title: Fields to keep
description: Wildcard list of fields to keep from source data; * = ALL (default)
minItems: 0
items:
type: string
octetCounting:
type: boolean
title: Octet count framing
description: Enable if incoming messages use octet counting per RFC 6587.
inferFraming:
type: boolean
title: Infer Syslog framing
description: Enable if we should infer the syslog framing of the incoming
messages.
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.
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.
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process for
TCP connections. Use 0 for unlimited.
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.
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.
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.
minimum: 0
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
description:
type: string
title: Description
description: Optional description for this configuration.
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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_udpPort:
type: string
description: Binds 'udpPort' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'udpPort' at runtime.
__template_tcpPort:
type: string
description: Binds 'tcpPort' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tcpPort' at runtime.
__template_timestampTimezone:
type: string
description: Binds 'timestampTimezone' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'timestampTimezone' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
mode:
type: string
enum:
- manual
- auto
x-speakeasy-enum-descriptions:
- Manual
- Auto
description: Choose how to discover files to monitor
x-speakeasy-unknown-values: allow
interval:
type: number
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
items:
type: string
filterArchivedFiles:
type: boolean
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
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
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
title: Check file modification times
description: Skip files with modification times earlier than the maximum age
duration
forceText:
type: boolean
title: Force text format
description: Forces files containing binary data to be streamed as text
hashLen:
type: number
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
disableStaleChannelFlush:
type: boolean
title: Disable Event Breaker buffer timeout
description: When enabled, no Event Breaker channel flush timeout applies and
the timeout below is ignored. Prefer this option when using
header-based breakers for file types such as CSV or IIS.
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
minimum: 10
maximum: 43200000
description:
type: string
title: Description
description: Optional description for this configuration.
path:
type: string
title: Search path
description: "Directory path to search for files. Environment variables will be
resolved (example: $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
title: Suppress errors when search path does not exist
description: Suppress errors when search path does not exist
deleteFiles:
type: boolean
title: Delete files
description: Delete files after they have been collected
saltHash:
type: boolean
title: Salt file hash
description: Salt the file hash with the Source file path. Ensures that all
files with the same header hash, such as CSV files, are ingested.
Moving or renaming the file, or toggling this after starting the
Source will cause re-ingestion.
optimizeLeafDirectories:
type: boolean
title: Optimize for leaf directories
description: Skip rescans of unchanged directories based on directory
modification time. Uses an exponential backoff strategy, reducing
load on the filesystems, but possibly delaying detection of new
data. This option is optimized for search paths where files exist in
the leaf directories.
includeUnidentifiableBinary:
type: boolean
title: Enable binary files
description: Stream binary files as Base64-encoded chunks
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to establish a
connection
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process.
Use 0 for unlimited.
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.
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.
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.
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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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" } }'
preprocess:
$ref: "#/components/schemas/PreprocessType"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputAppscope:
type: object
required:
- type
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- appscope
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to establish a
connection
maxActiveCxn:
type: number
title: Active connection limit
description: Maximum number of active connections allowed per Worker Process.
Use 0 for unlimited.
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.
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.
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.
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
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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.
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
timeWindow:
type: string
title: Bucket time span
description: Time span for each file bucket
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})?$
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]$
compress:
$ref: "#/components/schemas/DataCompressionFormatOptionsPersistence"
destPath:
type: string
title: Path location
description: Path to use to write metrics. Defaults to
$CRIBL_HOME/state/appscope
description: Persistence
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
description:
type: string
title: Description
description: Optional description for this configuration.
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:
$ref: "#/components/schemas/TlsSettingsServerSideType"
unixSocketPath:
type: string
title: UNIX socket path
description: Path to the UNIX domain socket to listen on.
unixSocketPerms:
type:
- string
- number
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.
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authMethod:
type: string
title: Authentication method
description: How to authenticate incoming client connections
enum:
- clientCert
- kerberos
x-speakeasy-enum-descriptions:
- Client certificate
- Kerberos
x-speakeasy-unknown-values: allow
tls:
type: object
title: mTLS settings
required:
- privKeyPath
- certPath
- caPath
properties:
disabled:
type: boolean
title: Disabled
description: Enable TLS
rejectUnauthorized:
type: boolean
title: Validate client certs
description: Required for WEF certificate authentication
requestCert:
type: boolean
title: Authenticate client
description: Required for WEF certificate authentication
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
minVersion:
$ref: "#/components/schemas/MinimumTlsVersionOptionsTls"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsTls"
ocspCheck:
type: boolean
title: Verify certificate via OCSP
description: Enable OCSP check of certificate
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.
description: mTLS settings
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events in the __headers field
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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.
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/@
allowMachineIdMismatch:
type: boolean
title: Allow MachineID mismatch
description: Allow events to be ingested even if their MachineID does not match
the client certificate CN
subscriptions:
title: Subscriptions
description: Subscriptions to events on forwarding endpoints
type: array
items:
type: object
required:
- subscriptionName
- contentFormat
- heartbeatInterval
- batchTimeout
- targets
properties:
subscriptionName:
title: Subscription name
type: string
description: Subscription name
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
x-speakeasy-unknown-values: allow
heartbeatInterval:
title: Heartbeat
type: number
description: Maximum time (in seconds) between endpoint checkins before
considering it unavailable
minimum: 1
batchTimeout:
title: Batch timeout
type: number
description: Interval (in seconds) over which the endpoint should collect events
before sending them to Stream
minimum: 0
readExistingEvents:
title: Read existing events
type: boolean
description: Newly subscribed endpoints will send previously existing events.
Disable to receive new events only.
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.
compress:
title: Compression
type: boolean
description: Receive compressed events from the source
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
locale:
title: Locale
type: string
description: The RFC-3066 locale the Windows clients should use when sending
events. Defaults to "en-US".
querySelector:
type: string
title: Query builder mode
enum:
- simple
- xml
description: Query builder mode
x-speakeasy-unknown-values: allow
metadata:
type: array
title: Fields
description: Fields to add to events ingested under this subscription
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
queries:
type: array
title: Queries
items:
type: object
required:
- path
- queryExpression
properties:
path:
type: string
title: Path
description: The Path attribute from the relevant XML Select element
queryExpression:
type: string
title: Query expression
description: The XPath query inside the relevant XML Select element
description: Queries
xmlQuery:
type: string
title: XML query
description: The XPath query to use for selecting events
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_keytab:
type: string
description: Binds 'keytab' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'keytab' at runtime.
__template_principal:
type: string
description: Binds 'principal' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'principal' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
logNames:
type: array
title: Event logs
description: Enter the event logs to collect. Run "Get-WinEvent -ListLog *" in
PowerShell to see the available logs.
items:
minLength: 1
type: string
minItems: 1
uniqueItems: true
suppressMissingLogErrors:
type: boolean
title: Suppress missing event log errors
description: When enabled, missing event log channels will not cause the Source
to report errors. Use in Fleets where some hosts may not have all
configured event logs.
readMode:
type: string
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
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
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
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
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
maxEventBytes:
type: integer
title: Event byte limit
description: The maximum number of bytes in an event before it is flushed to the
pipelines
minimum: 1
maximum: 134217728
description:
type: string
title: Description
description: Optional description for this configuration.
disableJsonRendering:
type: boolean
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
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)
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
InputAppleUnifiedLogs:
type: object
required:
- type
- predicate
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- apple_unified_logs
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
predicate:
type: string
title: Predicate
description: String to filter log entries, in NSPredicate format (e.g.,
subsystem == "com.apple.security" or process == "kernel"). See
[Common Log Types and
Predicates](https://docs.cribl.io/edge/sources-apple-unified-logs/#examples)
for more information.
minLength: 1
readMode:
type: string
enum:
- oldest
- newest
title: Read mode
x-speakeasy-enum-descriptions:
- Entire log
- From last entry
description: Read all log entries (historical and upcoming), or only upcoming,
from the last entry
x-speakeasy-unknown-values: allow
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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.
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.
minimum: 0
ipWhitelistRegex:
type: string
title: IP allowlist regex
description: Regex matching IP addresses that are allowed to send data
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.
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.
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputJournalFiles:
type: object
required:
- type
- path
- journals
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
enum:
- journal_files
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
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.
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
currentBoot:
type: boolean
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."
suppressMissingPathErrors:
type: boolean
title: Suppress errors when search path does not exist
description: Suppress errors when search path does not exist
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
endpoint:
type: string
title: GraphQL endpoint
description: "The Wiz GraphQL API endpoint. Example:
https://api.us1.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
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
description: Description
enabled:
type: boolean
title: Enable content
description: Enable content
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event. Use the event's data and the current state to compute
the new state. See [Understanding State Expression
Fields](https://docs.cribl.io/stream/collectors-rest#state-tracking-expression-fields)
for more information.
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
a task's newly reported state with previously saved state.
Evaluates `prevState` and `newState` variables, resolving to
the state to keep.
manageState:
type: object
contentQuery:
type: string
title: Content query
description: "Template for POST body to send with the Collect request. Reference
global variables, or functions using template params:
`${C.vars.myVar}`, or `${Date.now()}`, `${param}`."
cronSchedule:
type: string
title: Cron schedule
description: A cron schedule on which to run this job
earliest:
type: string
title: Earliest time
description: "Earliest time, relative to now. Format supported:
[+|-]@ (ex: -1hr,
-42m, -42m@h)"
latest:
type: string
title: Latest time
description: "Latest time, relative to now. Format supported:
[+|-]@ (ex: -1hr,
-42m, -42m@h)"
jobTimeout:
title: Job timeout
type: string
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Units default to seconds if not specified. Enter 0 for
unlimited time."
pattern: ^\d+[sm]?$
logLevel:
$ref: "#/components/schemas/LogLevelOptionsContentConfigItemsDebugError"
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Defaults
to 0. Set to 0 to retrieve all pages.
minimum: 0
description: Content types
requestTimeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout. Use 0 to disable.
minimum: 0
maximum: 2400
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
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
minimum: 10
maximum: 43200000
retryRules:
$ref: "#/components/schemas/RetryRulesType"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsManualSecret"
description:
type: string
title: Description
description: Optional description for this configuration.
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
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_authUrl:
type: string
description: Binds 'authUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'authUrl' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
InputOpenai:
type: object
required:
- type
- contentConfig
- textSecret
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- openai
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
openaiOrganization:
type: string
title: OpenAI Organization
description: Optional `OpenAI-Organization` request header value, typically
`org-xxxxxxxxxxxxxxxxxxxxxxxx`
openaiProject:
type: string
title: OpenAI Project
description: Optional `OpenAI-Project` request header value, typically
`proj_xxxxxxxxxxxxxxxxxxxxxxxx`
contentConfig:
type: array
title: Content Types
items:
type: object
required:
- contentType
- collectPath
- requestParams
- paginationType
- cronSchedule
- earliest
- latest
properties:
contentType:
type: string
title: Content type
readOnly: true
description: Content type
contentDescription:
type: string
title: Description
readOnly: true
description: Description
collectPath:
type: string
title: Endpoint
description: OpenAI Organization API path
readOnly: true
docsUrl:
type: string
title: Docs URL
readOnly: true
description: Docs URL
disabled:
type: boolean
title: Enabled
description: Enabled
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions.
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
task state
manageState:
type: object
requestParams:
type: array
title: Query parameters
description: Query-string parameters to send with this endpoint
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
paginationType:
type: string
title: Pagination type
enum:
- none
- response_body
- response_header
- response_header_link
x-speakeasy-enum-descriptions:
- None
- Response Body Attribute
- Response Header Attribute
- RFC 5988 Link Header
description: Pagination type
x-speakeasy-unknown-values: allow
paginationAttribute:
type: array
title: Pagination attributes
items:
type: string
description: Pagination attributes
paginationLastPageExpr:
type: string
title: Last page expression
description: Last page expression
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve per collection task. Set to 0
only when unlimited pagination is required.
minimum: 0
paginationNextRelationAttribute:
type: string
title: Next relation attribute
description: Used only for RFC 5988 link-header pagination
paginationCurRelationAttribute:
type: string
title: Current relation attribute
description: Optional relation that represents the current page
cronSchedule:
type: string
title: Cron schedule
description: A cron schedule on which to run this job
earliest:
type: string
title: Earliest time
description: Relative to the current time
latest:
type: string
title: Latest time
description: Relative to the current time
jobTimeout:
title: Job timeout
type: string
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
logLevel:
type: string
title: Log level
enum:
- error
- warn
- info
- debug
- silly
description: Collector runtime log level.
x-speakeasy-unknown-values: allow
endpointMetadata:
type: array
title: Hardcoded fields
description: Fields automatically added to events from this Content Type
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description: Content Types
requestTimeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout. Use 0 to disable.
minimum: 0
maximum: 2400
apiKey:
type: string
title: API key
description: API key
textSecret:
type: string
title: API key (text secret)
description: Select or create a stored API key. Visit [OpenAI's organization
admin keys
page](https://platform.openai.com/settings/organization/admin-keys)
to create an organization admin key.
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
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
retryRules:
$ref: "#/components/schemas/RetryRulesType"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_openaiOrganization:
type: string
description: Binds 'openaiOrganization' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'openaiOrganization' at runtime.
__template_openaiProject:
type: string
description: Binds 'openaiProject' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'openaiProject' at runtime.
InputWizWebhook:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- wiz_webhook
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
type: string
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
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
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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
minimum: 10
maximum: 43200000
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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.
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.
items:
type: string
minLength: 1
authTokensExt:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
$ref: "#/components/schemas/AuthTokensExtConfInputHttp"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_authTokens:
type: string
description: Binds 'authTokens' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'authTokens' at runtime.
__template_allowedPaths:
type: string
description: Binds 'allowedPaths' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'allowedPaths' at runtime.
InputNetflow:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsNetflow"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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.
port:
type: number
title: Port
maximum: 65535
description: Port to listen on
enablePassThrough:
type: boolean
title: Enable pass-through
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.
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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
v5Enabled:
type: boolean
title: V5
description: Accept messages in Netflow V5 format.
v9Enabled:
type: boolean
title: V9
description: Accept messages in Netflow V9 format.
ipfixEnabled:
type: boolean
title: IPFIX
description: Accept messages in IPFIX format.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
InputSecurityLake:
type: object
required:
- type
- queueName
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
$ref: "#/components/schemas/TypeOptionsSecuritylake"
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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: .*"
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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
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."
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).
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.
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.
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.
includeSqsMetadata:
type: boolean
title: Include notification metadata
description: Attach SQS notification metadata to a __sqsMetadata field on each
event
enableAssumeRole:
type: boolean
title: Enable for Amazon S3
description: Use Assume Role credentials to access Amazon S3
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
enableSQSAssumeRole:
type: boolean
title: Enable for Amazon SQS
description: Use Assume Role credentials when accessing Amazon SQS
sharedCredentials:
type: boolean
title: Share credentials for SQS and S3
description: Use the same credential settings for S3 and SQS
sharedAssumeRoleArn:
type: boolean
title: Share AssumeRole ARN settings
description: Use the same settings for S3 and SQS
preprocess:
$ref: "#/components/schemas/PreprocessType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit (MB)
description: Maximum file size for each Parquet chunk
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.
maximum: 3600
minimum: 1
checkpointing:
$ref: "#/components/schemas/CheckpointingType"
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.
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
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAssumeRoleArn:
type: string
title: SQS AssumeRole ARN
description: Amazon Resource Name (ARN) of the role to assume
pattern: "^arn:"
minLength: 20
SQSAssumeRoleExternalId:
type: string
title: SQS External ID
description: External ID to use when assuming role
SQSDurationSeconds:
type: number
title: SQS 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
SQSAwsAuthenticationMethod:
$ref: "#/components/schemas/SqsAuthenticationMethodOptions"
SQSAwsSecret:
type: string
title: SQS secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAwsSecretKey:
type: string
title: SQS secret key
description: SQS secret key
tagAfterProcessing:
$ref: "#/components/schemas/TagAfterProcessingOptions"
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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_awsAccountId:
type: string
description: Binds 'awsAccountId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsAccountId' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_SQSAssumeRoleArn:
type: string
description: Binds 'SQSAssumeRoleArn' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleArn' at runtime.
__template_SQSAssumeRoleExternalId:
type: string
description: Binds 'SQSAssumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleExternalId' at runtime.
__template_SQSAwsSecretKey:
type: string
description: Binds 'SQSAwsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'SQSAwsSecretKey' at
runtime.
InputBedrockS3:
type: object
required:
- type
- queueName
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- bedrock_s3
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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: .*"
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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
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."
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).
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.
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.
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.
includeSqsMetadata:
type: boolean
title: Include notification metadata
description: Attach SQS notification metadata to a __sqsMetadata field on each
event
enableAssumeRole:
type: boolean
title: Enable for Amazon S3
description: Use Assume Role credentials to access Amazon S3
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
enableSQSAssumeRole:
type: boolean
title: Enable for Amazon SQS
description: Use Assume Role credentials when accessing Amazon SQS
sharedCredentials:
type: boolean
title: Share credentials for SQS and S3
description: Use the same credential settings for S3 and SQS
sharedAssumeRoleArn:
type: boolean
title: Share AssumeRole ARN settings
description: Use the same settings for S3 and SQS
preprocess:
$ref: "#/components/schemas/PreprocessType"
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
parquetChunkSizeMB:
type: number
title: Parquet chunk size limit (MB)
description: Maximum file size for each Parquet chunk
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.
maximum: 3600
minimum: 1
checkpointing:
$ref: "#/components/schemas/CheckpointingType"
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.
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
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAssumeRoleArn:
type: string
title: SQS AssumeRole ARN
description: Amazon Resource Name (ARN) of the role to assume
pattern: "^arn:"
minLength: 20
SQSAssumeRoleExternalId:
type: string
title: SQS External ID
description: External ID to use when assuming role
SQSDurationSeconds:
type: number
title: SQS 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
SQSAwsAuthenticationMethod:
$ref: "#/components/schemas/SqsAuthenticationMethodOptions"
SQSAwsSecret:
type: string
title: SQS secret key pair
description: Select or create a stored secret that references your access key
and secret key
SQSAwsSecretKey:
type: string
title: SQS secret key
description: SQS secret key
tagAfterProcessing:
$ref: "#/components/schemas/TagAfterProcessingOptions"
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.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_awsAccountId:
type: string
description: Binds 'awsAccountId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsAccountId' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_SQSAssumeRoleArn:
type: string
description: Binds 'SQSAssumeRoleArn' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleArn' at runtime.
__template_SQSAssumeRoleExternalId:
type: string
description: Binds 'SQSAssumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'SQSAssumeRoleExternalId' at runtime.
__template_SQSAwsSecretKey:
type: string
description: Binds 'SQSAwsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'SQSAwsSecretKey' at
runtime.
InputServicenowTable:
type: object
required:
- type
- instance
- cronSchedule
- earliest
- latest
- tableName
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- servicenow_table
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
instance:
type: string
pattern: .*\S.*
title: Instance URL
description: ServiceNow instance base URL for Table API requests. Enter a
literal URL (http or https and the instance host, for example a
hostname ending in .service-now.com) or a Cribl expression that
resolves to a URL.
tableName:
type: string
pattern: .*\S.*
title: Table name
description: ServiceNow table name to collect from.
fields:
type: array
title: Fields
description: Field names to return from the Table API (sysparm_fields). Leave
empty to return all fields.
items:
type: string
pattern: ^[^*?\[\]]+$
orderByField:
type: string
title: Sort by field
description: Optional. Sort results by this field (for example sys_created_on or
parent.name). Leave empty to use the server default order.
orderByDirection:
type: string
title: Sort direction
description: Used only when Sort by field is set.
enum:
- asc
- desc
x-speakeasy-enum-descriptions:
- Ascending
- Descending
x-speakeasy-unknown-values: allow
query:
type: string
title: Filter query (advanced)
description: Optional ServiceNow encoded query for sysparm_query (for example
active=true or sys_updated_onRELATIVEGT@hour@ago@1). Enter a literal
or a Cribl expression. When combined with Sort by field, the filter
and sort are joined with ^. See ServiceNow Table API documentation
for encoded query syntax.
pageSize:
type: integer
title: Page size
description: Maximum records per Table API page request (sysparm_limit). Setting
a higher value may increase the risk of timeouts.
minimum: 1
maxPages:
type: integer
title: Page limit
description: Maximum number of pages to retrieve per collection task. Set to 0
to retrieve all pages.
minimum: 0
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA
(such as self-signed certificates)
authType:
type: string
title: Authentication type
description: ServiceNow Table API authentication method
enum:
- none
- basicSecret
- oauthSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- OAuth
x-speakeasy-unknown-values: allow
cronSchedule:
type: string
pattern: .*\S.*
title: Cron schedule
description: Cron schedule on which to run this job
earliest:
type: string
pattern: .*\S.*
title: Earliest time
description: "Earliest time, relative to now. Format supported:
[+|-]@ (ex: -1hr, -42m,
-42m@h)"
latest:
type: string
pattern: .*\S.*
title: Latest time
description: "Latest time, relative to now. Format supported:
[+|-]@ (ex: -1hr, -42m,
-42m@h)"
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
logLevel:
$ref: "#/components/schemas/LogLevelOptions"
requestTimeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout. Use 0 to disable.
minimum: 0
useRoundRobinDns:
type: boolean
title: Round-robin DNS
description: When a DNS server returns multiple addresses, @{product} cycles
through them in the order returned
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
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]?$
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
retryRules:
$ref: "#/components/schemas/RetryRulesType"
description:
type: string
title: Description
description: Optional description for this configuration.
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a secret that references your credentials
oauthGrantType:
enum:
- client_credentials
- password
type: string
title: Grant type
description: ServiceNow OAuth grant type used for token requests
x-speakeasy-enum-descriptions:
- Password
- Client credentials
x-speakeasy-unknown-values: allow
username:
type: string
title: Username
description: ServiceNow username for the password grant type
pattern: .*\S.*
textSecret:
type: string
title: Password
description: Select or create a stored text secret for the ServiceNow password
value
useCustomOAuthParamsOrHeaders:
type: boolean
title: Use custom parameters and/or headers
description: Enable custom OAuth request parameters or headers for advanced
ServiceNow configurations. Leave disabled for standard ServiceNow
OAuth flows.
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:
$ref: "#/components/schemas/OauthParamConfInputServicenowTable"
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:
$ref: "#/components/schemas/OauthHeaderConfInputServicenowTable"
clientId:
type: string
title: ServiceNow OAuth client ID
pattern: .*\S.*
description: ServiceNow OAuth client ID
clientTextSecret:
type: string
title: Client secret
description: Select or create a stored text secret for the OAuth client secret
value
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event. This source defaults to checking that `_time` is a finite
number (not only `__timestampExtracted`), so state still advances
when the event breaker assigns a fallback time. See [Understanding
State Expression
Fields](https://docs.cribl.io/stream/collectors-rest#state-tracking-expression-fields).
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
a task's newly reported state with previously saved state. Evaluates
`prevState` and `newState` variables, resolving to the state to
keep.
manageState:
type: object
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_instance:
type: string
description: Binds 'instance' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'instance' at runtime.
__template_orderByField:
type: string
description: Binds 'orderByField' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'orderByField' at runtime.
__template_query:
type: string
description: Binds 'query' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'query' at runtime.
__template_username:
type: string
description: Binds 'username' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'username' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
InputZscalerHec:
type: object
required:
- type
- host
- port
- hecAPI
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- zscaler_hec
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
type: object
required:
- token
properties:
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
tokenSecret:
type: string
title: Token secret (text secret)
description: Select or create a stored text secret
token:
type: string
title: Token
description: "Shared secret to be provided by any client (Authorization:
)"
enabled:
type: boolean
title: Enable token
description: Enable token
description:
type: string
title: Description
description: 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:
$ref: "#/components/schemas/MetadataConfInputCollection"
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
minimum: 1
maximum: 600
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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.
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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 (.http.perToken) and summary
(.http.summary) request metrics
hecAcks:
type: boolean
description: Whether HEC acknowledgements are enabled. Always true for Zscaler
sources.
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_hecAPI:
type: string
description: Binds 'hecAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'hecAPI' at runtime.
__template_allowedIndexes:
type: string
description: Binds 'allowedIndexes' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'allowedIndexes' at
runtime.
__template_accessControlAllowOrigin:
type: string
description: Binds 'accessControlAllowOrigin' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowOrigin' at runtime.
__template_accessControlAllowHeaders:
type: string
description: Binds 'accessControlAllowHeaders' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowHeaders' at runtime.
InputCloudflareHec:
type: object
required:
- type
- host
- port
- hecAPI
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- cloudflare_hec
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
$ref: "#/components/schemas/AuthTokenConfInputCloudflareHec"
tls:
type: object
title: TLS settings (server side)
properties:
disabled:
type: boolean
title: Disabled
description: Enable or disable TLS. Defaults to enabled for Cloudflare sources.
requestCert:
type: boolean
title: Authenticate client (mutual auth)
description: Require clients to present their certificates. Used to perform
client authentication using SSL certs.
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)
commonNameRegex:
type: string
title: Common name
description: Regex matching allowable common names in peer certificates' subject
attribute
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. Defaults to the built-in Cribl private key
when TLS is enabled.
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. Defaults to the built-in Cribl certificate
when TLS is enabled.
caPath:
type: string
title: CA certificate path
description: Path on server containing CA certificates to use. PEM format. Can
reference $ENV_VARS.
minVersion:
$ref: "#/components/schemas/MinimumTlsVersionOptionsTls"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsTls"
description: TLS settings (server side)
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
minimum: 1
maximum: 600
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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 (.http.perToken) and summary
(.http.summary) request metrics
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
minimum: 10
maximum: 43200000
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_hecAPI:
type: string
description: Binds 'hecAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'hecAPI' at runtime.
__template_allowedIndexes:
type: string
description: Binds 'allowedIndexes' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'allowedIndexes' at
runtime.
__template_accessControlAllowOrigin:
type: string
description: Binds 'accessControlAllowOrigin' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowOrigin' at runtime.
__template_accessControlAllowHeaders:
type: string
description: Binds 'accessControlAllowHeaders' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowHeaders' at runtime.
InputSysdigHec:
type: object
required:
- type
- host
- port
- hecAPI
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- sysdig_hec
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
$ref: "#/components/schemas/AuthTokenConfInputCloudflareHec"
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
minimum: 1
maximum: 600
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
hecAPI:
type: string
title: HEC endpoint
description: Absolute path on which to listen for the Sysdig HTTP Event
Collector API requests. This input supports the /event and /raw
endpoints.
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:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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 (.http.perToken) and summary
(.http.summary) request metrics
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_hecAPI:
type: string
description: Binds 'hecAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'hecAPI' at runtime.
__template_allowedIndexes:
type: string
description: Binds 'allowedIndexes' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'allowedIndexes' at
runtime.
__template_accessControlAllowOrigin:
type: string
description: Binds 'accessControlAllowOrigin' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowOrigin' at runtime.
__template_accessControlAllowHeaders:
type: string
description: Binds 'accessControlAllowHeaders' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowHeaders' at runtime.
InputUpwindHec:
type: object
required:
- type
- host
- port
- hecAPI
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
description: Source type identifier.
enum:
- upwind_hec
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
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
authTokens:
type: array
title: Auth tokens
description: "Shared secrets to be provided by any client (Authorization:
). If empty, unauthorized access is permitted."
items:
$ref: "#/components/schemas/AuthTokenConfInputCloudflareHec"
tls:
$ref: "#/components/schemas/TlsSettingsServerSideType"
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."
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).
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.
captureHeaders:
type: boolean
title: Capture request headers
description: Add request headers to events, in the __headers field
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.
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.
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.
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).
minimum: 1
maximum: 600
ipAllowlistRegex:
type: string
title: IP allowlist regex
description: Messages from matched IP addresses will be processed, unless also
matched by the denylist
ipDenylistRegex:
type: string
title: IP denylist regex
description: Messages from matched IP addresses will be ignored. This takes
precedence over the allowlist.
hecAPI:
type: string
title: HEC endpoint
description: Absolute path on which to listen for the Upwind 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:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
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 (.http.perToken) and summary
(.http.summary) request metrics
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_hecAPI:
type: string
description: Binds 'hecAPI' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'hecAPI' at runtime.
__template_allowedIndexes:
type: string
description: Binds 'allowedIndexes' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'allowedIndexes' at
runtime.
__template_accessControlAllowOrigin:
type: string
description: Binds 'accessControlAllowOrigin' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowOrigin' at runtime.
__template_accessControlAllowHeaders:
type: string
description: Binds 'accessControlAllowHeaders' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accessControlAllowHeaders' at runtime.
InputOpenaiComplianceLogs:
type: object
required:
- type
- textSecret
- accountType
- cronSchedule
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- openai_compliance_logs
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
apiKey:
type: string
title: API key
description: API key
textSecret:
type: string
title: API key (text secret)
description: Select or create a stored text secret
accountType:
type: string
title: Account type
enum:
- workspace
- organization
x-speakeasy-enum-descriptions:
- Workspace
- Organization
description: Account type
x-speakeasy-unknown-values: allow
cronSchedule:
type: string
title: Cron schedule
description: Cron schedule
earliest:
type: string
title: Earliest time
description: "Relative to the current time. Format:
[+|-]"
latest:
type: string
title: Latest time
description: "Relative to the current time. Format:
[+|-]"
jobTimeout:
title: Job timeout
type: string
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
logLevel:
$ref: "#/components/schemas/LogLevelOptionsContentConfigItemsDebugError"
maxPages:
type: number
title: Page limit
description: Maximum number of log file listing pages to retrieve per run. Set
to 0 to retrieve all pages.
minimum: 0
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
requestTimeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout. Use 0 to disable.
minimum: 0
maximum: 2400
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
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
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
minimum: 10
maximum: 43200000
retryRules:
$ref: "#/components/schemas/RetryRulesType"
description:
type: string
title: Description
description: Optional description for this configuration.
workspaceId:
type: string
title: Workspace ID
description: The ID of the ChatGPT workspace to collect logs from (UUID format)
workspaceEventTypes:
type: array
title: Event types
description: One or more compliance log categories to collect
items:
type: string
uniqueItems: true
organizationId:
type: string
title: Organization ID
description: "The ID of the OpenAI API Platform Organization (example:
org-XXXXXXXXXXXXXXXXXXXXXXXX)"
organizationEventTypes:
type: array
title: Event types
description: One or more compliance log categories to collect
items:
type: string
uniqueItems: true
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event. Use the event's data and the current state to compute the new
state. See [Understanding State Expression
Fields](https://docs.cribl.io/stream/collectors-rest#state-tracking-expression-fields)
for more information.
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
a task's newly reported state with previously saved state. Evaluates
`prevState` and `newState` variables, resolving to the state to
keep.
manageState:
type: object
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_workspaceId:
type: string
description: Binds 'workspaceId' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'workspaceId' at runtime.
__template_organizationId:
type: string
description: Binds 'organizationId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'organizationId' at
runtime.
InputAnthropicCompliance:
type: object
required:
- type
- textSecret
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- anthropic_compliance
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
apiKey:
type: string
title: API key
description: API key
textSecret:
type: string
title: API key (text secret)
description: Select or create a stored Anthropic API key
activities:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
earliest:
type: string
title: Earliest
description: Earliest time for data collection, relative to now
latest:
type: string
title: Latest
description: Latest time for data collection, relative to now
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
task state
manageState:
type: object
title: Activities
description: Activities
chats:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
earliest:
type: string
title: Earliest
description: Earliest time for data collection, relative to now
latest:
type: string
title: Latest
description: Latest time for data collection, relative to now
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
task state
manageState:
type: object
title: Chats
description: Chats
projects:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
earliest:
type: string
title: Earliest
description: Earliest time for data collection, relative to now
latest:
type: string
title: Latest
description: Latest time for data collection, relative to now
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
task state
manageState:
type: object
title: Projects
description: Projects
chat_messages:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
earliest:
type: string
title: Earliest
description: Earliest time for data collection, relative to now
latest:
type: string
title: Latest
description: Latest time for data collection, relative to now
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
task state
manageState:
type: object
title: Chat Messages
description: Chat Messages
project_details:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
earliest:
type: string
title: Earliest
description: Earliest time for data collection, relative to now
latest:
type: string
title: Latest
description: Latest time for data collection, relative to now
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
stateTracking:
type: boolean
title: State tracking
description: Track collection progress between consecutive scheduled executions
stateUpdateExpression:
type: string
title: State update expression
description: JavaScript expression that defines how to update the state from an
event
stateMergeExpression:
type: string
title: State merge expression
description: JavaScript expression that defines which state to keep when merging
task state
manageState:
type: object
title: Project Details
description: Project Details
groups:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
title: Groups
description: Groups
organizations:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
title: Organizations
description: Organizations
org_users:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
title: Organization Users
description: Organization Users
org_roles:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: Enabled
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
jobTimeout:
type: string
title: Job timeout
description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m).
Enter 0 for unlimited time."
pattern: ^\d+[sm]?$
title: Organization Roles
description: Organization Roles
requestTimeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout. Use 0 to disable.
minimum: 0
maximum: 2400
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
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
retryRules:
$ref: "#/components/schemas/RetryRulesType"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
InputOkta:
type: object
required:
- type
- textSecret
- oktaDomain
properties:
id:
type: string
title: Input ID
description: Unique ID for this input
type:
type: string
enum:
- okta
description: Connector type identifier.
disabled:
type: boolean
title: Disabled
description: If true, the Source is disabled and will not collect data.
pipeline:
type: string
title: Pipeline
description: Pipeline to process data from this Source before sending it through
the Routes
sendToRoutes:
type: boolean
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
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: Metadata tags used for categorization and filtering.
items:
type: string
criblSourceProvenance:
$ref: "#/components/schemas/InputCollectionOriginDataSourceDiscoveryWithDestina\
tionArnConstraint"
connections:
type: array
title: Use QuickConnect
description: Direct connections to Destinations, and optionally via a Pipeline
or a Pack
items:
$ref: "#/components/schemas/ConnectionConfInputCollection"
pq:
$ref: "#/components/schemas/PqType"
oktaDomain:
type: string
title: Okta domain
description: "Your Okta domain (example: your-org). Do not include .okta.com,
https://, or trailing slashes."
oktaToken:
type: string
title: Okta API token
description: Your Okta API token for authentication
textSecret:
type: string
title: Okta API token (text secret)
description: Select or create a stored text secret
cronSchedule:
type: string
title: Cron schedule
description: Schedule on which to run this collection job
earliest:
type: string
title: Earliest
description: Earliest time for data collection, relative to now
latest:
type: string
title: Latest
description: Latest time for data collection, relative to now
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]?$
requestTimeout:
type: number
title: Request timeout (seconds)
description: HTTP request inactivity timeout. Use 0 to disable.
minimum: 0
maximum: 2400
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
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
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]$
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.
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
retryRules:
$ref: "#/components/schemas/RetryRulesType"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_environment:
type: string
description: Binds 'environment' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'environment' at runtime.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_oktaDomain:
type: string
description: Binds 'oktaDomain' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'oktaDomain' at runtime.
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/InputMicrosoftGraph"
- $ref: "#/components/schemas/InputEventhub"
- $ref: "#/components/schemas/InputEventhubAmqp"
- $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/InputAppleUnifiedLogs"
- $ref: "#/components/schemas/InputRawUdp"
- $ref: "#/components/schemas/InputJournalFiles"
- $ref: "#/components/schemas/InputWiz"
- $ref: "#/components/schemas/InputOpenai"
- $ref: "#/components/schemas/InputWizWebhook"
- $ref: "#/components/schemas/InputNetflow"
- $ref: "#/components/schemas/InputSecurityLake"
- $ref: "#/components/schemas/InputBedrockS3"
- $ref: "#/components/schemas/InputServicenowTable"
- $ref: "#/components/schemas/InputZscalerHec"
- $ref: "#/components/schemas/InputCloudflareHec"
- $ref: "#/components/schemas/InputSysdigHec"
- $ref: "#/components/schemas/InputUpwindHec"
- $ref: "#/components/schemas/InputOpenaiComplianceLogs"
- $ref: "#/components/schemas/InputAnthropicCompliance"
- $ref: "#/components/schemas/InputOkta"
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"
microsoft_graph: "#/components/schemas/InputMicrosoftGraph"
eventhub: "#/components/schemas/InputEventhub"
eventhub_amqp: "#/components/schemas/InputEventhubAmqp"
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"
apple_unified_logs: "#/components/schemas/InputAppleUnifiedLogs"
raw_udp: "#/components/schemas/InputRawUdp"
journal_files: "#/components/schemas/InputJournalFiles"
wiz: "#/components/schemas/InputWiz"
openai: "#/components/schemas/InputOpenai"
wiz_webhook: "#/components/schemas/InputWizWebhook"
netflow: "#/components/schemas/InputNetflow"
security_lake: "#/components/schemas/InputSecurityLake"
bedrock_s3: "#/components/schemas/InputBedrockS3"
servicenow_table: "#/components/schemas/InputServicenowTable"
zscaler_hec: "#/components/schemas/InputZscalerHec"
cloudflare_hec: "#/components/schemas/InputCloudflareHec"
sysdig_hec: "#/components/schemas/InputSysdigHec"
upwind_hec: "#/components/schemas/InputUpwindHec"
openai_compliance_logs: "#/components/schemas/InputOpenaiComplianceLogs"
anthropic_compliance: "#/components/schemas/InputAnthropicCompliance"
okta: "#/components/schemas/InputOkta"
CountedInputSplunkHec:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/InputSplunkHec"
AddHecTokenRequest:
type: object
properties:
allowedIndexesAtToken:
type: array
items:
type: string
description: List of index names that the HEC token is allowed to write to.
description:
type: string
description: Brief description for the HEC token.
enabled:
type: boolean
description: If true, the HEC token is enabled. Otherwise,
false.
metadata:
type: array
items:
$ref: "#/components/schemas/MetadataConfAddHecTokenRequest"
description: Array of key-value pairs to associate with the HEC token for
tagging, categorization, or providing additional context. Each item
in the array is an object with a name and a
value.
token:
type: string
description: The HEC token value to add to the Splunk HEC Source.
required:
- token
CountedString:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
type: string
CountedJobInfo:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/JobInfo"
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeRunnableJobCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
workerAffinity:
type: boolean
title: Worker affinity
description: If enabled, tasks are created and run by the same Worker Node
collector:
$ref: "#/components/schemas/Collector"
input:
$ref: "#/components/schemas/InputTypeRunnableJobCollection"
run:
type: object
required:
- mode
properties:
rescheduleDroppedTasks:
type: boolean
title: Reschedule tasks
description: Reschedule tasks that failed with non-fatal errors
maxTaskReschedule:
type: number
title: Task reschedule limit
description: Maximum number of times a task can be rescheduled
minimum: 1
logLevel:
$ref: "#/components/schemas/LogLevelOptionsRunnableJobCollectionScheduleRun"
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]?$
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.
enum:
- list
- preview
- run
x-speakeasy-unknown-values: allow
timeRangeType:
type: string
title: Time range
enum:
- absolute
- relative
description: Time range
x-speakeasy-unknown-values: allow
earliest:
type:
- number
- string
title: Earliest
description: Earliest time to collect data for the selected timezone
latest:
type:
- number
- string
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
timeWarning:
$ref: "#/components/schemas/BrokenEventProcessor"
expression:
type: string
title: Filter
description: A filter for tokens in the provided collect path and/or the events
being collected
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.
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.
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
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
maxEvents:
type: number
title: Capture up to N events
description: Maximum number of events to capture
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
description: Where to capture
x-speakeasy-unknown-values: allow
x-speakeasy-enums:
- BeforePreProcessingPipeline
- BeforeTheRoutes
- BeforePostProcessingPipeline
- BeforeTheDestination
description: Capture Settings
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeRunnableJobCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
executor:
$ref: "#/components/schemas/ExecutorTypeRunnableJobExecutor"
run:
type: object
properties:
rescheduleDroppedTasks:
type: boolean
title: Reschedule tasks
description: Reschedule tasks that failed with non-fatal errors
maxTaskReschedule:
type: number
title: Task reschedule limit
description: Maximum number of times a task can be rescheduled
minimum: 1
logLevel:
$ref: "#/components/schemas/LogLevelOptionsRunnableJobCollectionScheduleRun"
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]?$
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeRunnableJobCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
savedQueryId:
type: string
title: ID of the SavedQuery
description: Identifies which search query to run
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
type: object
RunnableJob:
oneOf:
- $ref: "#/components/schemas/RunnableJobCollection"
- $ref: "#/components/schemas/RunnableJobExecutor"
- $ref: "#/components/schemas/RunnableJobScheduledSearch"
TaskErrorInfo:
type: object
additionalProperties: true
properties:
message:
type: string
description: Human-readable error message.
name:
type: string
description: Error name, if available.
stack:
type: string
description: Truncated stack trace of the error.
required:
- message
description: Serialized error object that describes why a job entered its
current state. Includes message and may
include a nested reason for wrapped errors.
TaskErrorDetail:
type: object
properties:
message:
type: string
description: Human-readable error message.
name:
type: string
description: Error name, if available.
reason:
$ref: "#/components/schemas/TaskErrorInfo"
description: Nested cause of the error, if any.
stack:
type: string
description: Truncated stack trace of the error.
required:
- message
description: Task error details. May include a nested reason for
wrapped errors and additional properties from the original error.
JobStatus:
type: object
properties:
reason:
$ref: "#/components/schemas/TaskErrorDetail"
description: Reason the job entered its current state, typically
populated upon failure. May include a nested reason for
wrapped errors.
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
description: Status of a job, including its current state and failure reason.
JobInfo:
type: object
properties:
args:
$ref: "#/components/schemas/RunnableJob"
description: Configuration and run settings used to launch the job.
id:
type: string
description: Unique identifier for the job.
keep:
type: boolean
description: If true, retain the job and its artifacts instead of
deleting according to the time-to-live or retention policy. The job
persists until it is manually deleted.
stats:
type: object
additionalProperties:
$ref: "#/components/schemas/AdditionalPropertiesTypeJobInfoStats"
description: Counters and metrics collected during job execution.
status:
$ref: "#/components/schemas/JobStatus"
description: Status of the job.
workerOwner:
type: string
description: The GUID of the worker node that owns this artifact, set when the
job ran on a Captain while the leader was offline. When present, the
leader proxies read access to the artifact; mutating actions
(replay, delete, stop) are not supported.
required:
- args
- id
- stats
- status
description: Detailed information about a job, including its configuration,
status, and statistics.
CountedInputResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/InputResponse"
Notification:
type: object
required:
- id
- condition
properties:
id:
type: string
title: ID
pattern: ^[a-zA-Z0-9_-]+$
description: Unique identifier for the Notification.
disabled:
type: boolean
title: Disabled
description: If true, the Notification is disabled and the specified condition
will not trigger it.
condition:
type: string
title: Condition
description: The condition that triggers the Notification.
targets:
type: array
title: Notification targets
description: List of the IDs for the Notification targets to send the
Notification to.
items:
type: string
targetConfigs:
type: array
title: Target configuration
description: Override settings to apply for each referenced Notification target.
items:
type: object
required:
- id
properties:
id:
type: string
title: Notification target ID
description: The id of the Notification target.
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"
description: Email recipient settings for the Notification target.
description: Simple Mail Transfer Protocol (SMTP) configuration for the
Notification target.
conf:
type: object
title: Condition-specific configurations
description: Configuration for the condition that triggers the Notification.
Supported fields vary depending on the condition.
properties: {}
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
group:
type: string
title: Worker Group/Fleet
description: The worker group/fleet this notification belongs to
pack:
type: string
title: Pack
description: The pack this notification belongs to
mode:
type: string
title: Mode
description: "Notification mode: direct or policy-based"
enum:
- direct
- policy
x-speakeasy-unknown-values: allow
templateTargetPairs:
type: array
title: Template & Target Pairs
description: Pairs of templates and targets for notification routing
items:
$ref: "#/components/schemas/TemplateTargetPairConfFunctionConfSchemaNotificatio\
nPolicies"
oneOf:
- properties:
mode:
const: direct
description: Delivery mode for Notifications.
templateTargetPairs:
type: array
minItems: 1
description: Template and target pairs for direct Notification delivery.
required:
- mode
- templateTargetPairs
- properties:
mode:
const: policy
description: Delivery mode for Notifications.
templateTargetPairs:
type: array
maxItems: 0
description: Template and target pairs for direct Notification delivery.
required:
- mode
- properties:
mode: {}
StatusError:
type: object
properties:
details:
type: object
additionalProperties: true
description: Additional error details.
message:
type: string
description: Human-readable message that describes the error.
required:
- message
WorkerPQStatus:
type: object
properties:
error:
$ref: "#/components/schemas/StatusError"
health:
type: number
metrics:
type: object
additionalProperties: true
timestamp:
type: number
required:
- health
- metrics
- timestamp
InputResponse:
allOf:
- $ref: "#/components/schemas/Input"
- type: object
properties:
notifications:
type: array
items:
$ref: "#/components/schemas/Notification"
description: Notifications attached to the Source.
status:
$ref: "#/components/schemas/StatusType"
description: Source configuration with optional Notifications and runtime status.
SourceType:
type: array
items:
type: string
PaginatedInputResponse:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/InputResponse"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
UpdateHecTokenRequest:
type: object
properties:
allowedIndexesAtToken:
type: array
items:
type: string
description: List of index names that the HEC token is allowed to write to.
description:
type: string
description: Brief description for the HEC token.
enabled:
type: boolean
description: If true, the HEC token is enabled. Otherwise,
false.
metadata:
type: array
items:
$ref: "#/components/schemas/MetadataConfAddHecTokenRequest"
description: Array of key-value pairs to associate with the HEC token for
tagging, categorization, or providing additional context. Each item
in the array is an object with a name and a
value.
OutputDefault:
type: object
required:
- type
- defaultId
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- default
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
defaultId:
type:
- string
- "null"
title: Default Output ID
description: ID of the default output. This will be used whenever a
nonexistent/deleted output is referenced.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
OutputWebhook:
type: object
required:
- type
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- webhook
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
method:
$ref: "#/components/schemas/MethodOptions"
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
x-speakeasy-unknown-values: allow
keepAlive:
type: boolean
title: Keep alive
description: Disable to close the connection immediately after sending the
outgoing request
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
x-speakeasy-unknown-values: allow
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPathExtended"
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.
description:
type: string
title: Description
description: Optional description for this configuration.
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."
customDropWhenNull:
type: boolean
title: Drop when null
description: Whether to drop events when the source expression evaluates to null
customEventDelimiter:
type: string
title: Event delimiter
description: Delimiter string to insert between individual events. Defaults to
newline character.
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.
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.'
advancedContentType:
type: string
title: Content type
description: HTTP content-type header value
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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}`."
tokenTimeoutSecs:
type: number
title: Refresh interval (secs.)
description: How often the OAuth token should be refreshed.
minimum: 1
maximum: 300000
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:
$ref: "#/components/schemas/OauthParamConfInputServicenowTable"
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:
$ref: "#/components/schemas/OauthHeaderConfInputServicenowTable"
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, @{product} will use the
refresh token to obtain new access tokens without re-sending
credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: "@{product} will update the stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use."
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
pattern: ^https?://.*
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, @{product} sends only
grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
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
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: Webhook URLs
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
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
dnsResolvePeriodSec:
type: number
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
minimum: 10
title: Load balance stats period (seconds)
description: How far back in time to keep traffic stats for load balancing
purposes
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_secret:
type: string
description: Binds 'secret' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'secret' at runtime.
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
anyOf:
- required:
- url
- required:
- urls
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
keepAlive:
type: boolean
title: Keep alive
description: Disable to close the connection immediately after sending the
outgoing request
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
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)
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
enum:
- oauth
description: Discriminator value.
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
refreshTokenField:
type: string
title: Refresh token field
description: "Field name in the token response that contains a refresh token
(example: 'refresh_token'). When set, @{product} will use the
refresh token to obtain new access tokens without re-sending
credentials."
rotateRefreshToken:
type: boolean
title: Rotate refresh token
description: "@{product} will update the stored value on each successful
refresh. Enable if the server issues a new refresh token on every
use."
refreshUrl:
type: string
title: Refresh URL
description: Override the refresh endpoint URL if it differs from the Login URL.
Defaults to Login URL.
pattern: ^https?://.*
refreshRequestParams:
type: array
title: Refresh grant parameters
description: Parameters to include in the refresh token request body. Most
servers require 'client_id' here. If not set, @{product} sends only
grant_type, refresh_token, and client_secret.
items:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
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
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
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
description: Optional description for this configuration.
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."
customDropWhenNull:
type: boolean
title: Drop when null
description: Whether to drop events when the source expression evaluates to null
customEventDelimiter:
type: string
title: Event delimiter
description: Delimiter string to insert between individual events. Defaults to
newline character.
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.
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.'
advancedContentType:
type: string
title: Content type
description: HTTP content-type header value
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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://-..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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
__template_secret:
type: string
description: Binds 'secret' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'secret' at runtime.
__template_refreshUrl:
type: string
description: Binds 'refreshUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'refreshUrl' at runtime.
__template_client_id:
type: string
description: Binds 'client_id' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'client_id' at runtime.
__template_scope:
type: string
description: Binds 'scope' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'scope' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_dcrID:
type: string
description: Binds 'dcrID' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'dcrID' at runtime.
__template_dceEndpoint:
type: string
description: Binds 'dceEndpoint' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'dceEndpoint' at runtime.
__template_streamName:
type: string
description: Binds 'streamName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamName' at runtime.
OutputDevnull:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- devnull
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
required:
- type
OutputSyslog:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsSyslog"
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
protocol:
type: string
title: Protocol
description: The network protocol to use for sending out syslog messages
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.
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-enum-descriptions:
- kern
- user
- mail
- daemon
- auth
- syslog
- lpr
- news
- uucp
- cron
- authpriv
- ftp
- ntp
- security
- console
- solaris-cron
- local0
- local1
- local2
- local3
- local4
- local5
x-speakeasy-unknown-values: allow
x-speakeasy-enums:
- Kern
- User
- Mail
- Daemon
- Auth
- Syslog
- Lpr
- News
- Uucp
- Cron
- Authpriv
- Ftp
- Ntp
- Security
- Console
- SolarisCron
- Local0
- Local1
- Local2
- Local3
- Local4
- Local5
severity:
type: integer
title: Severity
description: Default value for message severity. Will be overwritten by value of
__severity if set. Defaults to notice.
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
x-speakeasy-enums:
- Emergency
- Alert
- Critical
- Error
- Warning
- Notice
- Info
- Debug
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.
messageFormat:
type: string
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
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])?$
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
description:
type: string
title: Description
description: Optional description for this configuration.
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.
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
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:
$ref: "#/components/schemas/HostConfOutputSyslog"
dnsResolvePeriodSec:
type: number
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
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
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
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
maxRecordSize:
type: number
title: Record size limit
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
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
required:
- type
OutputSplunk:
type: object
required:
- type
- host
- port
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsSplunk"
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.
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: Metadata tags used for categorization and filtering.
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
nestedFields:
$ref: "#/components/schemas/NestedFieldSerializationOptions"
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])?$
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
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.
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.
logFailedRequests:
type: boolean
title: Log failed requests to disk
description: Use to troubleshoot issues with sending data
maxS2Sversion:
$ref: "#/components/schemas/MaxS2SVersionOptions"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
minimum: 0
compress:
$ref: "#/components/schemas/CompressionOptions"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
authToken:
type: string
title: Auth token
description: Shared secret token to use when establishing a connection to a
Splunk indexer.
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
__template_nestedFields:
type: string
description: Binds 'nestedFields' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'nestedFields' at runtime.
__template_maxS2Sversion:
type: string
description: Binds 'maxS2Sversion' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'maxS2Sversion' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
dnsResolvePeriodSec:
type: number
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
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
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:
$ref: "#/components/schemas/NestedFieldSerializationOptions"
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])?$
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
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.
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.
logFailedRequests:
type: boolean
title: Log failed requests to disk
description: Use to troubleshoot issues with sending data
maxS2Sversion:
$ref: "#/components/schemas/MaxS2SVersionOptions"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
indexerDiscovery:
type: boolean
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.
minimum: 0
maximum: 60000
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
minimum: 0
compress:
$ref: "#/components/schemas/CompressionOptions"
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.
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
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
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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.
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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.
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
excludeSelf:
type: boolean
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:
$ref: "#/components/schemas/HostConfOutputSyslog"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
authToken:
type: string
title: Auth token
description: Shared secret token to use when establishing a connection to a
Splunk indexer.
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_nestedFields:
type: string
description: Binds 'nestedFields' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'nestedFields' at runtime.
__template_maxS2Sversion:
type: string
description: Binds 'maxS2Sversion' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'maxS2Sversion' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
OutputSplunkHec:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- splunk_hec
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPathExtended"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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.
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
nextQueue:
type: string
title: Next Processing Queue
description: In the Splunk app, define which Splunk processing queue to send the
events after HEC processing.
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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.
excludeSelf:
type: boolean
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: Splunk HEC Endpoints
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
pattern: ^https?://.*
weight:
type: number
title: Load Weight
description: Assign a weight (>0) to each endpoint to indicate its
traffic-handling capability
minimum: 0
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
dnsResolvePeriodSec:
type: number
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
required:
- type
OutputWizHec:
type: object
required:
- type
- wiz_connector_id
- wiz_environment
- data_center
- wiz_sourcetype
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- wiz_hec
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPathExtended"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
minimum: 1024
maximum: 9000
maxPayloadEvents:
type: number
title: Events-per-request limit
description: Maximum number of events to include in the request body. Default is
0 (unlimited).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
wiz_connector_id:
type: string
title: Wiz connector ID
description: The unique identifier for the specific Cribl connector defined in
your Wiz Settings. This is used to cross-validate the bearer token
and ensure traffic is originating from the authorized integration.
wiz_environment:
type: string
title: Wiz environment
description: Your Wiz deployment environment
data_center:
type: string
title: Wiz data center
description: Your Wiz deployment data center (such as us1, us8, or eu1). From
Tenant Info → Data Center and Regions → Tenant Data Center in your
Wiz console.
wiz_sourcetype:
type: string
title: Wiz Defend Source type
description: Wiz Defend Source type
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
token:
type: string
title: Authentication token
description: Wiz Defend Auth token
textSecret:
type: string
title: 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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_wiz_environment:
type: string
description: Binds 'wiz_environment' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'wiz_environment' at
runtime.
__template_data_center:
type: string
description: Binds 'data_center' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'data_center' at runtime.
__template_wiz_sourcetype:
type: string
description: Binds 'wiz_sourcetype' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'wiz_sourcetype' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputTcpjson:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsTcpjson"
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
loadBalanced:
type: boolean
title: Load balancing
description: Use load-balanced destinations
compression:
$ref: "#/components/schemas/CompressionOptionsGzipNone"
logFailedRequests:
type: boolean
title: Log failed requests to disk
description: Use to troubleshoot issues with sending data
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])?$
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
tokenTTLMinutes:
type: number
title: Auth Token TTL minutes
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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:
$ref: "#/components/schemas/HostConfOutputSyslog"
dnsResolvePeriodSec:
type: number
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
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
authToken:
type: string
title: Auth token
description: Optional authentication token to include as part of the connection
header
textSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
domain:
type: string
title: Domain name
description: WaveFront domain name, e.g. "longboard"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputSignalfx:
type: object
required:
- type
- realm
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- signalfx
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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).
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputFilesystem:
type: object
required:
- type
- destPath
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- filesystem
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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 and stable storage.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
description:
type: string
title: Description
description: Optional description for this configuration.
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputS3:
type: object
required:
- type
- bucket
- stagePath
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsS3"
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
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.
enableAssumeRole:
type: boolean
title: Enable for S3
description: Use Assume Role credentials to access S3
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
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
awsSecretKey:
type: string
title: Secret key
description: "Secret key. This value can be a constant or a JavaScript
expression. Example: `${C.env.SOME_SECRET}`)"
objectACL:
$ref: "#/components/schemas/ObjectAclOptions"
storageClass:
$ref: "#/components/schemas/StorageClassOptions"
serverSideEncryption:
$ref: "#/components/schemas/ServerSideEncryptionForUploadedObjectsOptions"
kmsKeyId:
type: string
title: KMS key ID
description: ID or ARN of the KMS customer-managed key to use for encryption
description:
type: string
title: Description
description: Optional description for this configuration.
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:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_serverSideEncryption:
type: string
description: Binds 'serverSideEncryption' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serverSideEncryption' at runtime.
__template_kmsKeyId:
type: string
description: Binds 'kmsKeyId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'kmsKeyId' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputAzureBlob:
type: object
required:
- type
- containerName
- stagePath
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsAzureblob"
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.
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: Metadata tags used for categorization and filtering.
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
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
maxConcurrentFileParts:
type: number
title: Concurrent file parts limit
description: Maximum number of parts to upload in parallel per file
minimum: 1
maximum: 10
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptions"
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
description: Blob access tier
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
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:
$ref: "#/components/schemas/CertificateTypeAzureBlobAuthTypeClientCert"
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_containerName:
type: string
description: Binds 'containerName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'containerName' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
__template_connectionString:
type: string
description: Binds 'connectionString' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'connectionString' at runtime.
__template_storageAccountName:
type: string
description: Binds 'storageAccountName' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'storageAccountName' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_azureCloud:
type: string
description: Binds 'azureCloud' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'azureCloud' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
clusterUrl:
type: string
title: Cluster base URI
description: The base URI for your cluster. Typically,
`https://..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.
ingestMode:
type: string
title: Ingestion mode
enum:
- batching
- streaming
x-speakeasy-enum-descriptions:
- Batching
- Streaming
description: Ingestion mode
x-speakeasy-unknown-values: allow
oauthEndpoint:
$ref: "#/components/schemas/MicrosoftEntraIdAuthenticationEndpointOptionsSasl"
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
description: The type of OAuth 2.0 client credentials grant flow to use
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
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:
$ref: "#/components/schemas/DataFormatOptions"
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
emptyDirCleanupSec:
type: number
title: Staging cleanup period
description: How frequently, in seconds, to clean up empty directories
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.
deadletterEnabled:
type: boolean
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
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
minimum: 1
isMappingObj:
type: boolean
title: Add mapping object
description: Send a JSON mapping object instead of specifying an existing named
data mapping
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-..kusto.windows.net`.
pattern: ^https://
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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.
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`).
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.
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.
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.
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.
minimum: 10
maximum: 2000
maxConcurrentFileParts:
type: number
title: Concurrent file parts limit
description: Maximum number of parts to upload in parallel per file
minimum: 1
maximum: 10
onDiskFullBackpressure:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
timeoutSec:
type: number
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
retainBlobOnSuccess:
type: boolean
title: Retain blob on success
description: Prevent blob deletion after ingestion is complete
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
description: Prefix (optional)
x-speakeasy-unknown-values: allow
value:
type: string
title: Value
description: 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
description: 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
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
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\-\.]+$
description: Key
value:
type: string
title: Value
description: 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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
flushPeriodSec:
type: number
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
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.
keepAlive:
type: boolean
title: Keep alive
description: Disable to close the connection immediately after sending the
outgoing request
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_clusterUrl:
type: string
description: Binds 'clusterUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clusterUrl' at runtime.
__template_database:
type: string
description: Binds 'database' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'database' at runtime.
__template_table:
type: string
description: Binds 'table' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'table' at runtime.
__template_oauthEndpoint:
type: string
description: Binds 'oauthEndpoint' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'oauthEndpoint' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_scope:
type: string
description: Binds 'scope' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'scope' at runtime.
__template_clientSecret:
type: string
description: Binds 'clientSecret' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientSecret' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
__template_mappingRef:
type: string
description: Binds 'mappingRef' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'mappingRef' at runtime.
__template_ingestUrl:
type: string
description: Binds 'ingestUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'ingestUrl' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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:
/api/logs?api-version=."
pattern: ^\.[^\/]+$
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
title: Authentication method
type: string
enum:
- manual
- secret
description: Enter workspace ID and workspace key directly, or select a stored
secret
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_workspaceId:
type: string
description: Binds 'workspaceId' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'workspaceId' at runtime.
__template_workspaceKey:
type: string
description: Binds 'workspaceKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'workspaceKey' at runtime.
OutputKinesis:
type: object
required:
- type
- streamName
- region
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsKinesis"
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
streamName:
type: string
title: Stream Name
description: Kinesis stream name to send events to.
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for Kinesis stream
description: Use Assume Role credentials to access Kinesis stream
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
concurrency:
type: number
title: Put request concurrency
description: Maximum number of ongoing put requests before blocking.
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
minimum: 1
maximum: 10240
flushPeriodSec:
type: number
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
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.
asNdjson:
type: boolean
title: Send batched
description: Batch events into a single record as NDJSON
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_streamName:
type: string
description: Binds 'streamName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamName' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
OutputHoneycomb:
type: object
required:
- type
- dataset
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- honeycomb
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsApi"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/AcknowledgmentsOptions"
format:
$ref: "#/components/schemas/RecordDataFormatOptions"
maxRecordSizeKB:
type: number
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
minimum: 1
maximum: 10000
title: Events-per-batch limit
description: Maximum number of events in a batch before forcing a flush
flushPeriodSec:
type: number
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
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
sasl:
$ref: "#/components/schemas/AuthenticationTypeUse"
tls:
$ref: "#/components/schemas/TlsSettingsClientSideType"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_brokers:
type: string
description: Binds 'brokers' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'brokers' at runtime.
__template_topic:
type: string
description: Binds 'topic' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topic' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputGoogleBigquery:
type: object
required:
- type
- projectId
- datasetId
- tableId
- googleAuthMethod
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- google_bigquery
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
projectId:
type: string
title: Project ID
description: Google Cloud project ID that contains the BigQuery dataset
datasetId:
type: string
title: Dataset ID
description: BigQuery dataset ID
tableId:
type: string
title: Table ID
description: BigQuery table ID
timestampColumn:
type: string
title: Timestamp column
description: Column name to write event time (`_time`) as a BigQuery TIMESTAMP.
Used for time partitioning
googleAuthMethod:
type: string
title: Google authentication method
description: Choose Auto to use Google Application Default Credentials (ADC), or
Secret to select or create a stored secret that references Google
service account credentials
enum:
- auto
- secret
x-speakeasy-enum-descriptions:
- Auto
- Secret
x-speakeasy-unknown-values: allow
secret:
type: string
title: Service account credentials (text secret)
description: Select or create a stored text secret
flushPeriod:
title: Flush period (sec)
description: Maximum time to wait before sending a batch (when batch size limit
is not reached)
type: number
minimum: 1
maxQueueSize:
type: number
title: Queue size limit
description: Maximum number of queued batches before blocking
minimum: 1
maxRecordSizeKB:
type: number
title: Batch size limit (KB)
description: Maximum size (KB) of a single append request. BigQuery limit is 10 MB
minimum: 1
maximum: 10240
maxInProgress:
type: number
title: Concurrent request limit
description: The maximum number of in-progress API requests before backpressure
is applied
minimum: 1
maximum: 100
maxSendRetries:
type: number
title: Max send retries
description: Maximum retries per batch for retryable failures (transient,
rate-limit, unknown) before dropping. 0 (default) retries
indefinitely.
minimum: 0
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_projectId:
type: string
description: Binds 'projectId' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'projectId' at runtime.
__template_datasetId:
type: string
description: Binds 'datasetId' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'datasetId' at runtime.
__template_tableId:
type: string
description: Binds 'tableId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tableId' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
apiVersion:
type: string
title: API version
enum:
- v1
- v2
x-speakeasy-enum-descriptions:
- V1
- V2
description: API version
x-speakeasy-unknown-values: allow
authenticationMethod:
type: string
title: Authentication method
enum:
- manual
- secret
- serviceAccount
- serviceAccountSecret
x-speakeasy-enum-descriptions:
- API key
- API key secret
- Service account credentials
- Service account credentials secret
description: Authentication method
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
logFormatType:
type: string
title: Send events as
description: Send events as
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
description: Optional description for this configuration.
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: Log Type
description:
type: string
title: Description
description: 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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
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.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_apiVersion:
type: string
description: Binds 'apiVersion' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'apiVersion' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_customerId:
type: string
description: Binds 'customerId' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'customerId' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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
description: Google Cloud Storage service endpoint
awsAuthenticationMethod:
type: string
title: Authentication method
enum:
- auto
- manual
- secret
x-speakeasy-enum-descriptions:
- auto
- manual
- Secret Key pair
description: Authentication method
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.
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}`"
verifyPermissions:
type: boolean
title: Verify if bucket exists
description: Disable if you can access files within the bucket but not the
bucket itself
objectACL:
$ref: "#/components/schemas/ObjectAclOptionsAuthenticatedreadBucketownerfullcon\
trol"
storageClass:
$ref: "#/components/schemas/StorageClassOptionsArchiveColdline"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
description:
type: string
title: Description
description: Optional description for this configuration.
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
logLocationType:
type: string
title: Log location type
x-speakeasy-enum-descriptions:
- Project
- Organization
- Billing Account
- Folder
enum:
- project
- organization
- billingAccount
- folder
description: Log location type
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
description: Validate and correct log name
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
x-speakeasy-unknown-values: allow
logLabels:
type: array
title: Log labels
description: Labels to apply to the log entry
items:
$ref: "#/components/schemas/LogLabelConfOutputGoogleCloudLogging"
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:
$ref: "#/components/schemas/LogLabelConfOutputGoogleCloudLogging"
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:
$ref: "#/components/schemas/GoogleAuthenticationMethodOptions"
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.
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).
minimum: 0
flushPeriodSec:
type: number
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.
minimum: 1
maximum: 32
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
timeoutSec:
type: number
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 .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:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_logLocationType:
type: string
description: Binds 'logLocationType' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logLocationType' at
runtime.
__template_logNameExpression:
type: string
description: Binds 'logNameExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'logNameExpression' at runtime.
__template_payloadFormat:
type: string
description: Binds 'payloadFormat' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'payloadFormat' at runtime.
__template_resourceTypeExpression:
type: string
description: Binds 'resourceTypeExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'resourceTypeExpression' at runtime.
__template_severityExpression:
type: string
description: Binds 'severityExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'severityExpression' at runtime.
__template_insertIdExpression:
type: string
description: Binds 'insertIdExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'insertIdExpression' at runtime.
__template_traceExpression:
type: string
description: Binds 'traceExpression' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'traceExpression' at
runtime.
__template_spanIdExpression:
type: string
description: Binds 'spanIdExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'spanIdExpression' at runtime.
__template_traceSampledExpression:
type: string
description: Binds 'traceSampledExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'traceSampledExpression' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_logLocationExpression:
type: string
description: Binds 'logLocationExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'logLocationExpression' at runtime.
__template_payloadExpression:
type: string
description: Binds 'payloadExpression' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'payloadExpression' at runtime.
OutputGoogleCloudObservability:
type: object
required:
- type
- googleAuthMethod
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- google_cloud_observability
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
protocol:
type: string
enum:
- grpc
description: Discriminator value.
x-speakeasy-unknown-values: allow
otlpVersion:
type: string
enum:
- 1.3.1
description: Discriminator value.
x-speakeasy-unknown-values: allow
endpoint:
type: string
title: Endpoint
description: Fixed Google Cloud Observability gRPC endpoint. All three signals
share this transport; the OTLP service path determines whether the
call lands on traces, metrics, or logs.
enum:
- telemetry.googleapis.com:443
x-speakeasy-unknown-values: allow
googleAuthMethod:
type: string
title: Google authentication method
description: Choose Auto to use Google Application Default Credentials (ADC).
Choose Secret to select or create a stored secret that references
Google service account credentials.
enum:
- auto
- secret
x-speakeasy-enum-descriptions:
- Auto
- Secret
x-speakeasy-unknown-values: allow
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
dynamicHeadersEnabled:
type: boolean
title: Use dynamic metadata
description: Batch event data upon dynamic metadata (whether presented or not)
dynamicHeadersField:
type: string
title: Dynamic metadata field
description: When presented, this field which contains metadata, will be
injected into the Destination metadata and used to batch events.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body sent to Google Cloud
Observability
minimum: 1024
maximum: 10240
timeoutSec:
type: number
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
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:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
keepAliveTime:
type: number
title: Keep alive time (seconds)
description: How often the sender should ping the peer to keep the connection open
minimum: 1
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeExtended"
maxPayloadEvents:
type: number
title: Events-per-request limit
description: Max number of events to include in the request body. Default is 0
(unlimited). Use to keep outgoing data points within GCO request
limits. For metrics, combine with the OTLP Metrics function
batchSize.
minimum: 0
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
secret:
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputGooglePubsub:
type: object
required:
- type
- topicName
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsGooglepubsub"
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.
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: Metadata tags used for categorization and filtering.
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.
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.
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:
$ref: "#/components/schemas/GoogleAuthenticationMethodOptions"
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
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
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.
minimum: 1
maxRecordSizeKB:
type: number
title: Batch size limit (KB)
description: Maximum size (KB) of batches to send.
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
maxInProgress:
type: number
title: Concurrent request limit
description: The maximum number of in-progress API requests before backpressure
is applied.
minimum: 1
maximum: 100
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_topicName:
type: string
description: Binds 'topicName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topicName' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
endpoint:
type: string
title: Endpoint
description: Google Cloud Storage service endpoint
objectACL:
$ref: "#/components/schemas/ObjectAclOptionsAuthenticatedreadBucketownerfullcon\
trol"
storageClass:
$ref: "#/components/schemas/StorageClassOptionsArchiveColdline"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
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.
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.
minimum: 10
maximum: 2000
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
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.
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
description: 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
description: Optional description for this configuration.
emptyDirCleanupSec:
type: number
title: Staging cleanup period
description: How frequently, in seconds, to clean up empty directories
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputKafka:
type: object
required:
- type
- brokers
- topic
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptions"
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/AcknowledgmentsOptionsAllLeader"
format:
$ref: "#/components/schemas/RecordDataFormatOptionsJsonProtobuf"
compression:
$ref: "#/components/schemas/CompressionOptionsGzipLz4"
maxRecordSizeKB:
type: number
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
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
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:
$ref: "#/components/schemas/KafkaSchemaRegistryAuthenticationTypeTemplateschema\
RegistryUrlAuth"
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a connection to complete successfully
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
sasl:
$ref: "#/components/schemas/AuthenticationType"
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_topic:
type: string
description: Binds 'topic' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topic' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_compression:
type: string
description: Binds 'compression' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compression' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputConfluentCloud:
type: object
required:
- type
- brokers
- topic
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsConfluentcloud"
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
topic:
type: string
title: Topic
description: The topic to publish events to. Can be overridden using the
__topicOut field.
ack:
$ref: "#/components/schemas/AcknowledgmentsOptionsAllLeader"
format:
$ref: "#/components/schemas/RecordDataFormatOptionsJsonProtobuf"
compression:
$ref: "#/components/schemas/CompressionOptionsGzipLz4"
maxRecordSizeKB:
type: number
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
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
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:
$ref: "#/components/schemas/KafkaSchemaRegistryAuthenticationTypeTemplateschema\
RegistryUrlAuth"
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a connection to complete successfully
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
sasl:
$ref: "#/components/schemas/AuthenticationType"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_brokers:
type: string
description: Binds 'brokers' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'brokers' at runtime.
__template_topic:
type: string
description: Binds 'topic' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topic' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_compression:
type: string
description: Binds 'compression' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compression' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputMsk:
type: object
required:
- type
- brokers
- topic
- region
- awsAuthenticationMethod
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsMsk"
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/AcknowledgmentsOptionsAllLeader"
format:
$ref: "#/components/schemas/RecordDataFormatOptionsJsonProtobuf"
compression:
$ref: "#/components/schemas/CompressionOptionsGzipLz4"
maxRecordSizeKB:
type: number
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
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
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:
$ref: "#/components/schemas/KafkaSchemaRegistryAuthenticationTypeTemplateschema\
RegistryUrlAuth"
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a connection to complete successfully
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
minimum: 1000
maximum: 1800000
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for MSK
description: Use Assume Role credentials to access MSK
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
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_topic:
type: string
description: Binds 'topic' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topic' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_compression:
type: string
description: Binds 'compression' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compression' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
OutputElastic:
type: object
required:
- type
- index
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- elastic
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
extraParams:
type: array
title: Extra parameters
items:
$ref: "#/components/schemas/SaslExtensionConfInputKafka"
description: Extra parameters
auth:
$ref: "#/components/schemas/AuthTypeTemplatemanualApiKeyAuthType"
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
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)
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
x-speakeasy-unknown-values: allow
retryPartialErrors:
type: boolean
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:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
excludeSelf:
type: boolean
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: Bulk API URLs
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
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
dnsResolvePeriodSec:
type: number
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_index:
type: string
description: Binds 'index' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'index' at runtime.
__template_docType:
type: string
description: Binds 'docType' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'docType' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_elasticPipeline:
type: string
description: Binds 'elasticPipeline' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'elasticPipeline' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
extraParams:
type: array
title: Extra parameters
description: Extra parameters to use in HTTP requests
items:
$ref: "#/components/schemas/SaslExtensionConfInputKafka"
auth:
$ref: "#/components/schemas/AuthTypeTemplatemanualApiKeyAuthType"
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)
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_index:
type: string
description: Binds 'index' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'index' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_elasticPipeline:
type: string
description: Binds 'elasticPipeline' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'elasticPipeline' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputNewrelic:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- newrelic
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
region:
$ref: "#/components/schemas/RegionOptions"
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."
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.
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
description: Name of the metadata field.
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsApi"
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
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_logType:
type: string
description: Binds 'logType' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logType' at runtime.
__template_messageField:
type: string
description: Binds 'messageField' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'messageField' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
required:
- type
OutputNewrelicEvents:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- newrelic_events
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
region:
$ref: "#/components/schemas/RegionOptions"
accountId:
type: string
title: Account ID
description: New Relic account ID
eventType:
type: string
title: Event type
description: Default New Relic eventType to use when event type is not present.
For more information, see the [New Relic eventType
documentation](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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsApi"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_accountId:
type: string
description: Binds 'accountId' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'accountId' at runtime.
__template_eventType:
type: string
description: Binds 'eventType' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'eventType' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_customUrl:
type: string
description: Binds 'customUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'customUrl' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
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
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.
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.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
type: string
title: Authentication type
description: InfluxDB authentication type
enum:
- none
- basic
- credentialsSecret
- token
- textSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Token
- Token (text secret)
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_database:
type: string
description: Binds 'database' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'database' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for CloudWatchLogs
description: Use Assume Role credentials to access CloudWatchLogs
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
maxQueueSize:
type: number
title: Queue size limit
description: Maximum number of queued batches before blocking
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
minimum: 1
maximum: 10240
flushPeriodSec:
type: number
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:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_logGroupName:
type: string
description: Binds 'logGroupName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logGroupName' at runtime.
__template_logStreamName:
type: string
description: Binds 'logStreamName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logStreamName' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: MinIO bucket name
description: "Name of the destination MinIO 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 MinIO bucket is located
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
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: MinIO endpoint
description: MinIO service url (e.g. http://minioHost:9000)
pattern: ^https?://.*
objectACL:
$ref: "#/components/schemas/ObjectAclOptions"
storageClass:
$ref: "#/components/schemas/StorageClassOptionsReducedredundancyStandard"
serverSideEncryption:
$ref: "#/components/schemas/ServerSideEncryptionForUploadedObjectsOptionsAes256"
description:
type: string
title: Description
description: Optional description for this configuration.
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:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_serverSideEncryption:
type: string
description: Binds 'serverSideEncryption' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serverSideEncryption' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
protocol:
$ref: "#/components/schemas/DestinationProtocolOptions"
host:
type: string
title: Host
description: The hostname of the destination.
port:
type: number
title: Port
minimum: 1
maximum: 65535
description: Destination port.
mtu:
type: number
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
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
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
description: Optional description for this configuration.
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])?$
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
protocol:
$ref: "#/components/schemas/DestinationProtocolOptions"
host:
type: string
title: Host
description: The hostname of the destination.
port:
type: number
title: Port
minimum: 1
maximum: 65535
description: Destination port.
mtu:
type: number
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
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
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
description: Optional description for this configuration.
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])?$
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
protocol:
$ref: "#/components/schemas/DestinationProtocolOptions"
host:
type: string
title: Host
description: The hostname of the destination.
port:
type: number
title: Port
minimum: 1
maximum: 65535
description: Destination port.
mtu:
type: number
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
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
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
description: Optional description for this configuration.
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])?$
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputRouter:
type: object
required:
- type
- rules
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- router
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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
description:
type: string
title: Description
description: Optional description for this configuration.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for SNS
description: Use Assume Role credentials to access SNS
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
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_topicArn:
type: string
description: Binds 'topicArn' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topicArn' at runtime.
__template_messageGroupId:
type: string
description: Binds 'messageGroupId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'messageGroupId' at
runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
OutputSqs:
type: object
required:
- type
- queueName
- queueType
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsSqs"
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.
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: Metadata tags used for categorization and filtering.
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.
createQueue:
type: boolean
title: Create Queue
description: Create queue if it does not exist.
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
awsSecretKey:
type: string
title: Secret key
description: 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.
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
enableAssumeRole:
type: boolean
title: Enable for SQS
description: Use Assume Role credentials to access SQS
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
maxQueueSize:
type: number
title: Queue size limit
description: Maximum number of queued batches before blocking.
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.
minimum: 1
maximum: 256
flushPeriodSec:
type: number
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.
minimum: 1
maximum: 100
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
awsApiKey:
type: string
title: Access key
description: Access key
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_queueName:
type: string
description: Binds 'queueName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueName' at runtime.
__template_queueType:
type: string
description: Binds 'queueType' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'queueType' at runtime.
__template_awsAccountId:
type: string
description: Binds 'awsAccountId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsAccountId' at runtime.
__template_messageGroupId:
type: string
description: Binds 'messageGroupId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'messageGroupId' at
runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
OutputSnmp:
type: object
required:
- type
- hosts
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsSnmp"
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.
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: Metadata tags used for categorization and filtering.
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
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
dnsResolvePeriodSec:
type: number
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.
enableIpSpoofing:
title: Enable Source IP spoofing
description: Send SNMP Trap 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
description:
type: string
title: Description
description: Optional description for this configuration.
maxRecordSize:
type: number
title: Maximum transmission unit (MTU)
minimum: 1
description: MTU in bytes. The actual maximum SNMP Trap payload size will be MTU
minus IP and UDP headers (28 bytes for IPv4, 48 bytes for IPv6).
Payloads exceeding this limit will be dropped.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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
x-speakeasy-unknown-values: allow
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputDatadog:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- datadog
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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
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'
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.
allowApiKeyFromEvents:
type: boolean
title: Allow API key from events
description: Allow API key to be set from the event's '__agent_api_key' field
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
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)
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsApi"
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
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_tags:
type: string
description: Binds 'tags' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
required:
- type
OutputGrafanaCloud:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- grafana_cloud
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/MessageFormatOptions"
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:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
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..
prometheusAuth:
$ref: "#/components/schemas/PrometheusAuthType"
lokiAuth:
$ref: "#/components/schemas/PrometheusAuthType"
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."
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."
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."
minimum: 0
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
compress:
type: boolean
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_lokiUrl:
type: string
description: Binds 'lokiUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'lokiUrl' at runtime.
__template_prometheusUrl:
type: string
description: Binds 'prometheusUrl' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'prometheusUrl' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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:
$ref: "#/components/schemas/MessageFormatOptions"
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:
$ref: "#/components/schemas/RefreshRequestParamConfHealthCheckAuthenticationOau\
thSecret"
authType:
$ref: "#/components/schemas/AuthenticationTypeOptionsPrometheusAuthBasicCredent\
ialsSecret"
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."
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."
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."
minimum: 0
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
description: Optional description for this configuration.
compress:
type: boolean
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:
:"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputAmazonManagedPrometheus:
type: object
required:
- type
- url
- region
- awsAuthenticationMethod
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- amazon_managed_prometheus
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
url:
type: string
title: Remote Write URL
description: The Amazon Managed Service for Prometheus remote_write endpoint
pattern: ^https://aps-workspaces(?:-fips)?\.([a-z0-9]+(?:-[a-z0-9]+)*)\.(?:amazonaws\.com|api\.aws)/workspaces/ws-[A-Za-z0-9-]+/api/v1/remote_write$
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsAutoSecret"
awsSecretKey:
type: string
title: Secret key
description: Secret key
region:
type: string
title: Region
description: Region where the AMSP is located
rejectUnauthorized:
type: boolean
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.
enableAssumeRole:
type: boolean
title: Enable for AMSP
description: Use Assume Role credentials to access AMSP
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
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..
sendMetadata:
type: boolean
title: Send metadata
description: Generate and send metadata (`type` and `metricFamilyName`) requests
usePrometheusHistogramBucketSuffix:
type: boolean
title: Use `_bucket` suffix for histogram buckets
description: Serialize histogram bucket series as `_bucket` to match
Prometheus histogram naming convention
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum uncompressed size, in KB, of the request body. The 1 MB cap
is intentional and protects against data that compresses poorly,
since oversized requests fail with a non-retryable 413.
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).
minimum: 0
timeoutSec:
type: number
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
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. SigV4-managed headers and the
Prometheus remote-write protocol version header are generated by
this Destination and cannot be configured here.
items:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
metricsFlushPeriodSec:
type: number
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputPrometheus:
type: object
required:
- type
- url
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsPrometheus"
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.
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: Metadata tags used for categorization and filtering.
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..
sendMetadata:
type: boolean
title: Send metadata
description: Generate and send metadata (`type` and `metricFamilyName`) requests
usePrometheusHistogramBucketSuffix:
type: boolean
title: Use `_bucket` suffix for histogram buckets
description: Serialize histogram bucket series as `_bucket` to match
Prometheus histogram naming convention
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
type: string
title: Authentication type
description: Remote Write authentication type
enum:
- none
- basic
- credentialsSecret
- token
- textSecret
- aws_sigv4
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Token
- Token (text secret)
- AWS Signature v4
x-speakeasy-unknown-values: allow
description:
type: string
title: Description
description: Optional description for this configuration.
metricsFlushPeriodSec:
type: number
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsAutoSecret"
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
region:
type: string
title: Region
description: AWS region used to sign Remote Write requests
awsService:
type: string
title: AWS service ID
description: ID used to sign Remote Write requests (for example, `aps` for
Amazon Managed Service for Prometheus)
pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
enableAssumeRole:
type: boolean
title: Enable for Prometheus
description: Use Assume Role credentials to access Prometheus
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_awsService:
type: string
description: Binds 'awsService' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsService' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
OutputRing:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- ring
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
format:
type: string
title: Data format
description: Format of the output data.
enum:
- json
- raw
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})?$
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]$
compress:
$ref: "#/components/schemas/DataCompressionFormatOptionsPersistence"
destPath:
type: string
title: Path location
description: Path to use to write metrics. Defaults to $CRIBL_HOME/state/
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
description:
type: string
title: Description
description: Optional description for this configuration.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
protocol:
$ref: "#/components/schemas/ProtocolOptions"
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
x-speakeasy-unknown-values: allow
compress:
$ref: "#/components/schemas/CompressionOptionsDeflateGzip"
httpCompress:
$ref: "#/components/schemas/CompressionOptionsMessages"
authType:
type: string
title: Authentication type
enum:
- none
- basic
- credentialsSecret
- token
- textSecret
- oauthSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Token
- Token (text secret)
- OAuth (text secret)
description: Authentication type
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
dynamicHeadersEnabled:
type: boolean
title: Use dynamic metadata
description: Batch event data upon dynamic metadata (whether presented or not)
dynamicHeadersField:
type: string
title: Dynamic metadata field
description: When presented, this field which contains metadata, will be
injected into the Destination metadata and used to batch events.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
minimum: 1024
maximum: 10240
timeoutSec:
type: number
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
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:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
keepAliveTime:
type: number
title: Keep alive time (seconds)
description: How often the sender should ping the peer to keep the connection open
minimum: 1
keepAlive:
type: boolean
title: Keep alive
description: Disable to close the connection immediately after sending the
outgoing request
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: 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
oauthTextSecret:
type: string
title: OAuth secret (text secret)
description: Select or create a stored text secret for the OAuth 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}`."
tokenTimeoutSecs:
type: number
title: Refresh interval (secs.)
description: How often the OAuth token should be refreshed.
minimum: 1
maximum: 300000
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:
$ref: "#/components/schemas/OauthParamConfInputServicenowTable"
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:
$ref: "#/components/schemas/OauthHeaderConfInputServicenowTable"
rejectUnauthorized:
type: boolean
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.
extraHttpHeaders:
type: array
title: Extra HTTP headers
description: Headers to add to all events
items:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeExtended"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_loginUrl:
type: string
description: Binds 'loginUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'loginUrl' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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)
tokenSecret:
type: string
title: Auth token (text secret)
description: Select or create a stored text secret
authTokenName:
type: string
title: Auth token name
description: Auth token name
otlpVersion:
$ref: "#/components/schemas/OtlpVersionOptions131"
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
minimum: 1024
maximum: 10240
protocol:
$ref: "#/components/schemas/ProtocolOptions"
compress:
$ref: "#/components/schemas/CompressionOptionsDeflateGzip"
httpCompress:
$ref: "#/components/schemas/CompressionOptionsMessages"
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
dynamicHeadersEnabled:
type: boolean
title: Use dynamic metadata
description: Batch event data upon dynamic metadata (whether presented or not)
dynamicHeadersField:
type: string
title: Dynamic metadata field
description: When presented, this field which contains metadata, will be
injected into the Destination metadata and used to batch events.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
timeoutSec:
type: number
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
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:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
keepAliveTime:
type: number
title: Keep alive time (seconds)
description: How often the sender should ping the peer to keep the connection open
minimum: 1
keepAlive:
type: boolean
title: Keep alive
description: Disable to close the connection immediately after sending the
outgoing request
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
rejectUnauthorized:
type: boolean
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.
extraHttpHeaders:
type: array
title: Extra HTTP headers
description: Headers to add to all events
items:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeExtended"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputDataset:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- dataset
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
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_`.
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.
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
site:
type: string
title: DataSet site
description: DataSet site to which events should be sent
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsApi"
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
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_customUrl:
type: string
description: Binds 'customUrl' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'customUrl' at runtime.
required:
- type
OutputCriblTcp:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsCribltcp"
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
loadBalanced:
type: boolean
title: Load balancing
description: Use load-balanced destinations
compression:
$ref: "#/components/schemas/CompressionOptionsGzipNone"
logFailedRequests:
type: boolean
title: Log failed requests to disk
description: Use to troubleshoot issues with sending data
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])?$
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
writeTimeout:
type: number
title: Write timeout
description: Amount of time (milliseconds) to wait for a write to complete
before assuming connection is dead
tokenTTLMinutes:
type: number
title: Auth Token TTL minutes
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:
$ref: "#/components/schemas/AuthTokenConfInputCriblTcp"
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."
items:
type: string
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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:
$ref: "#/components/schemas/HostConfOutputSyslog"
dnsResolvePeriodSec:
type: number
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
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
required:
- type
OutputCriblHttp:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- cribl_http
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
tokenTTLMinutes:
type: number
title: Auth Token TTL minutes
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."
items:
type: string
compression:
$ref: "#/components/schemas/CompressionOptionsGzipNone"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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])?$
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
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:
$ref: "#/components/schemas/AuthTokenConfOutputCriblHttp"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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.
excludeSelf:
type: boolean
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: Cribl Worker endpoints
minItems: 1
items:
$ref: "#/components/schemas/UrlConfOutputCriblHttp"
dnsResolvePeriodSec:
type: number
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
required:
- type
OutputCriblSearchEngine:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- cribl_search_engine
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
tokenTTLMinutes:
type: number
title: Auth Token TTL minutes
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."
items:
type: string
compression:
$ref: "#/components/schemas/CompressionOptionsGzipNone"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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])?$
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
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 Search
Source in Cribl.Cloud.
items:
$ref: "#/components/schemas/AuthTokenConfOutputCriblHttp"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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.
description:
type: string
title: Description
description: Optional description for this configuration.
url:
type: string
title: Cribl endpoint
description: URL of a Cribl Worker to send events to, such as
http://localhost:10200
pattern: ^https?://.*
excludeSelf:
type: boolean
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: Cribl Worker endpoints
minItems: 1
items:
$ref: "#/components/schemas/UrlConfOutputCriblHttp"
dnsResolvePeriodSec:
type: number
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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"
pattern: ^https?://.*
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
format:
$ref: "#/components/schemas/RequestFormatOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
url:
type: string
title: Next-Gen SIEM endpoint
description: |-
URL provided from a CrowdStrike data connector.
Example: https://ingest..crowdstrike.com/api/ingest/hec//v1/services/collector
pattern: ^https?://.*
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
format:
$ref: "#/components/schemas/RequestFormatOptions"
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
token:
type: string
title: Next-Gen SIEM authentication token
description: 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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
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.
enableAssumeRole:
type: boolean
title: Enable for S3
description: Use Assume Role credentials to access S3
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
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
awsSecretKey:
type: string
title: Secret key
description: "Secret key. This value can be a constant or a JavaScript
expression. Example: `${C.env.SOME_SECRET}`)"
objectACL:
$ref: "#/components/schemas/ObjectAclOptions"
storageClass:
$ref: "#/components/schemas/StorageClassOptions"
serverSideEncryption:
$ref: "#/components/schemas/ServerSideEncryptionForUploadedObjectsOptions"
kmsKeyId:
type: string
title: KMS key ID
description: ID or ARN of the KMS customer-managed key to use for encryption
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/.
items:
type: string
description:
type: string
title: Description
description: Optional description for this configuration.
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:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_serverSideEncryption:
type: string
description: Binds 'serverSideEncryption' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serverSideEncryption' at runtime.
__template_kmsKeyId:
type: string
description: Binds 'kmsKeyId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'kmsKeyId' at runtime.
__template_partitioningFields:
type: string
description: Binds 'partitioningFields' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'partitioningFields' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
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:
$ref: "#/components/schemas/TypeOptionsSecuritylake"
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
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.
enableAssumeRole:
type: boolean
title: Enable for S3
description: Use Assume Role credentials to access S3
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
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsS3CollectorConf"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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.
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
awsSecretKey:
type: string
title: Secret key
description: Secret key
objectACL:
$ref: "#/components/schemas/ObjectAclOptions"
storageClass:
$ref: "#/components/schemas/StorageClassOptions"
serverSideEncryption:
$ref: "#/components/schemas/ServerSideEncryptionForUploadedObjectsOptions"
kmsKeyId:
type: string
title: KMS key ID
description: ID or ARN of the KMS customer-managed key to use for encryption
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
description: Automatically calculate the schema based on the events of each
Parquet file generated
parquetVersion:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
description: Parquet tools can use the checksum of a Parquet page to verify data
integrity
description:
type: string
title: Description
description: Optional description for this configuration.
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
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.
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
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_serverSideEncryption:
type: string
description: Binds 'serverSideEncryption' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serverSideEncryption' at runtime.
__template_kmsKeyId:
type: string
description: Binds 'kmsKeyId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'kmsKeyId' at runtime.
__template_accountId:
type: string
description: Binds 'accountId' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'accountId' at runtime.
__template_customSource:
type: string
description: Binds 'customSource' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'customSource' at runtime.
__template_awsApiKey:
type: string
description: Binds 'awsApiKey' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsApiKey' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputCriblLake:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- cribl_lake
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
storageLocationId:
type: string
title: Storage location
description: Storage location that contains the target Lake dataset.
destPath:
type: string
title: Lake Dataset
description: Lake dataset to send the data to.
format:
type: string
enum:
- json
- parquet
- raw
x-speakeasy-unknown-values: allow
dynamicDataset:
type: boolean
maxClosingFilesToBackpressure:
type: number
minimum: 10
maximum: 1000
maxConcurrentFileParts:
type: number
minimum: 1
maximum: 10
description:
type: string
title: Description
description: Optional description for this configuration.
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
required:
- type
OutputDiskSpool:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- disk_spool
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
timeWindow:
type: string
title: Bucket time span
description: Time period for grouping spooled events. Default is 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))?$
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]$
compress:
$ref: "#/components/schemas/CompressionOptionsPersistence"
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
description: Optional description for this configuration.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
url:
type: string
title: URL
description: "URL of the ClickHouse instance. Example: http://localhost:8123/"
authType:
$ref: "#/components/schemas/AuthenticationTypeOptions"
database:
type: string
title: ClickHouse database
description: 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:
$ref: "#/components/schemas/FormatOptions"
mappingType:
$ref: "#/components/schemas/MappingTypeOptions"
asyncInserts:
type: boolean
title: Async inserts
description: Collect data into batches for later processing on the ClickHouse
server. Disable to write to a ClickHouse table immediately. Cribl
sends the configured value with every insert
(async_insert=1 or async_insert=0) so
behavior is consistent across ClickHouse versions, including 26.3
LTS and later, where async inserts are enabled by default on the
server.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPathExtended"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
minimum: 1024
maximum: 25600
maxPayloadEvents:
type: number
title: Events-per-request limit
description: Maximum number of events to include in the request body. Default is
0 (unlimited).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
workload:
type: string
title: Workload
description: Optional ClickHouse workload name to append as a SETTINGS clause on
INSERT queries. Used for workload scheduling classification.
dumpFormatErrorsToDisk:
type: boolean
title: Log last schema mismatch
description: Log the most recent event that fails to match the table schema
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: Password
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a secret that references your credentials
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.
excludeMappingFields:
type: array
title: Exclude fields
description: Fields to exclude from sending to ClickHouse
minItems: 0
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: Column Mapping
items:
$ref: "#/components/schemas/ColumnMappingConfOutputClickHouse"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_database:
type: string
description: Binds 'database' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'database' at runtime.
__template_tableName:
type: string
description: Binds 'tableName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tableName' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputCustomerMetricsStorage:
type: object
required:
- type
- database
- tableName
- url
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- customer_metrics_storage
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
url:
type: string
title: URL
description: "URL of the ClickHouse instance. Example: http://localhost:8123/"
authType:
$ref: "#/components/schemas/AuthenticationTypeOptions"
database:
type: string
title: ClickHouse database
description: 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:
$ref: "#/components/schemas/FormatOptions"
mappingType:
$ref: "#/components/schemas/MappingTypeOptions"
asyncInserts:
type: boolean
title: Async inserts
description: Collect data into batches for later processing on the ClickHouse
server. Disable to write to a ClickHouse table immediately. Cribl
sends the configured value with every insert
(async_insert=1 or async_insert=0) so
behavior is consistent across ClickHouse versions, including 26.3
LTS and later, where async inserts are enabled by default on the
server.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPathExtended"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
minimum: 1024
maximum: 25600
maxPayloadEvents:
type: number
title: Events-per-request limit
description: Maximum number of events to include in the request body. Default is
0 (unlimited).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
workload:
type: string
title: Workload
description: Optional ClickHouse workload name to append as a SETTINGS clause on
INSERT queries. Used for workload scheduling classification.
dumpFormatErrorsToDisk:
type: boolean
title: Log last schema mismatch
description: Log the most recent event that fails to match the table schema
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: Password
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a secret that references your credentials
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.
excludeMappingFields:
type: array
title: Exclude fields
description: Fields to exclude from sending to ClickHouse
minItems: 0
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: Column Mapping
items:
$ref: "#/components/schemas/ColumnMappingConfOutputClickHouse"
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_database:
type: string
description: Binds 'database' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'database' at runtime.
__template_tableName:
type: string
description: Binds 'tableName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tableName' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputLocalSearchStorage:
type: object
required:
- type
- database
- tableName
- url
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- local_search_storage
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
url:
type: string
title: URL
description: "URL of the database instance. Example: http://localhost:8123/"
authType:
$ref: "#/components/schemas/AuthenticationTypeOptions"
database:
type: string
title: Database
description: Database
tableName:
type: string
title: Table
description: Name of the 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. Defaults to JSON Compact.
enum:
- json-compact-each-row-with-names
- json-each-row
x-speakeasy-enum-descriptions:
- JSONCompactEachRowWithNames
- JSONEachRow
x-speakeasy-unknown-values: allow
mappingType:
type: string
title: Mapping type
description: How event fields are mapped to columns.
enum:
- automatic
- custom
x-speakeasy-enum-descriptions:
- Automatic
- Custom
x-speakeasy-unknown-values: allow
asyncInserts:
type: boolean
title: Async inserts
description: Collect data into batches for later processing. Disable to write to
a table immediately.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPathExtended"
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
minimum: 1024
maximum: 25600
maxPayloadEvents:
type: number
title: Events-per-request limit
description: Maximum number of events to include in the request body. Default is
0 (unlimited).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
workload:
type: string
title: Workload
description: Optional ClickHouse workload name to append as a SETTINGS clause on
INSERT queries. Used for workload scheduling classification.
dumpFormatErrorsToDisk:
type: boolean
title: Log last schema mismatch
description: Log the most recent event that fails to match the table schema
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
statsDestination:
type: object
properties:
url:
type: string
database:
type: string
tableName:
type: string
authType:
type: string
username:
type: string
sqlUsername:
type: string
password:
type: string
waitForAsyncInserts:
type: boolean
concurrency:
type: number
description:
type: string
title: Description
description: Optional description for this configuration.
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: Password
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a secret that references your credentials
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 database before proceeding. Disabling this option can
increase throughput, but Cribl won't be able to verify data has been
completely inserted.
excludeMappingFields:
type: array
title: Exclude fields
description: Fields to exclude from sending
minItems: 0
items:
type: string
minLength: 0
describeTable:
type: string
title: Retrieve table columns
description: Retrieves the table schema and populates the Column Mapping table
columnMappings:
type: array
title: Column Mapping
description: Column Mapping
items:
type: object
required:
- columnName
- columnValueExpression
properties:
columnName:
type: string
title: Column name
description: Name of the column that will store field value
columnType:
type: string
title: Column type
description: Type of the column in the database
columnValueExpression:
type: string
title: Column value
description: JavaScript expression to compute value to be inserted into the
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_database:
type: string
description: Binds 'database' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'database' at runtime.
__template_tableName:
type: string
description: Binds 'tableName' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tableName' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
OutputXsiam:
type: object
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- xsiam
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
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.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
authType:
title: Authentication method
type: string
enum:
- token
- secret
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
throttleRateReqPerSec:
type: integer
title: Throttle request rate limit
description: Maximum number of requests to limit to per second
maximum: 2000
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
description: Optional description for this configuration.
url:
type: string
title: XSIAM endpoint
description: XSIAM endpoint URL to send events to, such as https://api-{tenant
external URL}/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.
excludeSelf:
type: boolean
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: XSIAM Endpoints
minItems: 1
items:
type: object
properties:
weight:
type: number
title: Load Weight
description: Assign a weight (>0) to each endpoint to indicate its
traffic-handling capability
minimum: 0
dnsResolvePeriodSec:
type: number
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
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
required:
- type
OutputNetflow:
type: object
required:
- type
- hosts
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
$ref: "#/components/schemas/TypeOptionsNetflow"
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.
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: Metadata tags used for categorization and filtering.
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
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
dnsResolvePeriodSec:
type: number
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.
enableIpSpoofing:
title: Enable Source IP spoofing
description: Send NetFlow 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
description:
type: string
title: Description
description: Optional description for this configuration.
maxRecordSize:
type: number
title: Maximum transmission unit (MTU)
minimum: 1
description: MTU in bytes. The actual maximum NetFlow payload size will be MTU
minus IP and UDP headers (28 bytes for IPv4, 48 bytes for IPv6). For
example, with the default MTU of 1500, the max payload is 1472 bytes
for IPv4. Payloads exceeding this limit will be dropped.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
method:
$ref: "#/components/schemas/MethodOptions"
keepAlive:
type: boolean
title: Keep alive
description: Disable to close the connection immediately after sending the
outgoing request
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
maximum: 50000
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
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.
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
authType:
type: string
title: Authentication type
enum:
- token
- textSecret
x-speakeasy-enum-descriptions:
- Auth token
- Token (text secret)
description: Authentication type
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
x-speakeasy-unknown-values: allow
endpoint:
type: string
title: Endpoint
enum:
- cloud
- activeGate
- manual
x-speakeasy-enum-descriptions:
- Cloud
- ActiveGate
- Manual
description: Endpoint
x-speakeasy-unknown-values: allow
telemetryType:
type: string
title: Telemetry type
enum:
- logs
- metrics
x-speakeasy-enum-descriptions:
- Logs
- Metrics
description: Telemetry type
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
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
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?://.*
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
protocol:
type: string
title: Protocol
description: Select a transport option for Dynatrace
enum:
- http
x-speakeasy-enum-descriptions:
- 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)
otlpVersion:
$ref: "#/components/schemas/OtlpVersionOptions131"
compress:
$ref: "#/components/schemas/CompressionOptionsDeflateGzip"
httpCompress:
$ref: "#/components/schemas/CompressionOptionsMessages"
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
dynamicHeadersEnabled:
type: boolean
title: Use dynamic metadata
description: Batch event data upon dynamic metadata (whether presented or not)
dynamicHeadersField:
type: string
title: Dynamic metadata field
description: When presented, this field which contains metadata, will be
injected into the Destination metadata and used to batch events.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
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
minimum: 1024
maximum: 4096
timeoutSec:
type: number
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
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:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
connectionTimeout:
type: number
title: Connection timeout
description: Amount of time (milliseconds) to wait for the connection to
establish before retrying
keepAliveTime:
type: number
title: Keep alive time (seconds)
description: How often the sender should ping the peer to keep the connection open
minimum: 1
keepAlive:
type: boolean
title: Keep alive
description: Disable to close the connection immediately after sending the
outgoing request
endpointType:
type: string
title: Endpoint type
description: Select the type of Dynatrace endpoint configured
enum:
- saas
- ag
x-speakeasy-enum-descriptions:
- SaaS
- ActiveGate
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
description: Api-Token name
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
rejectUnauthorized:
type: boolean
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.
extraHttpHeaders:
type: array
title: Extra HTTP headers
description: Headers to add to all events
items:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItems"
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
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.
enum:
- US
- CA
- EMEA
- AP
- APS
- AU
- Custom
x-speakeasy-unknown-values: allow
endpoint:
title: AI SIEM endpoint path
type: string
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
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
pattern: ^https?://[a-zA-Z0-9.-]+(:[0-9]+)?$
description: "Base URL of the endpoint used to send events to, such as
https://.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').
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').
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.
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'.
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').
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').
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').
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').
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.
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.
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.
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.
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.
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.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
apiVersion:
type: string
title: API version
description: API version
authenticationMethod:
type: string
title: Authentication method
enum:
- serviceAccount
- serviceAccountSecret
description: Authentication method
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
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
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum size, in KB, of the request body
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).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body before sending
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
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
description: Chronicle API ingestion method
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
description: Key
value:
type: string
title: Value
description: Value
rbacEnabled:
type: boolean
title: Enable RBAC
description: Designate this label for role-based access control and filtering
endpoint:
type: string
title: Endpoint
description: "Chronicle API service endpoint. If empty, defaults to the
Region-specific endpoint. Otherwise, it must point to a Chronicle
API-compatible endpoint. (Example:
https://custom-endpoint.googleapis.com)"
pattern: ^https?://.*
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_namespace:
type: string
description: Binds 'namespace' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'namespace' at runtime.
__template_logType:
type: string
description: Binds 'logType' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logType' at runtime.
__template_logTextField:
type: string
description: Binds 'logTextField' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logTextField' at runtime.
__template_gcpProjectId:
type: string
description: Binds 'gcpProjectId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'gcpProjectId' at runtime.
__template_gcpInstance:
type: string
description: Binds 'gcpInstance' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'gcpInstance' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
destPath:
type: string
title: Upload path
description: Optional path to prepend to files before uploading.
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
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
workspaceId:
type: string
title: Workspace ID
description: Unique identifier for the Databricks workspace. Used to construct
the OAuth login URL and API base URL.
workspaceHost:
type: string
title: Workspace host
description: Hostname for the Databricks workspace. Override this to connect to
government or secure cloud environments (e.g. cloud.databricks.us,
cloud.databricks.mil, azuredatabricks.net).
scope:
type: string
title: OAuth scope
description: OAuth scope for Unity Catalog authentication
clientId:
type: string
title: Client ID
description: OAuth client ID for Unity Catalog authentication
catalog:
type: string
title: Catalog
description: Name of the Unity Catalog catalog to use for the Destination.
schema:
type: string
title: Schema
description: Name of the Unity Catalog schema to use for the Destination.
eventsVolumeName:
type: string
title: Events volume name
description: Name of the Unity Catalog volume where event data is written.
clientTextSecret:
type: string
title: Client Secret
description: OAuth client secret for Unity Catalog authentication
timeoutSec:
type: integer
title: Request timeout
description: Amount of time, in seconds, to wait for a request to complete
before canceling it.
minimum: 30
description:
type: string
title: Description
description: Optional description for this configuration.
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputSnowflakeStreaming:
type: object
required:
- type
- accountIdentifier
- user
- pem
- database
- schema
- table
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- snowflake_streaming
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
accountIdentifier:
type: string
title: Account identifier
description: "Snowflake account identifier in org-account format (example:
MYORG-MYACCOUNT)"
user:
type: string
title: User
description: Snowflake user with key-pair authentication configured
pem:
type: object
title: Private key
required:
- keyName
properties:
keyName:
type: string
title: Private key
description: Select the stored secret containing the RSA private key (PEM
format) for Snowflake key-pair authentication
description: Private key
database:
type: string
title: Target database
description: Target database
schema:
type: string
title: Target schema
description: Target schema
table:
type: string
title: Target table
description: Target table
url:
type: string
title: URL
description: Override endpoint URL (for PrivateLink or custom deployments).
Defaults to https://.snowflakecomputing.com:443
role:
type: string
title: Role
description: Snowflake role to assume for this connection
keepAlive:
type: boolean
title: Keep alive
description: Keep connections open between requests. Disable only if
experiencing connection pooling issues.
concurrency:
type: number
title: Request concurrency
description: Maximum number of ongoing requests before blocking
minimum: 1
maximum: 32
maxPayloadSizeKB:
type: number
title: Body size limit (KB)
description: Maximum uncompressed size of each batch. With compression enabled
(default), batches are zstd-compressed before sending. Snowflake has
observed a ~4 MB limit on the compressed wire size.
minimum: 64
maximum: 10240
maxPayloadEvents:
type: number
title: Events-per-request limit
description: Maximum number of events per request. Default is 0 (unlimited,
size-gated only).
minimum: 0
compress:
type: boolean
title: Compress
description: Compress the payload body using zstd compression before sending.
rejectUnauthorized:
type: boolean
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
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
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:
$ref: "#/components/schemas/ExtraHttpHeaderConfInputElastic"
failedRequestLoggingMode:
$ref: "#/components/schemas/FailedRequestLoggingModeOptions"
safeHeaders:
type: array
title: Safe headers
description: List of headers that are safe to log in plain text
items:
type: string
controlRequestTimeoutSec:
type: number
title: Snowflake channel open timeout
description: Timeout in seconds for token exchange, channel open/close, and
hostname discovery. Defaults to 30 seconds.
minimum: 1
maximum: 300
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
items:
$ref: "#/components/schemas/ResponseRetrySettingConfOutputWebhook"
timeoutRetrySettings:
$ref: "#/components/schemas/TimeoutRetrySettingsType"
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.
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_accountIdentifier:
type: string
description: Binds 'accountIdentifier' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'accountIdentifier' at runtime.
__template_user:
type: string
description: Binds 'user' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'user' at runtime.
__template_database:
type: string
description: Binds 'database' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'database' at runtime.
__template_schema:
type: string
description: Binds 'schema' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'schema' at runtime.
__template_table:
type: string
description: Binds 'table' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'table' at runtime.
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
__template_role:
type: string
description: Binds 'role' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'role' at runtime.
__template_failedRequestLoggingMode:
type: string
description: Binds 'failedRequestLoggingMode' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'failedRequestLoggingMode' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
topic:
type: string
title: Topic name
description: Topic name from Fabric Eventstream's endpoint
ack:
$ref: "#/components/schemas/AcknowledgmentsOptions"
format:
$ref: "#/components/schemas/RecordDataFormatOptions"
maxRecordSizeKB:
type: number
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
minimum: 1
maximum: 10000
title: Events-per-batch limit
description: Maximum number of events in a batch before forcing a flush
flushPeriodSec:
type: number
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
minimum: 1000
maximum: 3600000
requestTimeout:
type: number
title: Request timeout (ms)
description: Maximum time to wait for Kafka to respond to a request
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
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).
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).
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.
minimum: 2
maximum: 20
authenticationTimeout:
type: number
title: Authentication timeout (ms)
description: Maximum time to wait for Kafka to respond to an authentication
request
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.
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
description: Disabled
mechanism:
$ref: "#/components/schemas/SaslMechanismOptionsSaslOauthbearerPlain"
username:
type: string
title: SASL JASS username
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:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuth"
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:
$ref: "#/components/schemas/MicrosoftEntraIdAuthenticationEndpointOptionsSasl"
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
__template_mechanism:
type: string
description: Binds 'mechanism' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'mechanism' at runtime.
__template_oauthEndpoint:
type: string
description: Binds 'oauthEndpoint' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'oauthEndpoint' at
runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_scope:
type: string
description: Binds 'scope' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'scope' at runtime.
tls:
$ref: "#/components/schemas/TlsSettingsClientSideType"
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptions"
bootstrap_server:
type: string
title: Bootstrap server
description: Bootstrap server from Fabric Eventstream's endpoint
description:
type: string
title: Description
description: Optional description for this configuration.
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
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
pqMode:
$ref: "#/components/schemas/ModeOptions"
pqMaxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use pqMaxBufferSizeBytes instead.
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
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})?$
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})?$
pqPath:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //."
pqCompress:
$ref: "#/components/schemas/CompressionOptionsPq"
pqOnBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptions"
pqMaxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
pqControls:
type: object
title: ""
description: Persistent queue controls.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_topic:
type: string
description: Binds 'topic' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'topic' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_bootstrap_server:
type: string
description: Binds 'bootstrap_server' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'bootstrap_server' at runtime.
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
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsAutoSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
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}`"
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
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: R2 endpoint
description: "Cloudflare R2 service URL (example:
https://.r2.cloudflarestorage.com)"
pattern: ^https?://.*
storageClass:
$ref: "#/components/schemas/StorageClassOptionsReducedredundancyStandard"
serverSideEncryption:
$ref: "#/components/schemas/ServerSideEncryptionForUploadedObjectsOptionsAes256"
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_awsSecretKey:
type: string
description: Binds 'awsSecretKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'awsSecretKey' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_serverSideEncryption:
type: string
description: Binds 'serverSideEncryption' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serverSideEncryption' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputNutanixObjects:
type: object
required:
- type
- bucket
- stagePath
- endpoint
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- nutanix_objects
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: Nutanix Objects bucket name
description: "Name of the destination Nutanix Objects 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 Nutanix Objects bucket is located
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
endpoint:
type: string
title: Nutanix Objects endpoint
description: "Nutanix Objects S3-compatible endpoint URL (example:
https://objects.nutanix.local)"
pattern: ^https?://.*
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputStorjS3:
type: object
required:
- type
- bucket
- stagePath
- endpoint
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- storj_s3
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: Storj bucket name
description: "Name of the destination Storj 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}`"
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
endpoint:
type: string
title: Storj endpoint
description: "Storj S3-compatible gateway endpoint URL (example:
https://gateway.storjshare.io)"
pattern: ^https?://.*
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputAlphasocS3:
type: object
required:
- type
- bucket
- stagePath
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- alphasoc_s3
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: AlphaSOC bucket name
description: "Name of the destination AlphaSOC 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}`"
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
endpoint:
type: string
title: AlphaSOC endpoint
description: "AlphaSOC S3-compatible endpoint URL (example:
https://s3.alphasoc.net)"
pattern: ^https?://.*
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputDellS3:
type: object
required:
- type
- bucket
- stagePath
- endpoint
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- dell_s3
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: Dell PowerScale OneFS bucket name
description: "Name of the destination Dell PowerScale OneFS 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 Dell PowerScale OneFS bucket is located
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
objectACL:
$ref: "#/components/schemas/ObjectAclOptions"
endpoint:
type: string
title: Dell PowerScale OneFS endpoint
description: "Dell PowerScale OneFS S3-compatible endpoint URL (example:
https://powerscale.example.com:9021)"
pattern: ^https?://.*
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputCloudianS3:
type: object
required:
- type
- bucket
- stagePath
- endpoint
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- cloudian_s3
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
endpoint:
type: string
title: Cloudian HyperStore endpoint
description: "Cloudian HyperStore S3-compatible endpoint URL (example:
https://s3.hyperstore.example.com)"
pattern: ^https?://.*
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: Cloudian bucket name
description: "Name of the destination Cloudian 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 Cloudian bucket is located
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
objectACL:
$ref: "#/components/schemas/ObjectAclOptions"
storageClass:
$ref: "#/components/schemas/StorageClassOptions"
serverSideEncryption:
$ref: "#/components/schemas/ServerSideEncryptionForUploadedObjectsOptions"
kmsKeyId:
type: string
title: KMS key ID
description: ID or ARN of the KMS customer-managed key to use for encryption
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_storageClass:
type: string
description: Binds 'storageClass' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'storageClass' at runtime.
__template_serverSideEncryption:
type: string
description: Binds 'serverSideEncryption' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'serverSideEncryption' at runtime.
__template_kmsKeyId:
type: string
description: Binds 'kmsKeyId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'kmsKeyId' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputScalityS3:
type: object
required:
- type
- bucket
- stagePath
- endpoint
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- scality_s3
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: Scality bucket name
description: "Name of the destination Scality 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 Scality bucket is located
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
endpoint:
type: string
title: Scality endpoint
description: "Scality RING S3-compatible endpoint URL (example:
https://s3.scality.example.com)"
pattern: ^https?://.*
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_region:
type: string
description: Binds 'region' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'region' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputAlibabaCloudS3:
type: object
required:
- type
- bucket
- stagePath
- endpoint
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- alibaba_cloud_s3
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
awsAuthenticationMethod:
type: string
title: Authentication method
description: Authentication method.
enum:
- auto
- secret
x-speakeasy-enum-descriptions:
- Auto
- Secret
x-speakeasy-unknown-values: allow
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: Alibaba OSS bucket name
description: "Name of the destination Alibaba OSS 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}`"
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
objectACL:
$ref: "#/components/schemas/ObjectAclOptions"
endpoint:
type: string
title: OSS endpoint
description: "Alibaba OSS S3-compatible endpoint URL. Examples: public
`https://s3.oss-{region}.aliyuncs.com`, internal
`https://s3.oss-{region}-internal.aliyuncs.com`"
pattern: ^https?://.*
enableAssumeRole:
type: boolean
title: Enable for Alibaba OSS
description: Use Assume Role credentials to access Alibaba OSS
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
assumeRoleArn:
type: string
title: AssumeRole ARN
description: "ARN of the RAM role to assume. Format:
acs:ram:::role/. Example:
acs:ram::123456789:role/OSSAccessRole"
pattern: "^acs:"
minLength: 20
assumeRoleExternalId:
type: string
title: External ID
description: External ID for the assumed role (optional, for security when
configured in the role trust policy)
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_objectACL:
type: string
description: Binds 'objectACL' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'objectACL' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_assumeRoleArn:
type: string
description: Binds 'assumeRoleArn' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'assumeRoleArn' at runtime.
__template_assumeRoleExternalId:
type: string
description: Binds 'assumeRoleExternalId' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'assumeRoleExternalId' at runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
OutputIbmCloudS3:
type: object
required:
- type
- bucket
- stagePath
- endpoint
properties:
id:
type: string
title: Output ID
description: Unique ID for this output
type:
type: string
enum:
- ibm_cloud_s3
description: Connector type identifier.
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.
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: Metadata tags used for categorization and filtering.
items:
type: string
endpoint:
type: string
title: IBM COS endpoint
description: "IBM Cloud Object Storage S3-compatible endpoint URL (example:
https://s3.us-south.cloud-object-storage.appdomain.cloud)"
pattern: ^https?://.*
awsAuthenticationMethod:
$ref: "#/components/schemas/AuthenticationMethodOptionsSecret"
reuseConnections:
type: boolean
title: Reuse connections
description: Reuse connections between requests, which can improve performance
rejectUnauthorized:
type: boolean
title: Reject unauthorized certificates
description: Reject certificates that cannot be verified against a valid CA,
such as self-signed certificates
bucket:
type: string
title: IBM Cloud Object Storage bucket name
description: "Name of the destination IBM Cloud Object Storage 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}`"
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}`"
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.
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
maxClosingFilesToBackpressure:
type: number
title: Staging file limit
description: Maximum number of files that can be waiting for upload before
backpressure is applied
minimum: 10
maximum: 4200
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.
addIdToStagePath:
type: boolean
title: Add output ID
description: Add the Output ID value to staging location
removeEmptyDirs:
type: boolean
title: Remove empty staging directories
description: Remove empty staging directories after moving files
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.
format:
$ref: "#/components/schemas/DataFormatOptions"
baseFileName:
type: string
title: File name prefix expression
description: JavaScript expression to define the output filename prefix (can be
constant)
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`).
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.
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.
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.
minimum: 5
maximum: 86400
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.
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
writeHighWaterMark:
type: number
title: Writing high watermark (KB)
description: Buffer size used to write to a file
maximum: 4096
minimum: 16
onBackpressure:
$ref: "#/components/schemas/BackpressureBehaviorOptionsBlockDrop"
deadletterEnabled:
type: boolean
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:
$ref: "#/components/schemas/DiskSpaceProtectionOptions"
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.
retrySettings:
$ref: "#/components/schemas/RetrySettingsType"
orphans:
$ref: "#/components/schemas/OrphanFileRecoveryType"
description:
type: string
title: Description
description: Optional description for this configuration.
awsSecret:
type: string
title: Secret key pair
description: Select or create a stored secret that references your access key
and secret key
compress:
$ref: "#/components/schemas/CompressionOptionsHttp"
compressionLevel:
$ref: "#/components/schemas/CompressionLevelOptions"
automaticSchema:
type: boolean
title: Automatic schema
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:
$ref: "#/components/schemas/ParquetVersionOptions"
parquetDataPageVersion:
$ref: "#/components/schemas/DataPageVersionOptions"
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.
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])?$
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:
$ref: "#/components/schemas/KeyValueMetadataConfOutputFilesystem"
enableStatistics:
type: boolean
title: Write statistics
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
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
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
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.
deadletterPath:
type: string
title: Dead-letter location
description: Storage location for files that fail to reach their final
destination after maximum retries are exceeded
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
minimum: 1
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
__template_endpoint:
type: string
description: Binds 'endpoint' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'endpoint' at runtime.
__template_bucket:
type: string
description: Binds 'bucket' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'bucket' at runtime.
__template_destPath:
type: string
description: Binds 'destPath' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'destPath' at runtime.
__template_partitionExpr:
type: string
description: Binds 'partitionExpr' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'partitionExpr' at runtime.
__template_format:
type: string
description: Binds 'format' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'format' at runtime.
__template_baseFileName:
type: string
description: Binds 'baseFileName' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'baseFileName' at runtime.
__template_fileNameSuffix:
type: string
description: Binds 'fileNameSuffix' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'fileNameSuffix' at
runtime.
__template_onBackpressure:
type: string
description: Binds 'onBackpressure' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'onBackpressure' at
runtime.
__template_compress:
type: string
description: Binds 'compress' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'compress' at runtime.
__template_parquetSchema:
type: string
description: Binds 'parquetSchema' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'parquetSchema' at runtime.
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/OutputWizHec"
- $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/OutputGoogleBigquery"
- $ref: "#/components/schemas/OutputGoogleChronicle"
- $ref: "#/components/schemas/OutputGoogleCloudStorage"
- $ref: "#/components/schemas/OutputGoogleCloudLogging"
- $ref: "#/components/schemas/OutputGoogleCloudObservability"
- $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/OutputAmazonManagedPrometheus"
- $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/OutputCriblSearchEngine"
- $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/OutputCustomerMetricsStorage"
- $ref: "#/components/schemas/OutputLocalSearchStorage"
- $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/OutputSnowflakeStreaming"
- $ref: "#/components/schemas/OutputMicrosoftFabric"
- $ref: "#/components/schemas/OutputCloudflareR2"
- $ref: "#/components/schemas/OutputNutanixObjects"
- $ref: "#/components/schemas/OutputStorjS3"
- $ref: "#/components/schemas/OutputAlphasocS3"
- $ref: "#/components/schemas/OutputDellS3"
- $ref: "#/components/schemas/OutputCloudianS3"
- $ref: "#/components/schemas/OutputScalityS3"
- $ref: "#/components/schemas/OutputAlibabaCloudS3"
- $ref: "#/components/schemas/OutputIbmCloudS3"
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"
wiz_hec: "#/components/schemas/OutputWizHec"
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_bigquery: "#/components/schemas/OutputGoogleBigquery"
google_chronicle: "#/components/schemas/OutputGoogleChronicle"
google_cloud_storage: "#/components/schemas/OutputGoogleCloudStorage"
google_cloud_logging: "#/components/schemas/OutputGoogleCloudLogging"
google_cloud_observability: "#/components/schemas/OutputGoogleCloudObservability"
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"
amazon_managed_prometheus: "#/components/schemas/OutputAmazonManagedPrometheus"
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"
cribl_search_engine: "#/components/schemas/OutputCriblSearchEngine"
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"
customer_metrics_storage: "#/components/schemas/OutputCustomerMetricsStorage"
local_search_storage: "#/components/schemas/OutputLocalSearchStorage"
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"
snowflake_streaming: "#/components/schemas/OutputSnowflakeStreaming"
microsoft_fabric: "#/components/schemas/OutputMicrosoftFabric"
cloudflare_r2: "#/components/schemas/OutputCloudflareR2"
nutanix_objects: "#/components/schemas/OutputNutanixObjects"
storj_s3: "#/components/schemas/OutputStorjS3"
alphasoc_s3: "#/components/schemas/OutputAlphasocS3"
dell_s3: "#/components/schemas/OutputDellS3"
cloudian_s3: "#/components/schemas/OutputCloudianS3"
scality_s3: "#/components/schemas/OutputScalityS3"
alibaba_cloud_s3: "#/components/schemas/OutputAlibabaCloudS3"
ibm_cloud_s3: "#/components/schemas/OutputIbmCloudS3"
CountedOutputResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/OutputResponse"
OutputResponse:
allOf:
- $ref: "#/components/schemas/Output"
- type: object
properties:
notifications:
type: array
items:
$ref: "#/components/schemas/Notification"
description: Notifications attached to the Destination.
status:
$ref: "#/components/schemas/StatusType"
description: Destination configuration with optional Notifications and runtime status.
DestinationType:
type: string
enum:
- default
- router
- tcpjson
- splunk
- splunk_lb
- splunk_hec
- syslog
- filesystem
- s3
- azure_blob
- azure_data_explorer
- sentinel
- azure_logs
- kafka
- confluent_cloud
- msk
- kinesis
- elastic
- elastic_cloud
- microsoft_fabric
- cloudflare_r2
- honeycomb
- newrelic
- newrelic_events
- snmp
- influxdb
- minio
- devnull
- cloudwatch
- azure_eventhub
- statsd
- statsd_ext
- graphite
- wavefront
- signalfx
- sqs
- google_cloud_storage
- sumo_logic
- datadog
- webhook
- prometheus
- amazon_managed_prometheus
- google_pubsub
- google_chronicle
- chronicle
- google_cloud_observability
- google_bigquery
- grafana_cloud
- loki
- open_telemetry
- service_now
- dynatrace_otlp
- sentinel_one_ai_siem
- dataset
- ring
- humio_hec
- crowdstrike_next_gen_siem
- cribl_http
- cribl_tcp
- cribl_search_engine
- google_cloud_logging
- sns
- dl_s3
- security_lake
- cribl_lake
- exabeam
- disk_spool
- click_house
- customer_metrics_storage
- local_search_storage
- xsiam
- netflow
- dynatrace_http
- databricks
- wiz_hec
- nutanix_objects
- storj_s3
- alphasoc_s3
- dell_s3
- cloudian_s3
- scality_s3
- alibaba_cloud_s3
- snowflake_streaming
- ibm_cloud_s3
x-speakeasy-unknown-values: allow
PaginatedOutputResponse:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/OutputResponse"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CountedOutputSamplesResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/OutputSamplesResponse"
OutputSamplesResponse:
type: object
properties:
events:
type: array
items:
type: object
additionalProperties: true
description: Array of sample events returned from a Destination test.
required:
- events
description: Sample events from a Destination.
CountedOutputTestResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/OutputTestResponse"
OutputTestResponse:
type: object
properties:
details:
type: object
additionalProperties: true
description: Additional details about the Destination test, such as per-event
results and transport-level information.
error:
type: string
description: Error message that describes a failed Destination test.
outputId:
type: string
description: The id of the Destination that was tested.
success:
type: boolean
description: If true, the Destination test succeeded. Otherwise,
false.
successDetail:
type: string
description: Human-readable description for a successful Destination test result.
required:
- outputId
- success
OutputTestRequest:
type: object
properties:
events:
type: array
items:
type: object
additionalProperties: true
description: Array of event objects to send to the Destination for testing.
required:
- events
description: Request body for testing a Destination by sending sample events.
CountedPipeline:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/Pipeline"
Pipeline:
title: Pipeline Settings
type: object
required:
- conf
- id
properties:
id:
title: ID
description: Unique identifier for the Pipeline.
type: string
conf:
type: object
description: Configuration for the Pipeline, including functions and settings.
additionalProperties: false
properties:
asyncFuncTimeout:
type: integer
title: Async function timeout (ms)
description: Timeout (in milliseconds) for asynchronous Pipeline functions.
minimum: 0
maximum: 10000
output:
type: string
title: Output event destination
description: The output destination for events processed by this Pipeline.
description:
title: Description
description: Brief description of the Pipeline.
type: string
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
functions:
title: Functions
description: List of Functions to pass data through the Pipeline.
type: array
items:
$ref: "#/components/schemas/PipelineFunctionConf"
groups:
type: object
description: Named groups of Pipeline functions for organizational display in
the UI.
additionalProperties:
type: object
required:
- name
properties:
name:
type: string
title: Group name
description: Name of the group.
description:
type: string
title: Description
description: Brief description of the group.
disabled:
type: boolean
title: Disabled
description: If true, disable all items in the group. Otherwise,
false.
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at
runtime.
PaginatedPipeline:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/Pipeline"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CountedRoutes:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/Routes"
RouteComment:
type: object
properties:
comment:
type: string
description: Brief description of the Route.
groupId:
type: string
description: Unique identifier for the Route Group that the Route is associated
with.
id:
type: string
description: Unique identifier for the comment.
index:
type: integer
description: Relative position of the comment among all comments for the Route.
required:
- comment
- id
- index
RouteCloneConf:
type: object
additionalProperties:
type: string
description: Key-value pairs to set or overwrite in the cloned event.
TargetContext:
type: string
enum:
- group
- pack
x-speakeasy-unknown-values: allow
RouteConf:
type: object
properties:
clones:
type: array
items:
$ref: "#/components/schemas/RouteCloneConf"
description: Array of clone configurations, each with a key-value pair to set or
overwrite in cloned events. Original events continue to the next
Route.
context:
type: string
description: "Context for the Route: group (Worker Group or Edge
Fleet) or pack."
description:
type: string
description: Brief description of the Route.
disabled:
type: boolean
description: If true, disable the Route. Otherwise,
false.
enableOutputExpression:
type: boolean
description: If true, use the outputExpression for
dynamic Destination selection. Otherwise, false.
filter:
type: string
description: JavaScript expression to select events for routing.
final:
type: boolean
description: If true the Route processes matched events and sends
them to the specified Pipeline. Matched events do not continue to
the next Route, but non-matched events do continue to the next
Route. If false, the Route processes matched events and
sends them to the specified Pipeline, and all events (matched and
non-matched) continue to the next Route. Must be false
to clone events.
groupId:
type: string
description: Unique identifier for the Route Group that the Route is associated
with.
id:
type: string
description: Unique identifier for the Route.
name:
type: string
description: Name of the Route.
output:
type: string
description: Destination that the Route sends matching events to after the
Pipeline processes the events.
outputExpression:
type: string
description: JavaScript expression to evaluate for dynamic Destination
selection. Evaluation occurs when the Route is constructed, not for
each event.
pipeline:
type: string
description: Pipeline that the Route sends matching events to.
targetContext:
$ref: "#/components/schemas/TargetContext"
description: "Target context for subsequent event processing after applying the
Route: group (Worker Group or Edge Fleet) or
pack."
required:
- final
- id
- name
- pipeline
Routes:
type: object
properties:
comments:
type: array
items:
$ref: "#/components/schemas/RouteComment"
description: Array of user-provided comments that describe or annotate Routes.
groups:
type: object
additionalProperties:
$ref: "#/components/schemas/AdditionalPropertiesTypeRoutesGroups"
description: Information about the Route Groups that the Route is associated with.
id:
type: string
description: Unique identifier for the Routing table. The supported value is
default.
routes:
type: array
items:
$ref: "#/components/schemas/RouteConf"
description: Array of Route configurations that define how events are processed
and routed.
required:
- id
- routes
RoutesInput:
type: object
properties:
comments:
type: array
items:
$ref: "#/components/schemas/RouteComment"
description: Array of user-provided comments that describe or annotate Routes.
groups:
type: object
additionalProperties:
$ref: "#/components/schemas/AdditionalPropertiesTypeRoutesGroups"
description: Information about the Route Groups that the Route is associated with.
id:
type: string
description: Unique identifier for the Routing table. The supported value is
default.
routes:
type: array
items:
$ref: "#/components/schemas/RouteConfInput"
description: Array of Route configurations that define how events are processed
and routed.
required:
- id
- routes
RouteDefinitions:
type: array
items:
$ref: "#/components/schemas/RouteConfInput"
CountedInputStatus:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/InputStatus"
HealthCountType:
type: object
properties:
Green:
type: integer
description: Number of Worker Processes reporting a healthy (Green) status.
Red:
type: integer
description: Number of Worker Processes reporting a critical (Red) status.
Unknown:
type: integer
description: Number of Worker Processes reporting an unknown health status.
Yellow:
type: integer
description: Number of Worker Processes reporting a degraded (Yellow) status.
AggregatedPQStatus:
type: object
properties:
error:
$ref: "#/components/schemas/StatusError"
description: Error information for the persistent queue, if applicable.
health:
type: string
enum:
- Green
- Red
- Unknown
- Yellow
description: Health status of the persistent queue.
x-speakeasy-unknown-values: allow
healthCounts:
$ref: "#/components/schemas/HealthCountType"
description: "Counts of persistent queue health statuses for the Source or
Destination across all Worker Processes. Includes only statuses with
non-zero counts.
Green == Healthy: Normal
operation
Yellow == Degraded: Potential
issues
Red == Critical: Problem or error that
affects operation
Unknown == Unknown: Cannot
determine health status."
timestamp:
type: integer
description: Timestamp (in Unix time) when the persistent queue status was last
updated.
required:
- health
- healthCounts
- timestamp
AggregatedInputOutputStatusBody:
type: object
properties:
error:
$ref: "#/components/schemas/StatusError"
description: Error information, if applicable.
health:
$ref: "#/components/schemas/HealthOptionsStatus"
healthCounts:
$ref: "#/components/schemas/HealthCountType"
description: "Counts of health statuses for the Source or Destination across all
Worker Processes. Includes only statuses with non-zero counts.
Green == Healthy: Normal operation
Yellow == Degraded: Potential issues
Red == Critical: Problem or error that affects
operation
Unknown == Unknown: Cannot determine
health status."
metrics:
type: object
additionalProperties: true
description: Metrics data for the Source or Destination, including base metrics,
aggregated across all Worker Processes. For load-balanced
Destinations, includes item-level metrics.
pq:
$ref: "#/components/schemas/AggregatedPQStatus"
description: Persistent queue status information (if persistent queue is enabled).
timestamp:
type: integer
description: Timestamp (in Unix time) when the status was last updated.
required:
- health
- healthCounts
- timestamp
InputStatus:
type: object
properties:
id:
type: string
description: Unique identifier of the Source or Destination.
status:
$ref: "#/components/schemas/AggregatedInputOutputStatusBody"
description: Status information for the Source or Destination, aggregated across
all Worker Processes.
type:
type: string
description: Type of the Source or Destination.
required:
- id
- status
description: Status of the Source, aggregated across all Worker Processes.
PaginatedInputStatus:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/InputStatus"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CountedOutputStatus:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/OutputStatus"
OutputStatus:
type: object
properties:
id:
type: string
description: Unique identifier of the Source or Destination.
status:
$ref: "#/components/schemas/AggregatedInputOutputStatusBody"
description: Status information for the Source or Destination, aggregated across
all Worker Processes.
type:
type: string
description: Type of the Source or Destination.
required:
- id
- status
description: Status of a Destination, aggregated across all Worker Processes.
PaginatedOutputStatus:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/OutputStatus"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CountedSavedJobResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/SavedJobResponse"
SavedJobResponseEnrichedFields:
type: object
properties:
savedState:
type: object
additionalProperties:
$ref: "#/components/schemas/AdditionalPropertiesTypeEnrichedFieldsSavedState"
description: Runtime collection state.
notifications:
type: array
items:
$ref: "#/components/schemas/Notification"
description: Notification targets.
SavedJobResponseCollection:
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeSavedJobResponseCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
workerAffinity:
type: boolean
title: Worker affinity
description: If enabled, tasks are created and run by the same Worker Node
collector:
$ref: "#/components/schemas/Collector"
input:
$ref: "#/components/schemas/InputTypeRunnableJobCollection"
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
type: object
SavedJobResponseExecutor:
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeSavedJobResponseCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
executor:
$ref: "#/components/schemas/ExecutorTypeRunnableJobExecutor"
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
type: object
SavedJobResponseScheduledSearch:
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeSavedJobResponseCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
savedQueryId:
type: string
title: ID of the SavedQuery
description: Identifies which search query to run
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
type: object
SavedJobResponse:
allOf:
- $ref: "#/components/schemas/SavedJobResponseEnrichedFields"
- oneOf:
- $ref: "#/components/schemas/SavedJobResponseCollection"
- $ref: "#/components/schemas/SavedJobResponseExecutor"
- $ref: "#/components/schemas/SavedJobResponseScheduledSearch"
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeSavedJobResponseCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
workerAffinity:
type: boolean
title: Worker affinity
description: If enabled, tasks are created and run by the same Worker Node
collector:
$ref: "#/components/schemas/Collector"
input:
$ref: "#/components/schemas/InputTypeRunnableJobCollection"
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeSavedJobResponseCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
executor:
$ref: "#/components/schemas/ExecutorTypeRunnableJobExecutor"
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
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
description: Description
type:
$ref: "#/components/schemas/JobTypeOptionsRunnableJobCollection"
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]$
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.
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
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
environment:
type: string
title: Environment
description: Optionally, enable this config only on a specified Git branch. If
empty, will be enabled everywhere.
schedule:
$ref: "#/components/schemas/ScheduleTypeSavedJobResponseCollection"
streamtags:
type: array
title: Tags
description: Metadata tags used for categorization and filtering.
items:
type: string
savedQueryId:
type: string
title: ID of the SavedQuery
description: Identifies which search query to run
__template_streamtags:
type: string
description: Binds 'streamtags' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'streamtags' at runtime.
type: object
SavedJob:
oneOf:
- $ref: "#/components/schemas/SavedJobCollection"
- $ref: "#/components/schemas/SavedJobExecutor"
- $ref: "#/components/schemas/SavedJobScheduledSearch"
CollectorType:
type: string
enum:
- azure_blob
- cribl_lake
- database
- filesystem
- google_cloud_storage
- health_check
- rest
- s3
- script
- splunk
x-speakeasy-unknown-values: allow
PaginatedSavedJobResponse:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/SavedJobResponse"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CloudProvider:
type:
- string
- "null"
enum:
- aws
- azure
- null
x-speakeasy-unknown-values: allow
ConfigGroupCloud:
type: object
properties:
provider:
$ref: "#/components/schemas/CloudProvider"
description: Cloud provider for the Worker Group.
region:
type: string
description: Cloud region where the Worker Group is deployed.
required:
- provider
- region
Commit:
type: object
properties:
author_email:
type: string
description: Email address of the commit author.
author_name:
type: string
description: Name of the commit author.
date:
type: string
description: Date and time of the commit.
hash:
type: string
description: Full commit hash.
message:
type: string
description: Commit message.
short:
type: string
description: Abbreviated commit hash.
required:
- date
- hash
- message
- short
ConfigGroupLookups:
type: object
properties:
context:
type: string
description: The Worker or Node context for the lookup deployment.
lookups:
type: array
items:
type: object
properties:
deployedVersion:
type: string
description: Version of the lookup file currently deployed on the Worker or
Node.
file:
type: string
description: File name of the deployed lookup.
version:
type: string
description: Version of the lookup file currently staged for deployment.
required:
- file
description: List of lookup files deployed to this context.
required:
- context
- lookups
ConfigGroup:
type: object
properties:
cloud:
$ref: "#/components/schemas/ConfigGroupCloud"
description: Cloud provider and region details for a Cribl.Cloud Worker Group.
collectorsHaEnabled:
type: boolean
description: Keeps Collector jobs running if the Leader Node fails. Applies only
to Stream Worker Groups. Always true for Cribl.Cloud
groups; defaults to false for on-prem groups. to Stream
Worker Groups. Always true for Cribl.Cloud groups;
defaults to false for on-prem groups.
configVersion:
type: string
description: "Commit hash of the deployed configuration version for the Worker
Group, Outpost Group, or Edge Fleet. Automatically populated and
returned in responses.
**Warning**: Do not change the
value of configVersion in the body of PATCH requests.
The PATCH request body must include the value as it appears in the
GET /products/{product}/groups/{id} response."
deployingWorkerCount:
type: integer
description: "Number of Workers or Nodes that are currently deploying the latest
configuration version.
**Warning**: Do not change the
value of deployingWorkerCount in the body of PATCH
requests. The PATCH request body must include the value as it
appears in the GET /products/{product}/groups/{id}
response."
description:
type: string
description: Brief description of the Worker Group, Outpost Group, or Edge Fleet.
maxLength: 512
estimatedIngestRate:
$ref: "#/components/schemas/EstimatedIngestRateOptionsConfigGroup"
git:
type: object
properties:
commit:
type: string
description: Commit hash of the currently committed configuration version.
localChanges:
type: integer
description: Number of local configuration changes not yet committed.
log:
type: array
items:
$ref: "#/components/schemas/Commit"
description: List of recent configuration commits.
description: Git status of the Worker Group, Outpost Group, or Edge Fleet
configuration. Automatically populated and returned in responses.
id:
type: string
description: Unique identifier.
incompatibleWorkerCount:
type: integer
description: "Number of Workers or Nodes running a Cribl version that is
incompatible with the current upgrade target.
**Warning**:
Do not change the value of incompatibleWorkerCount in
the body of PATCH requests. The PATCH request body must include the
value as it appears in the GET
/products/{product}/groups/{id} response."
inherits:
type: string
description: The id of the parent Edge Fleet. If provided, this
Fleet inherits configuration from the specified parent Fleet.
Applies only to Edge Fleets.
isFleet:
type: boolean
description: Indicates whether this is an Edge Fleet. Deprecated. Use to
identify Edge Fleets.
deprecated: true
isSearch:
type: boolean
description: Indicates whether this is an internal Search Group. Deprecated. Use
to identify Search Groups.
deprecated: true
lookupDeployments:
type: array
items:
$ref: "#/components/schemas/ConfigGroupLookups"
description: "Lookup deployment status per Worker or Node context.
**Warning**: Do not change the value of
lookupDeployments in the body of PATCH requests. The
PATCH request body must include the value as it appears in the
GET /products/{product}/groups/{id} response."
maxWorkerAge:
type: string
description: Maximum duration a Worker or Node can remain disconnected before
the Leader removes it. The value is a numeral with units, such as
8h, 5d, 1w.
name:
type: string
description: Name of the Worker Group, Outpost Group, or Edge Fleet.
onPrem:
type: boolean
description: If true, the Worker Group, Outpost Group, or Edge
Fleet uses customer-hosted (on-prem) workers. If false,
the Worker Group, Outpost Group, or Edge Fleet is managed in
Cribl.Cloud.
provisioned:
type: boolean
description: If true, the Cribl.Cloud Worker Group has active
Workers provisioned. Applies only to Cribl.Cloud Worker Groups.
streamtags:
type: array
items:
type: string
description: Metadata tags attached to the Worker Group, Outpost Group, or Edge
Fleet for categorization, filtering, and tag-based routing and
policy application. Useful for organizing Groups and Fleets and
enabling tag-driven workflows in Cribl.
tags:
type: string
description: Legacy system-level tags associated with the Worker Group, Outpost
Group, or Edge Fleet. Use streamtags instead.
deprecated: true
type:
$ref: "#/components/schemas/TypeOptionsConfigGroup"
upgradeVersion:
type: string
description: Target software upgrade version. Applies only to Outpost Groups and
Edge Fleets.
workerCount:
type: integer
description: "Number of Workers or Nodes currently in the Worker Group, Outpost
Group, or Edge Fleet. The value is automatically populated and
**does not scale Cribl.Cloud Worker Groups**. Use
estimatedIngestRate to scale Cribl.Cloud Worker Groups.
**Warning**: Do not change the value of
workerCount in the body of PATCH requests. The PATCH
request body must include the value as it appears in the GET
/products/{product}/groups/{id} response."
workerRemoteAccess:
type: boolean
description: If true, the Leader allows remote access (teleporting)
into the Workers or Nodes of the Worker Group, Outpost Group, or
Edge Fleet.
required:
- id
description: Configuration settings and dynamic status for a Worker Group,
Outpost Group, or Edge Fleet.
PaginatedConfigGroup:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/ConfigGroup"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CountedConfigGroup:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/ConfigGroup"
GroupCreateRequest:
type: object
properties:
cloud:
$ref: "#/components/schemas/ConfigGroupCloud"
description: Cloud provider and region details for a Cribl.Cloud Worker Group.
collectorsHaEnabled:
type: boolean
description: Keeps Collector jobs running if the Leader Node fails. Applies only
to Stream Worker Groups. Always true for Cribl.Cloud
groups; defaults to false for on-prem groups. to Stream
Worker Groups. Always true for Cribl.Cloud groups;
defaults to false for on-prem groups.
description:
type: string
description: Brief description of the Worker Group, Outpost Group, or Edge Fleet.
maxLength: 512
estimatedIngestRate:
$ref: "#/components/schemas/EstimatedIngestRateOptionsConfigGroup"
id:
type: string
description: Unique identifier.
inherits:
type: string
description: The id of the parent Edge Fleet. If provided, this
Fleet inherits configuration from the specified parent Fleet.
Applies only to Edge Fleets.
isFleet:
type: boolean
description: Indicates whether this is an Edge Fleet. Deprecated. Use to
identify Edge Fleets.
deprecated: true
isSearch:
type: boolean
description: Indicates whether this is an internal Search Group. Deprecated. Use
to identify Search Groups.
deprecated: true
maxWorkerAge:
type: string
description: Maximum duration a Worker or Node can remain disconnected before
the Leader removes it. The value is a numeral with units, such as
8h, 5d, 1w.
name:
type: string
description: Name of the Worker Group, Outpost Group, or Edge Fleet.
onPrem:
type: boolean
description: If true, the Worker Group, Outpost Group, or Edge
Fleet uses customer-hosted (on-prem) workers. If false,
the Worker Group, Outpost Group, or Edge Fleet is managed in
Cribl.Cloud.
provisioned:
type: boolean
description: If true, the Cribl.Cloud Worker Group has active
Workers provisioned. Applies only to Cribl.Cloud Worker Groups.
sourceGroupId:
type: string
description: The id of an existing Worker Group, Outpost Group, or
Edge Fleet to copy configuration from when creating a new Group or
Fleet.
streamtags:
type: array
items:
type: string
description: Metadata tags attached to the Worker Group, Outpost Group, or Edge
Fleet for categorization, filtering, and tag-based routing and
policy application. Useful for organizing Groups and Fleets and
enabling tag-driven workflows in Cribl.
tags:
type: string
description: Legacy system-level tags associated with the Worker Group, Outpost
Group, or Edge Fleet. Use streamtags instead.
deprecated: true
type:
$ref: "#/components/schemas/TypeOptionsConfigGroup"
upgradeVersion:
type: string
description: Target software upgrade version. Applies only to Outpost Groups and
Edge Fleets.
workerRemoteAccess:
type: boolean
description: If true, the Leader allows remote access (teleporting)
into the Workers or Nodes of the Worker Group, Outpost Group, or
Edge Fleet.
required:
- id
description: Request body for creating a new Worker Group, Outpost Group, or
Edge Fleet. Do not include automatically populated fields.
DeployRequestLookups:
type: object
properties:
context:
type: string
description: Lookup context to deploy. Use cribl for the default
context or a Pack id for Pack lookups.
lookups:
type: array
items:
type: object
properties:
file:
type: string
description: Unique identifier (file name) of the lookup to deploy.
version:
type: string
description: Version of the lookup file to deploy.
required:
- file
- version
description: List of lookup files to deploy in this context.
required:
- context
- lookups
DeployRequest:
type: object
properties:
lookups:
type: array
items:
$ref: "#/components/schemas/DeployRequestLookups"
description: Optional list of lookup file deployments to include with the commit
deployment.
version:
type: string
description: Commit hash to deploy to the Worker Group, Outpost Group, or Edge
Fleet.
required:
- version
CountedUserAccessControlList:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/UserAccessControlList"
ProductsCore:
type: string
enum:
- stream
- edge
- outpost
x-speakeasy-unknown-values: allow
CountedTeamAccessControlList:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/TeamAccessControlList"
TeamAccessControlList:
type: object
properties:
perms:
type: array
items:
$ref: "#/components/schemas/ResourcePolicy"
team:
type: string
required:
- perms
- team
ProductsBase:
type: string
enum:
- stream
- edge
x-speakeasy-unknown-values: allow
EmptyObject:
type: object
maxProperties: 0
additionalProperties: false
description: An object that must not contain any properties.
example: {}
title: EmptyObject
CountedCriblLakeDataset:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/CriblLakeDataset"
LakehouseConnectionType:
type: string
enum:
- cache
- zeroPoint
x-speakeasy-unknown-values: allow
CacheConnection:
type: object
properties:
acceleratedFields:
type: array
items:
type: string
description: Accelerated fields (materialized columns) for the cache connection.
cacheRef:
type: string
description: Unique identifier for the Lakehouse cache referenced by the Dataset.
createdAt:
type: number
description: Timestamp (in Unix time) when the continuous data feed to the
Lakehouse cache started, in milliseconds.
lakehouseConnectionType:
$ref: "#/components/schemas/LakehouseConnectionType"
description: If new, the Lakehouse was attached before data existed
in the Dataset. If existing, the Lakehouse was attached
after data existed in the Dataset.
migrationQueryId:
type: string
description: Unique identifier for the active Lakehouse migration query. Omitted
if no migration is in progress.
retentionInDays:
type: number
description: Retention period for the Lakehouse cache connection, in days.
required:
- cacheRef
- createdAt
- retentionInDays
LakeDatasetMetrics:
type: object
properties:
currentSizeBytes:
type: number
description: Total current logical size of the Dataset, in bytes.
metricsDate:
type: string
description: Timestamp (in Unix time) when the metrics snapshot was generated,
as a YYYY-MM-DD calendar date.
required:
- currentSizeBytes
- metricsDate
DatasetMetadataRunInfo:
type: object
properties:
earliestScannedTime:
type: integer
description: Timestamp (in Unix time) for the earliest event that was observed
during the scan (seconds).
finishedAt:
type: integer
description: Timestamp (in Unix time) when the acceleration run finished
(milliseconds).
latestScannedTime:
type: integer
description: Timestamp (in Unix time) for the latest event that was observed
during the scan (seconds).
objectCount:
type: integer
description: Number of objects on the acceleration manifest after the scan
completed.
DatasetMetadata:
type: object
properties:
earliest:
type: string
description: Rolling time window that defines how far back acceleration scans.
example: -30d
enableAcceleration:
type: boolean
description: If true, the system automatically backfills and
refreshes Dataset metadata. Otherwise, false.
fieldList:
type: array
items:
type: string
description: Fields for which acceleration gathers statistics. Required when
scan mode is detailed.
latestRunInfo:
$ref: "#/components/schemas/DatasetMetadataRunInfo"
description: Details from the most recent acceleration scan.
scanMode:
type: string
enum:
- detailed
- quick
description: Acceleration scan mode. quick collects object-level
metadata; detailed also collects field-level
statistics.
x-speakeasy-unknown-values: allow
required:
- earliest
- enableAcceleration
- fieldList
- scanMode
PathFilterDataFormat:
type: string
enum:
- ndjson
- parquet
x-speakeasy-unknown-values: allow
ObjectStorageFilter:
type: object
properties:
dataPathFormat:
$ref: "#/components/schemas/PathFilterDataFormat"
description: Row format for Search v2 Lake path filters.
dataTypeId:
type: string
description: Datatype identifier that maps filtered objects to a data type
definition.
filter:
type: string
description: Glob pattern for selecting files within the storage path.
preprocessOuterJson:
type: boolean
description: When true, instructs the C++ reader to unwrap the outer JSON
envelope before applying the user datatype to the nested _raw field.
Set for Cribl Lake NDJSON filters only.
required:
- dataTypeId
- filter
SearchVersion:
type: string
enum:
- v1
- v2
x-speakeasy-unknown-values: allow
LakeDatasetSearchConfig:
type: object
properties:
datatypes:
type: array
items:
type: string
description: Datatype identifiers assigned to the Dataset for search-time event
classification.
description:
type: string
description: Brief description of the Dataset search configuration.
metadata:
$ref: "#/components/schemas/DatasetMetadata"
description: Key-value metadata for the Dataset search configuration.
pathFilters:
type: array
items:
$ref: "#/components/schemas/ObjectStorageFilter"
description: Glob-to-Datatype mappings for the Lake bucket path. Used only for
search execution v2.
searchVersion:
$ref: "#/components/schemas/SearchVersion"
description: Search execution version for the Cribl Lake Dataset. Search
execution v1 uses Event Breakers and Datatypes, and v2 uses path
filters. If omitted, default is v1.
tags:
type: string
description: Comma-separated tags for the Dataset search configuration.
CriblLakeDataset:
type: object
properties:
acceleratedFields:
type: array
items:
type: string
description: Accelerated fields for the Dataset. Data is partitioned by these
fields in storage to improve query performance.
bucketName:
type: string
description: Name of the legacy Cribl Lake bucket that backs the Dataset.
Mutually exclusive with storageLocationId.
cacheConnection:
$ref: "#/components/schemas/CacheConnection"
description: Lakehouse cache connection settings for the Dataset.
deletionStartedAt:
type: number
description: Timestamp (in Unix time) when Dataset deletion was initiated, in
milliseconds.
description:
type: string
description: Brief description of the Dataset.
format:
$ref: "#/components/schemas/FormatOptionsCriblLakeDataset"
httpDAUsed:
type: boolean
description: If true, the Dataset is used by Direct Access HTTP.
Otherwise, false.
id:
type: string
description: Unique identifier for the Dataset.
metrics:
$ref: "#/components/schemas/LakeDatasetMetrics"
description: Most recent Dataset metrics snapshot.
retentionPeriodInDays:
type: integer
description: Dataset retention period, in days.
searchConfig:
$ref: "#/components/schemas/LakeDatasetSearchConfig"
description: Search configuration for the Dataset.
storageClass:
$ref: "#/components/schemas/StorageClassOptionsCriblLakeDataset"
storageLocationId:
type: string
description: Unique identifier for the Storage Location that backs the Dataset.
Mutually exclusive with bucketName.
viewName:
type: string
description: Name of the ClickHouse view for the Dataset on the Lakehouse.
required:
- id
PaginatedCriblLakeDataset:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/CriblLakeDataset"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CriblLakeDatasetUpdate:
type: object
properties:
acceleratedFields:
type: array
items:
type: string
description: Accelerated fields for the Dataset. Data is partitioned by these
fields in storage to improve query performance.
bucketName:
type: string
description: Name of the legacy Cribl Lake bucket that backs the Dataset.
Mutually exclusive with storageLocationId.
cacheConnection:
$ref: "#/components/schemas/CacheConnection"
description: Lakehouse cache connection settings for the Dataset.
deletionStartedAt:
type: number
description: Timestamp (in Unix time) when Dataset deletion was initiated, in
milliseconds.
description:
type: string
description: Brief description of the Dataset.
format:
$ref: "#/components/schemas/FormatOptionsCriblLakeDataset"
httpDAUsed:
type: boolean
description: If true, the Dataset is used by Direct Access HTTP.
Otherwise, false.
id:
type: string
description: Unique identifier for the Dataset. Optional; the path parameter
id is authoritative.
metrics:
$ref: "#/components/schemas/LakeDatasetMetrics"
description: Most recent Dataset metrics snapshot.
retentionPeriodInDays:
type: integer
description: Dataset retention period, in days.
searchConfig:
$ref: "#/components/schemas/LakeDatasetSearchConfig"
description: Search configuration for the Dataset.
storageClass:
$ref: "#/components/schemas/StorageClassOptionsCriblLakeDataset"
storageLocationId:
type: string
description: Unique identifier for the Storage Location that backs the Dataset.
Mutually exclusive with bucketName.
viewName:
type: string
description: Name of the ClickHouse view for the Dataset on the Lakehouse.
BrokenEventProcessor:
type: object
properties: {}
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
CapturedEvent:
type: object
additionalProperties: true
properties:
_raw:
type: string
description: Raw event data.
_time:
type: number
description: Timestamp of the event.
CaptureLevel:
type: integer
enum:
- 0
- 1
- 2
- 3
description: Stage at which events are captured.
0 == Before
pre-processing Pipeline
1 == Before the Routes
2 == Before post-processing Pipeline
3
== Before the Destination.
x-speakeasy-enum-descriptions:
- 1. Before pre-processing Pipeline
- 2. Before the Routes
- 3. Before post-processing Pipeline
- 4. Before the Destination
x-speakeasy-enums:
- BeforePreProcessingPipeline
- BeforeRoutes
- BeforePostProcessingPipeline
- BeforeDestination
x-speakeasy-unknown-values: allow
CaptureParamsReq:
type: object
properties:
duration:
type: integer
description: Amount of time to keep capture open, in seconds. If not provided,
the default is 5 seconds.
minimum: 1
filter:
type: string
description: JavaScript expression evaluated against each event to determine
whether an event is included in the capture output. Expressions can
reference any event field and use logical operators. If not
provided, all events are captured.
level:
$ref: "#/components/schemas/CaptureLevel"
description: Stage at which events are captured. If not provided, the default is
0.
minimum: 0
maximum: 3
maxEvents:
type: integer
description: Maximum number of events to capture. If not provided, the default
is 100.
minimum: 1
maximum: 10000
stepDuration:
type: integer
description: How long to wait before increasing the capture sample size. Specify
1 second or longer. If not provided, the default is 5
seconds.
workerId:
type: string
description: Unique ID of the Worker.
workerThreshold:
type: integer
description: Maximum number of Workers that can capture initially. A value of
0 means unlimited (all available Workers can capture).
If not provided, the default is 50.
CountedNumber:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
type: number
CountedMasterWorkerEntry:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/MasterWorkerEntry"
ConnectionProtocol:
type: string
enum:
- tcp
- tls
- http2
x-speakeasy-unknown-values: allow
ApiScheme:
type: string
enum:
- http
- https
x-speakeasy-unknown-values: allow
TagsMapHeartbeatMetadata:
type: object
additionalProperties:
type: string
description: String-keyed tag map. Each property name is a tag key and the
corresponding value is the tag's string value.
AwsTypeHeartbeatMetadata:
type: object
properties:
enabled:
type: boolean
description: If true, the AWS metadata collector is enabled on the
node. Otherwise, false.
instanceId:
type: string
description: AWS EC2 instance ID.
region:
type: string
description: AWS region name.
tags:
$ref: "#/components/schemas/TagsMapHeartbeatMetadata"
description: AWS EC2 instance tags, if available.
type:
type: string
description: AWS EC2 instance type.
zone:
type: string
description: AWS availability zone name.
required:
- enabled
- instanceId
- region
- type
- zone
AzureTypeHeartbeatMetadata:
type: object
properties:
enabled:
type: boolean
description: If true, the Azure metadata collector is enabled on
the node. Otherwise, false.
hostname:
type: string
description: Azure VM hostname.
instanceId:
type: string
description: Azure instance ID.
name:
type: string
description: Azure VM name.
region:
type: string
description: Azure location or region.
resourceGroup:
type: string
description: Azure resource group name.
subscriptionId:
type: string
description: Azure subscription ID.
tags:
$ref: "#/components/schemas/TagsMapHeartbeatMetadata"
description: Azure tags, if available.
type:
type: string
description: Azure VM size or instance type.
vmId:
type: string
description: Azure VM ID.
zone:
type: string
description: Azure availability zone.
required:
- enabled
LookupVersions:
type: object
additionalProperties:
type: object
additionalProperties:
type: string
description: Objects that map Lookup files to deployment versions.
HBLeaderInfo:
type: object
properties:
host:
type: string
description: Leader hostname or IP address.
port:
type: integer
description: Leader TCP port.
servername:
type: string
description: TLS server name (SNI) for the Leader connection.
tls:
type: boolean
description: If true, TLS is enabled for the Leader connection.
required:
- host
- port
description: Connection parameters for the Leader Node, as reported in a Worker
heartbeat.
HBCriblInfo:
type: object
properties:
config:
type: object
properties:
apiCredentialsRev:
type: string
description: Current API credentials revision string. Only used in leader <>
leader universal subscription.
featuresRev:
type: string
description: Feature flags or feature revision string for the bundle.
hbPeriodSeconds:
type: integer
description: Worker-to-Leader heartbeat interval, in seconds.
logStreamEnv:
type: string
description: GitOps or LogStream environment label associated with the bundle.
policyRev:
type: string
description: Current policies revision string.
teamsRev:
type: string
description: Current teams revision string. Only used in leader <> leader
universal subscription.
usersRev:
type: string
description: Current users revision string. Only used in leader <> leader
universal subscription.
version:
type: string
description: Configuration bundle version.
description: Configuration bundle and policy revision metadata for the node.
deploymentId:
type: string
description: Unique identifier for the deployment assigned for the node.
disableSNIRouting:
type: boolean
description: If true, SNI-based routing to the Leader is disabled
for the connection.
distMode:
type: string
enum:
- edge
- managed-edge
- master
- outpost
- search-supervisor
- single
- worker
description: Distributed deployment mode for the instance.
examples:
- worker
- managed-edge
- master
x-speakeasy-unknown-values: allow
edgeNodes:
type: integer
description: Count of Edge nodes reported in the Leader heartbeat.
group:
type: string
description: Worker Group or Edge Fleet name.
guid:
type: string
description: Unique instance identifier for the Cribl node.
installType:
type: string
description: Value of the CRIBL_INSTALL_TYPE environment variable,
relayed for upgrade decisions (since 4.5.0).
lookupVersions:
$ref: "#/components/schemas/LookupVersions"
description: Deployed Lookup file names and their deployed versions by context.
master:
$ref: "#/components/schemas/HBLeaderInfo"
description: Leader connection details when the node is a Worker or Edge
reporting upstream.
overlayId:
type: string
description: Currently active overlay identifier on the node. Omitted if no
overlay is active.
pid:
type: integer
description: The process ID.
socksEnabled:
type: boolean
description: If true, SOCKS proxy connectivity is enabled for the
node.
startTime:
type: integer
description: Timestamp (in Unix time) when the Cribl server process started, in
milliseconds.
tags:
type: array
items:
type: string
description: Tags from the node.
version:
type: string
description: Cribl software version string for the node.
required:
- config
- distMode
- group
- guid
- startTime
HostOsTypeHeartbeatMetadata:
type: object
properties:
addresses:
type: array
items:
type: string
description: Network addresses reported by the host operating system.
enabled:
type: boolean
description: If true, the host operating system metadata collector
is enabled on the node. Otherwise, false.
id:
type: string
description: Host operating system distribution name.
version:
type: string
description: Host operating system version.
required:
- addresses
- enabled
- id
- version
OwnerTypeHeartbeatMetadataKube:
type: object
properties:
kind:
type: string
description: Kubernetes owner resource kind.
name:
type: string
description: Kubernetes owner resource name.
required:
- kind
- name
KubeTypeHeartbeatMetadata:
type: object
properties:
enabled:
type: boolean
description: If true, the Kubernetes metadata collector is enabled
on the node. Otherwise, false.
namespace:
type: string
description: Kubernetes Namespace name.
node:
type: string
description: Kubernetes Node name.
owner:
$ref: "#/components/schemas/OwnerTypeHeartbeatMetadataKube"
description: Kubernetes owner resource for the Pod.
pod:
type: string
description: Kubernetes Pod name.
source:
type: string
description: Kubernetes config source.
required:
- enabled
- namespace
- node
- pod
- source
OsTypeHeartbeatMetadata:
type: object
properties:
addresses:
type: array
items:
type: string
description: Network addresses reported by the operating system.
enabled:
type: boolean
description: If true, the operating system metadata collector is
enabled on the node. Otherwise, false.
id:
type: string
description: Operating system distribution name.
version:
type: string
description: Operating system version.
required:
- addresses
- enabled
- id
- version
title: OsTypeHeartbeatMetadata
HeartbeatMetadata:
type: object
properties:
aws:
$ref: "#/components/schemas/AwsTypeHeartbeatMetadata"
description: AWS instance metadata collected from the node.
azure:
$ref: "#/components/schemas/AzureTypeHeartbeatMetadata"
description: Azure instance metadata collected from the node.
hostOs:
$ref: "#/components/schemas/HostOsTypeHeartbeatMetadata"
description: Host operating system metadata collected from the node.
kube:
$ref: "#/components/schemas/KubeTypeHeartbeatMetadata"
description: Kubernetes metadata collected from the node.
os:
$ref: "#/components/schemas/OsTypeHeartbeatMetadata"
description: Operating system metadata collected from the node.
NodeOsInfo:
type: object
properties:
addresses:
type: array
items:
type: string
description: Network addresses reported by the node operating system.
required:
- addresses
title: NodeOsInfo
OutpostNodeInfo:
type: object
properties:
groupname:
type: string
description: Name of the Outpost Group that contains the Outpost Node.
guid:
type: string
description: Unique identifier for the Outpost Node.
host:
type: string
description: Hostname or IP address for the Outpost Node.
required:
- guid
- host
description: Node information for the Outpost through which a Worker connects to
the Leader.
NodeProvidedInfo:
type: object
properties:
apiPort:
type: integer
description: API port exposed by the node.
apiScheme:
$ref: "#/components/schemas/ApiScheme"
description: API scheme derived from the node API TLS configuration.
architecture:
type: string
description: CPU architecture.
examples:
- x64
- arm64
aws:
$ref: "#/components/schemas/AwsTypeHeartbeatMetadata"
description: AWS metadata collected from the node.
azure:
$ref: "#/components/schemas/AzureTypeHeartbeatMetadata"
description: Azure metadata collected from the node.
conn_ip:
type: string
description: Remote ip:port for the worker socket.
cpus:
type: integer
description: Number of CPU cores available on the node.
cribl:
$ref: "#/components/schemas/HBCriblInfo"
description: Cribl software and configuration details reported by the node.
env:
type: object
additionalProperties:
type: string
description: Environment variables reported by the node.
freeDiskSpace:
type: integer
description: Free disk space on the node, in bytes.
hostOs:
$ref: "#/components/schemas/HostOsTypeHeartbeatMetadata"
description: Host operating system metadata collected from the node.
hostname:
type: string
description: Hostname reported by the node.
isCaptain:
type: boolean
description: If true, the node considers itself the elected captain
for its group. Otherwise, false.
isSaasWorker:
type: boolean
description: If true, the node runs in Cribl.Cloud. Otherwise,
false.
kube:
$ref: "#/components/schemas/KubeTypeHeartbeatMetadata"
description: Kubernetes metadata collected from the node.
localTime:
type: integer
description: Local timestamp (in Unix time) on the node, in milliseconds.
metadata:
$ref: "#/components/schemas/HeartbeatMetadata"
description: Cloud, Kubernetes, and operating system metadata collected from the
node.
node:
type: string
description: Node.js runtime version running on the node.
os:
oneOf:
- $ref: "#/components/schemas/NodeOsInfo"
- $ref: "#/components/schemas/OsTypeHeartbeatMetadata"
description: Operating system metadata collected from the node.
outpost:
$ref: "#/components/schemas/OutpostNodeInfo"
description: Outpost Node information when the node is connected to an Outpost.
platform:
type: string
description: Operating system platform.
examples:
- linux
- win32
release:
type: string
description: Operating system kernel release.
totalDiskSpace:
type: integer
description: Total disk space on the node, in bytes.
totalmem:
type: integer
description: Total memory on the node, in bytes.
required:
- architecture
- cpus
- cribl
- env
- hostname
- node
- platform
- release
- totalmem
NodeActiveUpgradeStatus:
type: integer
enum:
- 0
- 1
- 2
x-speakeasy-unknown-values: allow
x-speakeasy-enums:
- Pending
- Queued
- Upgrading
NodeFailedUpgradeStatus:
type: integer
enum:
- 0
- 1
x-speakeasy-unknown-values: allow
x-speakeasy-enums:
- UpgradeErrorOnNode
- UpgradeInstallationRollback
NodeSkippedUpgradeStatus:
type: integer
enum:
- 0
- 1
- 2
- 3
x-speakeasy-unknown-values: allow
x-speakeasy-enums:
- DownloadError
- InstallType
- MissingPackage
- TooOld
NodeUpgradeState:
type: integer
enum:
- 0
- 1
- 2
- 3
x-speakeasy-unknown-values: allow
x-speakeasy-enums:
- Active
- Current
- Failed
- Skipped
NodeUpgradeStatus:
type: object
properties:
active:
$ref: "#/components/schemas/NodeActiveUpgradeStatus"
description: Secondary upgrade state when state is
ACTIVE.
failed:
$ref: "#/components/schemas/NodeFailedUpgradeStatus"
description: Secondary upgrade state when state is
FAILED.
skipped:
$ref: "#/components/schemas/NodeSkippedUpgradeStatus"
description: Secondary upgrade state when state is
SKIPPED.
state:
$ref: "#/components/schemas/NodeUpgradeState"
description: Current upgrade state for the Edge Node.
timestamp:
type: integer
description: Timestamp (in Unix time) when the node entered the upgrade state,
in milliseconds.
required:
- state
- timestamp
MasterWorkerProcesses:
type: object
properties:
count:
type: integer
description: Number of Worker Processes represented by the node entry.
required:
- count
MasterWorkerEntry:
type: object
properties:
connectionProtocol:
$ref: "#/components/schemas/ConnectionProtocol"
description: Connection protocol used for node-to-Leader communication.
deployable:
type: boolean
description: If true, the node can receive configuration
deployments. Otherwise, false.
disconnected:
type: boolean
description: If true, the node is disconnected from the Leader.
Otherwise, false.
firstMsgTime:
type: integer
description: Timestamp (in Unix time) when the Leader first received a message
from the node.
group:
type: string
description: The id of the Worker Group, Edge Fleet, or Outpost
Group that contains the node.
id:
type: string
description: Unique identifier for the node.
info:
$ref: "#/components/schemas/NodeProvidedInfo"
description: Metadata reported by the node itself.
lastMetrics:
type: object
additionalProperties: true
description: Latest total, input, and destination metrics cached for UI display.
lastMsgTime:
type: integer
description: Timestamp (in Unix time) when the Leader last received a message
from the node.
metadata:
$ref: "#/components/schemas/HeartbeatMetadata"
description: Cloud, Kubernetes, and operating system metadata collected from the
node.
nodeUpgradeStatus:
$ref: "#/components/schemas/NodeUpgradeStatus"
description: Upgrade status reported by an Edge Node.
offlineDurationMs:
type: integer
description: Maximum configured ephemeral offline duration, in milliseconds
(base + jitter cap).
provisioningTokenId:
type: string
description: The id of the provisioning token used to authenticate
the node, if used.
status:
type: string
description: Health status reported for the node.
type:
type: string
enum:
- info
- req
- resp
description: RPC message type reported by the node.
x-speakeasy-unknown-values: allow
workerProcesses:
type: integer
description: Number of Worker Processes running on the node.
workers:
$ref: "#/components/schemas/MasterWorkerProcesses"
description: Worker Process counts associated with the node entry.
required:
- firstMsgTime
- group
- id
- info
- lastMsgTime
- workerProcesses
description: Worker or Edge Node entry returned by Distributed Management worker
and outpost endpoints.
WorkerFilterExpression:
type: string
description: Filter expression to evaluate against Nodes for inclusion in the
response.
example: group=="default"
WorkerFilterJson:
type: string
description: JSON-stringified filter object to evaluate against Nodes for
inclusion in the response.
example: "%7B%22field%22%3A%22group%22%2C%22op%22%3A%22is%22%2C%22value%22%3A%2\
2default%22%7D"
PaginatedMasterWorkerEntry:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/MasterWorkerEntry"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
CountedRestartResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/RestartResponse"
RestartResponse:
type: object
properties:
id:
type: string
description: Unique identifier for the Worker or Edge Node (GUID).
message:
type: string
description: Error message if the restart request failed for this Node.
status:
type: string
enum:
- Error
- Restarting
description: Result of the restart request for this Node
(Restarting or Error).
x-speakeasy-unknown-values: allow
required:
- id
- status
description: Result of a restart request for a Worker or Edge Node.
RestartRequest:
type: object
properties:
guids:
type: array
items:
type: string
description: GUIDs of the Worker or Edge Nodes to restart.
required:
- guids
PaginatedDistributedSummary:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/DistributedSummary"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
DistributedSummary:
type: object
properties:
groups:
type: object
properties:
count:
type: integer
description: Total number of Worker Groups or Edge Fleets.
destinations:
type: integer
description: Total number of Destinations.
packs:
type: integer
description: Total number of Packs.
pipelines:
type: integer
description: Total number of Pipelines.
quickConnects:
type: integer
description: Total number of QuickConnect configurations.
routes:
type: integer
description: Total number of Routes.
sources:
type: integer
description: Total number of Sources.
required:
- count
- destinations
- packs
- pipelines
- quickConnects
- routes
- sources
description: Resource counts for Worker Groups or Edge Fleets in the deployment
summary.
workers:
type: object
properties:
alive:
type: integer
description: Total number of Worker or Edge Nodes that are connected with
healthy status.
confVersions:
type: integer
description: Total number of unique configuration versions across all Worker or
Edge Nodes.
count:
type: integer
description: Total number of Worker or Edge Nodes.
disconnectedCount:
type: integer
description: Total number of Worker or Edge Nodes in a disconnected state.
groups:
type: integer
description: Total number of distinct Worker Groups or Edge Fleets that the
Workers or Edge Nodes belong to.
softwareVersions:
type: integer
description: Total number of unique Cribl software versions across all Worker or
Edge Nodes.
unhealthy:
type: integer
description: Total number of Worker or Edge Nodes that are connected with a
status other than healthy.
required:
- alive
- confVersions
- count
- disconnectedCount
- groups
- softwareVersions
- unhealthy
description: Worker or Edge Node counts and health statistics in the deployment
summary.
required:
- groups
description: Summary of the deployment for the specified Cribl product (Stream
or Edge).
ActiveHealthOverlayStatus:
type: object
properties:
state:
type: string
const: active
description: Current overlay state.
example: active
required:
- state
title: ActiveHealthOverlayStatus
NoActiveHealthOverlayStatus:
type: object
properties:
state:
type: string
const: inactive
description: Current overlay state.
example: inactive
required:
- state
title: NoActiveHealthOverlayStatus
HealthOverlayStatus:
oneOf:
- $ref: "#/components/schemas/ActiveHealthOverlayStatus"
- $ref: "#/components/schemas/NoActiveHealthOverlayStatus"
HealthServerStatus:
type: object
properties:
isCaptain:
type: boolean
description: Whether this node is currently the captain (job scheduling
coordinator) in a Collectors HA deployment.
overlay:
$ref: "#/components/schemas/HealthOverlayStatus"
description: Overlay state for this process.
role:
type: string
enum:
- primary
- standby
description: "Leader Node role: primary or standby."
x-speakeasy-unknown-values: allow
startTime:
type: integer
description: Timestamp (in Unix time) when the Cribl process started.
status:
type: string
enum:
- healthy
- shutting down
- standby
description: "Health state: healthy, standby, or
shutting down."
x-speakeasy-unknown-values: allow
required:
- overlay
- startTime
- status
description: Health status of the Leader or Worker Node.
CountedPackInstallInfo:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/PackInstallInfo"
TagsTypePackInstallInfo:
type: object
properties:
dataType:
type: array
items:
type: string
description: List of data type tags for the Pack.
domain:
type: array
items:
type: string
description: List of domain tags for the Pack.
example:
- security
- observability
streamtags:
type: array
items:
type: string
description: List of stream tags for routing and filtering.
technology:
type: array
items:
type: string
description: List of technology tags for the Pack.
example:
- aws
- splunk
description: Categorization tags for the Pack.
InstallWarnings:
type: array
items:
type: string
PackInstallInfo:
type: object
properties:
author:
type: string
description: Name or identifier of the Pack author.
collectors:
type: number
description: Number of Collectors (saved jobs) configured within the Pack.
dependencies:
type: object
additionalProperties:
type: string
description: Map of Pack dependency identifiers to their version constraints.
description:
type: string
description: Brief description of the Pack and its purpose.
displayName:
type: string
description: Human-readable display name for the Pack.
exports:
type: array
items:
type: string
description: List of entity IDs exported by this Pack and available for use
outside the Pack context.
id:
type: string
description: Unique identifier.
inputs:
type: number
description: Number of Sources configured within the Pack.
isDisabled:
type: boolean
description: If true, the Pack is disabled. Otherwise,
false.
minLogStreamVersion:
type: string
description: Minimum version of Cribl Stream required to run this Pack.
outputs:
type: number
description: Number of Destinations configured within the Pack.
settings:
type: object
additionalProperties: true
description: Pack-specific settings object. Contents vary by Pack.
source:
type: string
description: Source of the Pack — a file path, URL, or Git URL from which the
Pack was installed.
spec:
type: string
description: Semver range constraint that was applied when the Pack was installed.
tags:
$ref: "#/components/schemas/TagsTypePackInstallInfo"
description: Categorization tags for the Pack.
version:
type: string
description: Version of the Pack, following semantic versioning.
example: 1.0.0
warnings:
$ref: "#/components/schemas/InstallWarnings"
description: List of warning messages generated during Pack installation, if any.
required:
- id
- source
PackRequestBody:
type: object
properties:
id:
type: string
description: Unique identifier for the Pack.
spec:
type: string
description: Semver range constraint to apply when resolving the Pack version to
install.
version:
type: string
description: Version of the Pack, following semantic versioning.
example: 1.0.0
minLogStreamVersion:
type: string
description: Minimum version of Cribl Stream required to run this Pack.
displayName:
type: string
description: Human-readable display name for the Pack.
author:
type: string
description: Name or identifier of the Pack author.
description:
type: string
description: Brief description of the Pack and its purpose.
source:
type: string
description: Source of the Pack. Provide a staging source ID from PUT
/packs, a direct URL to a .crbl file, or a
git+<repo-url> Git repository URL. If omitted, an
empty Pack is created.
tags:
type: object
description: Categorization tags for the Pack.
properties:
dataType:
type: array
items:
type: string
description: List of data type tags for the Pack.
domain:
type: array
items:
type: string
description: List of domain tags for the Pack.
example:
- security
- observability
technology:
type: array
items:
type: string
description: List of technology tags for the Pack.
example:
- aws
- splunk
streamtags:
type: array
items:
type: string
description: List of stream tags for routing and filtering.
allowCustomFunctions:
type: boolean
description: If true or omitted, allow the Pack to use custom
JavaScript functions. If false, reject Packs that use
custom JavaScript functions.
force:
type: boolean
description: If true, overwrite an existing Pack with the same ID.
Otherwise, false.
anyOf:
- required:
- id
- required:
- source
CountedPackUninstallInfo:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/PackUninstallInfo"
PackUninstallInfo:
type: object
properties:
id:
type: string
description: Unique identifier for the Pack.
source:
type: string
description: Source from which the Pack was originally installed.
required:
- id
- source
CountedPackInfo:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/PackInfo"
PackInfo:
type: object
properties:
author:
type: string
description: Name or identifier of the Pack author.
collectors:
type: number
description: Number of Collectors (saved jobs) configured within the Pack.
dependencies:
type: object
additionalProperties:
type: string
description: Map of Pack dependency identifiers to their version constraints.
description:
type: string
description: Brief description of the Pack and its purpose.
displayName:
type: string
description: Human-readable display name for the Pack.
exports:
type: array
items:
type: string
description: List of entity IDs exported by this Pack and available for use
outside the Pack context.
id:
type: string
description: Unique identifier.
inputs:
type: number
description: Number of Sources configured within the Pack.
isDisabled:
type: boolean
description: If true, the Pack is disabled. Otherwise,
false.
minLogStreamVersion:
type: string
description: Minimum version of Cribl Stream required to run this Pack.
outputs:
type: number
description: Number of Destinations configured within the Pack.
settings:
type: object
additionalProperties: true
description: Pack-specific settings object. Contents vary by Pack.
source:
type: string
description: Source of the Pack — a file path, URL, or Git URL from which the
Pack was installed.
spec:
type: string
description: Semver range constraint that was applied when the Pack was installed.
tags:
$ref: "#/components/schemas/TagsTypePackInstallInfo"
description: Categorization tags for the Pack.
version:
type: string
description: Version of the Pack, following semantic versioning.
example: 1.0.0
required:
- id
- source
PaginatedPackInfo:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/PackInfo"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
PackUpgradeRequest:
type: object
properties:
allowCustomFunctions:
type: boolean
description: If true or omitted, allow the Pack to use custom
JavaScript functions. If false, reject Packs that use
custom JavaScript functions.
minor:
type: boolean
description: If true, allow the upgrade to install a minor
(non-breaking) version. Otherwise, false.
source:
type: string
description: Source of the upgraded Pack. Use the source value
returned by PUT /packs for an uploaded file, or provide
a direct URL to a .crbl file or a
git+<repo-url> Git repository URL.
spec:
type: string
description: Semver range constraint to apply when resolving the Pack version to
install.
required:
- source
UploadPackResponse:
type: object
properties:
source:
type: string
description: Unique staging source identifier for the uploaded Pack file. Pass
this value as the source parameter in a subsequent
POST /packs request to install the Pack.
required:
- source
CountedGitCommitSummary:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitCommitSummary"
GitFileRename:
type: object
properties:
from:
type: string
description: Original file path before the rename.
to:
type: string
description: New file path after the rename.
required:
- from
- to
GitCommitSummary:
type: object
properties:
author:
type: object
properties:
email:
type: string
description: Email address of the commit author.
name:
type: string
description: Display name of the commit author.
required:
- email
- name
description: Author of the Git commit, including email and display name.
branch:
type: string
description: Name of the Git branch the commit was made on.
commit:
type: string
description: Full SHA-1 hash of the new commit.
files:
type: object
properties:
created:
type: array
items:
type: string
description: Array of file paths that were created in the commit.
deleted:
type: array
items:
type: string
description: Array of file paths that were deleted in the commit.
modified:
type: array
items:
type: string
description: Array of file paths that were modified in the commit.
renamed:
type: array
items:
$ref: "#/components/schemas/GitFileRename"
description: Array of file rename operations, each containing the original path
and the new path.
description: Files affected by the commit, grouped by change type.
summary:
type: object
properties:
changes:
type: integer
description: Total number of lines changed (insertions plus deletions).
deletions:
type: integer
description: Number of lines deleted.
insertions:
type: integer
description: Number of lines inserted.
required:
- changes
- deletions
- insertions
description: Summary of line changes in the commit.
required:
- branch
- commit
- summary
CountedGitCountResult:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitCountResult"
GitCountResult:
type: object
properties:
count:
type: integer
description: Number of files that changed since the specified commit.
required:
- count
CountedGitDiffResult:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitDiffResult"
GitDiffLines:
$ref: "#/components/schemas/DiffLine"
DiffFiles:
type: array
items:
type: object
properties:
addedLines:
type: integer
description: Number of lines added in this file.
blocks:
type: array
items:
type: object
properties:
header:
type: string
description: Unified diff hunk header.
example: "@@ -1,5 +1,8 @@"
lines:
$ref: "#/components/schemas/GitDiffLines"
description: Array of lines in this diff hunk.
newStartLine:
type: integer
description: Starting line number in the new file for this hunk.
oldStartLine:
type: integer
description: Starting line number in the original file for this hunk.
oldStartLine2:
type: integer
description: Starting line number in the original file for the second parent,
present in combined diffs.
required:
- header
- lines
- newStartLine
- oldStartLine
description: Array of diff blocks (hunks) showing changed line ranges in this
file.
changedPercentage:
type: number
description: Percentage of lines in the file that changed.
checksumAfter:
type: string
description: Checksum of the new file.
checksumBefore:
oneOf:
- type: string
- type: array
items:
type: string
description: Checksum of the original file. May be an array for combined diffs.
deletedFileMode:
type: string
description: File mode of the deleted file, present when the file was deleted.
deletedLines:
type: integer
description: Number of lines deleted in this file.
isBinary:
type: boolean
description: If true, this file is a binary file and the diff
content is not shown. Otherwise, false.
isCombined:
type: boolean
description: If true, this is a combined diff (merge commit).
Otherwise, false.
isCopy:
type: boolean
description: If true, this file was copied from another path.
Otherwise, false.
isDeleted:
type: boolean
description: If true, this file was deleted in the commit.
Otherwise, false.
isGitDiff:
type: boolean
description: If true, this diff was generated by Git. Otherwise,
false.
isNew:
type: boolean
description: If true, this file was added in the commit. Otherwise,
false.
isRename:
type: boolean
description: If true, this file was renamed. Otherwise,
false.
isTooBig:
type: boolean
description: If true, the diff was truncated because it exceeded
the line limit. Otherwise, false.
language:
type: string
description: Programming language or file format detected for syntax
highlighting.
mode:
type: string
description: Combined file mode when both old and new modes are the same.
newFileMode:
type: string
description: File mode of the new file, present when the file was added.
newMode:
type: string
description: File mode of the new file.
example: "100644"
newName:
type: string
description: New file path after the change.
oldMode:
oneOf:
- type: string
- type: array
items:
type: string
description: File mode of the original file. May be an array for combined diffs.
example: "100644"
oldName:
type: string
description: Original file path before the change.
unchangedPercentage:
type: number
description: Percentage of lines in the file that are unchanged.
required:
- addedLines
- blocks
- deletedLines
- isCombined
- isGitDiff
- language
- newName
- oldName
GitDiffResult:
type: object
properties:
diffJson:
$ref: "#/components/schemas/DiffFiles"
description: Diff of the file changes in the specified commit, parsed into a
structured format.
required:
- diffJson
CountedGitFilesResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitFilesResponse"
GitFile:
type: object
properties:
autoIncludedInCommit:
type: boolean
description: If true, this file is automatically included in
commits without being explicitly listed. Otherwise,
false.
children:
type: array
items:
$ref: "#/components/schemas/GitFile"
description: When this entry is a directory, nested files and subdirectories.
Each array element matches this same object shape (recursive file
tree).
name:
type: string
description: Path of the file relative to the configuration root.
state:
type: string
description: "Git status code for the file: M for modified,
A for added, or D for deleted."
required:
- name
GitFilesResponse:
type: object
properties:
commitMessage:
type: string
description: Commit message of the specified commit.
count:
type: integer
description: Number of files returned.
items:
type: array
items:
$ref: "#/components/schemas/GitFile"
description: Array of files that changed since the specified commit.
required:
- count
- items
CountedGitRevertResult:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitRevertResult"
GitRevertResult:
type: object
properties:
audit:
type: object
properties:
files:
type: object
properties:
created:
type: array
items:
type: string
description: Array of file paths that were created in the commit.
deleted:
type: array
items:
type: string
description: Array of file paths that were deleted in the commit.
modified:
type: array
items:
type: string
description: Array of file paths that were modified in the commit.
renamed:
type: array
items:
$ref: "#/components/schemas/GitFileRename"
description: Array of file rename operations, each containing the original path
and the new path.
description: Files affected by the revert, grouped by change type.
group:
type: string
description: Worker Group the revert was applied to, if applicable.
id:
type: string
description: SHA-1 hash of the revert commit that was created.
required:
- id
description: Audit record for the revert operation, including the commit hash
and affected files.
reverted:
type: boolean
description: If true, the revert was applied successfully.
Otherwise, false.
required:
- audit
- reverted
GitRevertParams:
type: object
properties:
commit:
type: string
description: SHA-1 hash of the commit to revert.
force:
type: boolean
description: If true, force the revert even when the working
directory is not clean. Otherwise, false.
message:
type: string
description: Custom message to use for the revert commit. If omitted, a default
message is generated.
required:
- commit
CountedGitShowResult:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitShowResult"
GitShowResult:
type: object
properties:
commitMessage:
type: string
description: Full commit message of the specified commit.
diffJson:
$ref: "#/components/schemas/DiffFiles"
description: Diff of the file changes introduced by the commit.
required:
- commitMessage
- diffJson
CountedSystemSettingsConf:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/SystemSettingsConf"
BackupsSettings:
oneOf:
- type: object
properties:
backupPersistence:
type: string
description: How long to retain backups. Value is a duration string such as
24h.
backupsDirectory:
type: string
description: Filesystem path where configuration backups are stored.
required:
- backupPersistence
- backupsDirectory
- $ref: "#/components/schemas/EmptyObject"
PiiSettings:
oneOf:
- type: object
properties:
enablePiiDetection:
type: boolean
description: If true, enable PII detection for events processed by
the Cribl instance. Otherwise, false.
required:
- enablePiiDetection
- $ref: "#/components/schemas/EmptyObject"
RollbackSettings:
oneOf:
- type: object
properties:
rollbackEnabled:
type: boolean
description: If true, enable automatic rollback if an upgrade
fails. Otherwise, false.
rollbackRetries:
type: integer
description: Number of times to retry a rollback before marking it as failed.
rollbackTimeout:
type: integer
description: Maximum duration in milliseconds to wait for a rollback to complete
before marking it as failed.
required:
- rollbackEnabled
- $ref: "#/components/schemas/EmptyObject"
SniSettings:
oneOf:
- type: object
properties:
disableSNIRouting:
type: boolean
description: If true, disable Server Name Indication (SNI) routing.
Otherwise, false.
required:
- disableSNIRouting
- $ref: "#/components/schemas/EmptyObject"
TlsSettings:
oneOf:
- type: object
properties:
defaultCipherList:
type: string
description: Cipher suite list to use for TLS connections. DEFAULT
means the system default.
defaultEcdhCurve:
type: string
description: ECDH curve name for TLS key exchange. Use auto to let
Node.js choose.
maxVersion:
type: string
description: Maximum TLS protocol version to accept.
minVersion:
type: string
description: Minimum TLS protocol version to accept.
rejectUnauthorized:
type: boolean
description: If true, reject TLS certificates that cannot be
verified against a valid Certificate Authority. Otherwise,
false.
required:
- defaultCipherList
- defaultEcdhCurve
- maxVersion
- minVersion
- rejectUnauthorized
- $ref: "#/components/schemas/EmptyObject"
UpgradeGroupSettings:
type: object
properties:
isRolling:
type: boolean
description: If true, perform a rolling upgrade that updates nodes
incrementally. If false, upgrade all nodes
simultaneously.
quantity:
type: integer
description: Percentage of nodes to upgrade at a time during a rolling upgrade.
retryCount:
type: integer
description: Number of times to retry upgrading a node before marking it as
failed.
retryDelay:
type: integer
description: Delay in milliseconds between upgrade retries when a node fails to
upgrade.
title: UpgradeGroupSettings
UpgradePackageUrls:
type: object
properties:
packageHashUrl:
type: string
description: URL of the hash file used to verify the package download.
packageUrl:
type: string
description: URL of the upgrade package file.
required:
- packageUrl
UpgradeSettings:
type: object
properties:
automaticUpgradeCheckPeriod:
type: string
description: How frequently to check for available upgrades. Value is a duration
string such as 24h.
disableAutomaticUpgrade:
type: boolean
description: If true, automatic upgrades are disabled. Otherwise,
false.
enableLegacyEdgeUpgrade:
type: boolean
description: If true, enable the legacy upgrade flow for Edge
Nodes. Otherwise, false.
packageUrls:
type: array
items:
$ref: "#/components/schemas/UpgradePackageUrls"
description: List of custom package URLs to use for manual upgrades.
upgradeSource:
type: string
description: "Upgrade source: cribl for official Cribl packages or
custom for a custom package URL."
SystemSettingsConf:
type: object
properties:
api:
$ref: "#/components/schemas/ApiTypeSystemSettingsConf"
apps:
$ref: "#/components/schemas/AppsTypeSystemSettingsConf"
backups:
$ref: "#/components/schemas/BackupsSettings"
description: Configuration backup settings, including storage location and
retention period.
customLogo:
$ref: "#/components/schemas/CustomLogoTypeSystemSettingsConf"
pii:
$ref: "#/components/schemas/PiiSettings"
description: Personally identifiable information (PII) detection configuration.
proxy:
$ref: "#/components/schemas/ProxyTypeSystemSettingsConf"
rollback:
$ref: "#/components/schemas/RollbackSettings"
description: Automatic rollback settings applied when an upgrade fails.
shutdown:
$ref: "#/components/schemas/ShutdownTypeSystemSettingsConf"
sni:
$ref: "#/components/schemas/SniSettings"
description: Server Name Indication (SNI) routing configuration.
sockets:
$ref: "#/components/schemas/SocketsTypeSystemSettingsConf"
support:
$ref: "#/components/schemas/SupportTypeSystemSettingsConf"
system:
$ref: "#/components/schemas/SystemTypeSystemSettingsConf"
tls:
$ref: "#/components/schemas/TlsSettings"
description: Global TLS/SSL settings applied to all outbound connections that do
not specify their own TLS configuration.
upgradeGroupSettings:
$ref: "#/components/schemas/UpgradeGroupSettings"
description: Rolling upgrade group settings that control how many nodes are
upgraded at a time.
upgradeSettings:
$ref: "#/components/schemas/UpgradeSettings"
description: Automatic upgrade scheduling and package source configuration.
workers:
$ref: "#/components/schemas/WorkersTypeSystemSettingsConf"
required:
- api
- backups
- pii
- proxy
- rollback
- shutdown
- sni
- system
- tls
- upgradeGroupSettings
- upgradeSettings
- workers
SystemSettingsConfUpdate:
type: object
properties:
api:
$ref: "#/components/schemas/ApiTypeSystemSettingsConf"
apps:
$ref: "#/components/schemas/AppsTypeSystemSettingsConf"
backups:
$ref: "#/components/schemas/BackupsSettings"
description: Configuration backup settings, including storage location and
retention period.
customLogo:
$ref: "#/components/schemas/CustomLogoTypeSystemSettingsConf"
pii:
$ref: "#/components/schemas/PiiSettings"
description: Personally identifiable information (PII) detection configuration.
proxy:
$ref: "#/components/schemas/ProxyTypeSystemSettingsConf"
rollback:
$ref: "#/components/schemas/RollbackSettings"
description: Automatic rollback settings applied when an upgrade fails.
shutdown:
$ref: "#/components/schemas/ShutdownTypeSystemSettingsConf"
sni:
$ref: "#/components/schemas/SniSettings"
description: Server Name Indication (SNI) routing configuration.
sockets:
$ref: "#/components/schemas/SocketsTypeSystemSettingsConf"
support:
$ref: "#/components/schemas/SupportTypeSystemSettingsConf"
system:
$ref: "#/components/schemas/SystemTypeSystemSettingsConf"
tls:
$ref: "#/components/schemas/TlsSettings"
description: Global TLS/SSL settings applied to all outbound connections that do
not specify their own TLS configuration.
upgradeGroupSettings:
$ref: "#/components/schemas/UpgradeGroupSettings"
description: Rolling upgrade group settings that control how many nodes are
upgraded at a time.
upgradeSettings:
$ref: "#/components/schemas/UpgradeSettings"
description: Automatic upgrade scheduling and package source configuration.
workers:
$ref: "#/components/schemas/WorkersTypeSystemSettingsConf"
CountedSystemRestartResponse:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/SystemRestartResponse"
SystemRestartResponse:
type: object
properties:
restart:
type: boolean
const: true
description: Restart operation initiated.
required:
- restart
CountedBranchInfo:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/BranchInfo"
BranchInfo:
type: object
properties:
id:
type: string
description: Unique identifier.
required:
- id
GitCommitBody:
type: object
properties:
effective:
type: boolean
description: If true, apply the commit to the group's effective
configuration. Requires a group context.
files:
type: array
items:
type: string
description: Array of file paths to include in the commit, relative to the
configuration root. If omitted, all pending changes are committed.
message:
type: string
description: Commit message to use for the new Git commit.
required:
- message
CurrentBranchResult:
type: object
properties:
branch:
type: string
description: Name of the Git branch that the Cribl configuration is currently
checked out to.
required:
- branch
CountedGitInfo:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitInfo"
GitInfo:
type: object
properties:
remote:
oneOf:
- type: string
- enum:
- false
x-speakeasy-unknown-values: allow
description: URL of the configured remote Git repository, with credentials
redacted. false if no remote is configured.
versioning:
type: boolean
description: If true, Git versioning is enabled for this Cribl
instance. Otherwise, false.
required:
- remote
- versioning
PaginatedGitLogResult:
type: object
required:
- items
- count
properties:
items:
type: array
description: The pre-limited items in the list of results
items:
$ref: "#/components/schemas/GitLogResult"
count:
type: integer
description: Number of items present in the items array
offset:
type: integer
description: Pagination offset
limit:
type: integer
description: Pagination limit
totalCount:
type: integer
description: Total number of items available (present when limit is set)
GitLogResult:
type: object
properties:
author_email:
type: string
description: Email address of the commit author.
author_name:
type: string
description: Display name of the commit author.
body:
type: string
description: Body of the commit message, excluding the subject line.
date:
type: string
description: Date and time of the commit in ISO 8601 format with timezone offset.
hash:
type: string
description: Full SHA-1 hash of the commit.
message:
type: string
description: First line of the commit message (the subject).
refs:
type: string
description: Git refs (branches, tags) pointing to this commit.
CountedGitStatusResult:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
$ref: "#/components/schemas/GitStatusResult"
GitStatusResult:
type: object
properties:
ahead:
type: integer
description: Number of local commits that have not been pushed to the remote
repository.
behind:
type: integer
description: Number of commits in the remote repository that have not been
pulled to the local branch.
conflicted:
type: array
items:
type: string
description: Array of file paths that have merge conflicts.
created:
type: array
items:
type: string
description: Array of file paths for newly created files that are staged for
commit.
current:
type: string
description: Name of the current Git branch.
deleted:
type: array
items:
type: string
description: Array of file paths for deleted files that are staged for commit.
files:
type: array
items:
type: object
properties:
index:
type: string
description: Status code for the file in the index (staging area), using Git
short-format notation.
path:
type: string
description: File path relative to the configuration root.
working_dir:
type: string
description: Status code for the file in the working directory, using Git
short-format notation.
required:
- index
- path
- working_dir
description: Array of all changed files with their index and working directory
status codes.
modified:
type: array
items:
type: string
description: Array of file paths for modified files that are staged for commit.
not_added:
type: array
items:
type: string
description: Array of file paths that have been modified but are not staged for
commit.
renamed:
type: array
items:
type: object
properties:
from:
type: string
description: Original file path before the rename.
to:
type: string
description: New file path after the rename.
required:
- from
- to
description: Array of file rename operations that are staged for commit.
staged:
type: array
items:
type: string
description: Array of file paths that are staged for the next commit.
required:
- ahead
- behind
- conflicted
- created
- current
- deleted
- files
- modified
- not_added
- renamed
- staged
CountedBoolean:
type: object
required:
- items
- count
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
description: List of items in this response.
items:
type: boolean
AdditionalPropertiesTypeEnrichedFieldsSavedState:
type: object
required:
- data
properties:
data:
type: object
additionalProperties: true
TypeOptionsEventBreakerExistingOrNewNewTimestampTypeAuto:
enum:
- auto
type: string
description: Resource type identifier.
EventBreakerTypeOptionsEventBreakerExistingOrNewNew:
type: string
title: Event Breaker type
enum:
- regex
- json
- json_array
- header
- timestamp
- csv
- aws_cloudtrail
- aws_vpcflow
- azure_flowlog
x-speakeasy-enum-descriptions:
- Regex
- JSON Newline Delimited
- JSON Array
- File Header
- Timestamp
- CSV
- AWS CloudTrail
- AWS VPC Flow Log
- Azure VNet Flow Log
description: Event Breaker type
x-speakeasy-unknown-values: allow
TimestampTypeOptionsEventBreakerExistingOrNewNewTimestamp:
type: string
title: Timestamp type
enum:
- auto
- format
- current
description: Timestamp type
x-speakeasy-unknown-values: allow
EventBreakerExistingOrNewNewTimestampType:
oneOf:
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewTimestampTypeAuto"
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewTimestampTypeFormat"
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewTimestampTypeCurrent"
discriminator:
propertyName: type
mapping:
auto: "#/components/schemas/EventBreakerExistingOrNewNewTimestampTypeAuto"
format: "#/components/schemas/EventBreakerExistingOrNewNewTimestampTypeFormat"
current: "#/components/schemas/EventBreakerExistingOrNewNewTimestampTypeCurrent"
MinimumTlsVersionOptionsRedisDeploymentTypeStandaloneTlsOptions:
type: string
title: Minimum TLS version
description: Minimum TLS version to use when connecting
enum:
- TLSv1
- TLSv1.1
- TLSv1.2
- TLSv1.3
x-speakeasy-unknown-values: allow
MaximumTlsVersionOptionsRedisDeploymentTypeStandaloneTlsOptions:
type: string
title: Maximum TLS version
description: Maximum TLS version to use when connecting
enum:
- TLSv1
- TLSv1.1
- TLSv1.2
- TLSv1.3
x-speakeasy-unknown-values: allow
RootNodeConfRedisDeploymentTypeCluster:
type: object
required:
- host
- port
properties:
host:
type: string
title: Hostname
description: "Hostname of cluster node. 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: `myBucket-${C.vars.myVar}`."
port:
type: number
title: Port
description: Port of cluster node
ScaleReadsOptionsRedisDeploymentTypeCluster:
title: Scale reads
type: string
description: Which nodes read commands should be sent to
enum:
- master
- replica
- all
x-speakeasy-enum-descriptions:
- Masters
- Replicas
- Masters and Replicas
x-speakeasy-unknown-values: allow
AuthTypeOptionsRedisAuthTypeNone:
enum:
- none
type: string
description: Discriminator value.
AuthTypeOptionsRedisAuthTypeManual:
enum:
- manual
type: string
description: Discriminator value.
TypeOptionsSerdeTypeKvp:
enum:
- kvp
type: string
description: Resource type identifier.
TypeOptionsSerdeTypeDelim:
enum:
- delim
type: string
description: Resource type identifier.
RegexListConfSerdeTypeRegex:
type: object
required:
- regex
properties:
regex:
type: string
title: Regex
description: Regex literal with named capturing groups, such as (?bar), or
_NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^
=]+)=(?<_VALUE_0>[^,]+)
minLength: 1
PatternListConfSerdeTypeGrok:
type: object
required:
- pattern
properties:
pattern:
type: string
title: Pattern
description: "Grok pattern to extract fields. Syntax supported:
%{PATTERN_NAME:FIELD_NAME}"
PrivacyProtocolOptionsSnmpTrapSerializeV3UserAuthProtocolNotNone:
type: string
enum:
- none
- des
- aes
- aes256b
- aes256r
x-speakeasy-enum-descriptions:
- None
- DES
- AES128
- AES256b (Blumenthal)
- AES256r (Reeder)
title: Privacy protocol
description: Privacy protocol
x-speakeasy-unknown-values: allow
AddConfFunctionConfSchemaAggregation:
type: object
required:
- value
properties:
name:
type: string
title: Name
description: Name
value:
type: string
title: Value Expression
description: JavaScript expression to compute the value (can be constant)
NameFieldType:
type: object
required:
- raw
- path
properties:
raw:
type: string
path:
type: array
items:
oneOf:
- type: string
- type: number
TemplateTargetPairConfFunctionConfSchemaNotificationPolicies:
type: object
required:
- templateId
- targetId
properties:
templateId:
type: string
title: Template ID
description: ID of the notification template to use
targetId:
type: string
title: Target ID
description: ID of the notification target (output)
OtlpVersionOptions:
type: string
title: OTLP version
enum:
- 0.10.0
- 1.3.1
x-speakeasy-enum-descriptions:
- 0.10.0
- 1.3.1
description: OTLP version
x-speakeasy-unknown-values: allow
AuthenticationProtocolOptionsV3User:
type: string
enum:
- none
- md5
- sha
- sha224
- sha256
- sha384
- sha512
x-speakeasy-enum-descriptions:
- None
- MD5
- SHA1
- SHA224
- SHA256
- SHA384
- SHA512
title: Authentication protocol
description: Authentication protocol
x-speakeasy-unknown-values: allow
AuthTypeOptionsAzureBlobAuthTypeSecret:
enum:
- secret
type: string
description: Discriminator value.
CertificateTypeAzureBlobAuthTypeClientCert:
type: object
required:
- certificateName
properties:
certificateName:
type: string
title: Certificate
description: The certificate you registered as credentials for your app in the
Azure portal
HiddenDefaultBreakersOptionsDatabaseCollectorConf:
type: string
title: Hidden Default Breakers
enum:
- Cribl
description: Hidden Default Breakers
x-speakeasy-unknown-values: allow
AuthTypeOptionsGoogleCloudStorageAuthTypeAuto:
enum:
- auto
type: string
description: Discriminator value.
CollectMethodOptionsHealthCheckCollectMethodGet:
enum:
- get
type: string
description: Discriminator value.
CollectRequestParamConfHealthCheckCollectMethodPost:
type: object
required:
- name
- value
properties:
name:
title: Name
type: string
description: Parameter name.
value:
title: Value
type: string
description: JavaScript expression to compute the parameter value (can be a
constant).
CollectMethodOptionsHealthCheckCollectMethodPost:
enum:
- post
type: string
description: Discriminator value.
CollectMethodOptionsHealthCheckCollectMethodPostWithBody:
enum:
- post_with_body
type: string
description: Discriminator value.
AuthenticationOptionsHealthCheckAuthenticationBasic:
enum:
- basic
type: string
description: Discriminator value.
AuthenticationOptionsHealthCheckAuthenticationBasicSecret:
enum:
- basicSecret
type: string
description: Discriminator value.
AuthRequestHeaderConfHealthCheckAuthenticationLogin:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: Header name.
value:
type: string
title: Value
description: JavaScript expression to compute the header value (can be a
constant).
AuthenticationOptionsHealthCheckAuthenticationLogin:
enum:
- login
type: string
description: Discriminator value.
AuthenticationOptionsHealthCheckAuthenticationLoginSecret:
enum:
- loginSecret
type: string
description: Discriminator value.
AuthRequestParamConfHealthCheckAuthenticationOauth:
type: object
required:
- name
- value
properties:
name:
title: Name
type: string
description: Parameter name.
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.
AuthRequestHeaderConfHealthCheckAuthenticationOauth:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: 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.
RefreshRequestParamConfHealthCheckAuthenticationOauth:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: Parameter name.
value:
type: string
title: Value
description: Parameter value.
AuthenticationOptionsHealthCheckAuthenticationOauth:
enum:
- oauth
type: string
description: Discriminator value.
RefreshRequestParamConfHealthCheckAuthenticationOauthSecret:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: Name
value:
type: string
title: Value
description: Value
AuthenticationOptionsHealthCheckAuthenticationOauthSecret:
enum:
- oauthSecret
type: string
description: Discriminator value.
DiscoverMethodOptionsHealthCheckDiscoveryDiscoverTypeHttp:
type: string
title: Discover method
description: Discover HTTP method.
enum:
- get
- post
- post_with_body
x-speakeasy-enum-descriptions:
- GET
- POST
- POST with Body
x-speakeasy-unknown-values: allow
DiscoverTypeOptionsHealthCheckDiscoveryDiscoverTypeHttp:
enum:
- http
type: string
description: Discriminator value.
DiscoverTypeOptionsHealthCheckDiscoveryDiscoverTypeJson:
enum:
- json
type: string
description: Discriminator value.
DiscoverTypeOptionsHealthCheckDiscoveryDiscoverTypeList:
enum:
- list
type: string
description: Discriminator value.
TypeOptionsHealthCheckRetryRulesTypeNone:
enum:
- none
type: string
description: Resource type identifier.
TypeOptionsHealthCheckRetryRulesTypeStatic:
enum:
- static
type: string
description: Resource type identifier.
TypeOptionsHealthCheckRetryRulesTypeBackoff:
enum:
- backoff
type: string
description: Resource type identifier.
RetryTypeOptionsHealthCheckCollectorConfRetryRules:
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
x-speakeasy-unknown-values: allow
CollectRequestParamConfRestCollectMethodGet:
type: object
required:
- name
- value
properties:
name:
title: Name
type: string
description: Name
value:
title: Value
type: string
description: JavaScript expression to compute parameter value, usually enclosed
in backticks (`${earliest}`). If a constant, use single quotes
('earliest'). Values that aren't successfully evaluated as
JavaScript expressions will be treated as string constants.
CollectMethodOptionsRestCollectMethodOther:
enum:
- other
type: string
description: Discriminator value.
TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationTypeResponseBody:
enum:
- response_body
type: string
description: Resource type identifier.
TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationTypeResponseHeader:
enum:
- response_header
type: string
description: Resource type identifier.
TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationTypeResponseHeaderLink:
enum:
- response_header_link
type: string
description: Resource type identifier.
TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationTypeRequestOffset:
enum:
- request_offset
type: string
description: Resource type identifier.
TypeOptionsRestDiscoveryDiscoverTypeHttpPaginationTypeRequestPage:
enum:
- request_page
type: string
description: Resource type identifier.
DiscoverMethodOptionsRestDiscoveryDiscoverTypeHttp:
type: string
title: Discover method
enum:
- get
- post
- post_with_body
- other
x-speakeasy-enum-descriptions:
- GET
- POST
- POST with Body
- Other
description: Discover method
x-speakeasy-unknown-values: allow
PaginationOptionsRestDiscoveryDiscoverTypeHttpPagination:
type: string
title: Pagination
enum:
- none
- response_body
- response_header
- response_header_link
- request_offset
- request_page
x-speakeasy-enum-descriptions:
- None
- Response Body Attribute
- Response Header Attribute
- RFC 5988 - Web Linking
- Offset/Limit
- Page/Size
description: Pagination
x-speakeasy-unknown-values: allow
RestDiscoveryDiscoverTypeHttpPaginationType:
oneOf:
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTypeNone"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTypeResponse\
Body"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTypeResponse\
Header"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTypeResponse\
HeaderLink"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTypeRequestO\
ffset"
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTypeRequestP\
age"
discriminator:
propertyName: type
mapping:
none: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTypeNone"
response_body: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTyp\
eResponseBody"
response_header: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationT\
ypeResponseHeader"
response_header_link: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPagina\
tionTypeResponseHeaderLink"
request_offset: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationTy\
peRequestOffset"
request_page: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationType\
RequestPage"
AuthenticationMethodOptionsS3CollectorConf:
type: string
title: Authentication method
description: AWS authentication method. Choose Auto to use IAM roles.
enum:
- auto
- manual
- secret
x-speakeasy-enum-descriptions:
- Auto
- Manual
- Secret Key pair
x-speakeasy-unknown-values: allow
OutputModeOptionsSplunkCollectorConf:
type: string
title: Output mode
description: Format of the returned output
enum:
- csv
- json
x-speakeasy-unknown-values: allow
InputCollectionOriginDataSourceDiscoveryWithDestinationArnConstraint:
type: object
title: Input provenance
description: Read-only metadata that records how the Source was created.
Preserved on update when omitted from the request body. Cannot be set on
create.
additionalProperties: false
properties:
origin:
type: string
enum:
- data_source_discovery
description: Feature that created the Source.
x-speakeasy-unknown-values: allow
destinationArn:
type: string
description: ARN of the S3 bucket or Firehose delivery stream configured as the
Source.
sourceArn:
type: string
description: ARN of the AWS resource that produces the logs.
readOnly: true
ConnectionConfInputCollection:
type: object
properties:
pipeline:
title: Pipeline or Pack
description: Pipeline or Pack to process data before sending to the Destination.
type: string
output:
title: Destination
description: Destination to send data to when not using Routes.
type: string
ModeOptionsPq:
type: string
title: Mode
description: With Smart mode (deprecated), PQ will write events to the
filesystem only when it detects backpressure from the processing engine.
Smart mode will have no new development starting July 2026, followed by
End of Support and feature removal (auto-migrating to Always On) in
January 2027. We recommend using Always On mode instead. With Always On
mode, PQ will always write events directly to the queue before
forwarding them to the processing engine.
enum:
- smart
- always
x-speakeasy-enum-descriptions:
- Smart (Deprecated)
- Always On
x-speakeasy-unknown-values: allow
CompressionOptionsPq:
type: string
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
QueueFullBehaviorOptionsPq:
type: string
title: Queue-full behavior
description: Whether to block or drop 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.
enum:
- block
- drop
x-speakeasy-enum-descriptions:
- Block
- Drop new data
x-speakeasy-unknown-values: allow
PreprocessType:
type: object
required:
- disabled
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
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
MetadataConfInputCollection:
type: object
required:
- name
- value
properties:
name:
type: string
title: Field Name
description: Name of the metadata field.
value:
type: string
title: Value
description: JavaScript expression to compute field's value, enclosed in quotes
or backticks. (Can evaluate to a constant.)
OauthParamConfInputKafka:
type: object
required:
- name
- value
properties:
name:
type: string
title: Parameter Name
description: Parameter Name
value:
type: string
title: Parameter Value
description: Parameter Value
MinimumTlsVersionOptionsTls:
type: string
title: Minimum TLS version
enum:
- TLSv1
- TLSv1.1
- TLSv1.2
- TLSv1.3
description: Minimum TLS version
x-speakeasy-unknown-values: allow
MaximumTlsVersionOptionsTls:
type: string
title: Maximum TLS version
enum:
- TLSv1
- TLSv1.1
- TLSv1.2
- TLSv1.3
description: Maximum TLS version
x-speakeasy-unknown-values: allow
AuthenticationMethodOptionsSasl:
enum:
- manual
- secret
title: Authentication method
type: string
description: Enter credentials directly, or select a stored secret
x-speakeasy-unknown-values: allow
SaslMechanismOptionsSasl:
enum:
- plain
- scram-sha-256
- scram-sha-512
- kerberos
type: string
x-speakeasy-enum-descriptions:
- PLAIN
- SCRAM-SHA-256
- SCRAM-SHA-512
- GSSAPI/Kerberos
title: SASL mechanism
description: SASL mechanism
x-speakeasy-unknown-values: allow
SaslExtensionConfInputKafka:
type: object
required:
- name
- value
properties:
name:
type: string
title: Field Name
description: Field Name
value:
type: string
title: Field Value
description: Field Value
TypeOptions:
type: string
enum:
- kafka
description: Connector type identifier.
TypeOptionsMsk:
type: string
enum:
- msk
description: Connector type identifier.
TypeOptionsSplunk:
type: string
enum:
- splunk
description: Connector type identifier.
AuthenticationMethodOptionsAuthTokensItems:
title: Authentication method
type: string
enum:
- manual
- secret
description: Select Manual to enter an auth token directly, or select Secret to
use a text secret to authenticate
x-speakeasy-unknown-values: allow
AuthenticationMethodOptions:
title: Authentication method
type: string
enum:
- manual
- secret
- clientSecret
- clientCert
- clientAssertion
- clientAssertion_rpc
description: Authentication method
x-speakeasy-unknown-values: allow
TypeOptionsAzureblob:
type: string
enum:
- azure_blob
description: Connector type identifier.
ExtraHttpHeaderConfInputElastic:
type: object
required:
- value
properties:
name:
type: string
title: Field Name
description: Field Name
value:
type: string
title: Field Value
description: Field Value
TypeOptionsConfluentcloud:
type: string
enum:
- confluent_cloud
description: Connector type identifier.
AuthenticationTypeOptionsPrometheusAuth:
type: string
title: Authentication type
description: Remote Write authentication type
enum:
- none
- basic
- credentialsSecret
- token
- textSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Token
- Token (text secret)
x-speakeasy-unknown-values: allow
AuthenticationTypeOptionsLokiAuth:
type: string
title: Authentication type
description: Loki logs authentication type
enum:
- none
- basic
- credentialsSecret
- token
- textSecret
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- Token
- Token (text secret)
x-speakeasy-unknown-values: allow
LogLevelOptions:
type: string
title: Log level
enum:
- error
- warn
- info
- debug
description: Collector runtime log level
x-speakeasy-unknown-values: allow
RecordTypeOptions:
enum:
- SRV
- A
- AAAA
type: string
title: Record type
description: DNS record type to resolve
x-speakeasy-unknown-values: allow
SearchFilterConfInputPrometheus:
type: object
required:
- Name
- Values
properties:
Name:
type: string
title: Filter name
description: See
https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
for information. Attributes can be manually entered if not present
in the list.
Values:
type: array
title: Filter values
description: Values to match within this row's attribute. If empty, search will
return only running EC2 instances.
minItems: 0
items:
type: string
minLength: 1
TypeOptionsPrometheus:
type: string
enum:
- prometheus
description: Connector type identifier.
CompressionOptionsPersistence:
type: string
title: Compression
description: Data compression format. Default is gzip.
enum:
- none
- gzip
x-speakeasy-unknown-values: allow
ProtocolOptionsTargetsItems:
type: string
title: Protocol
enum:
- http
- https
description: Protocol to use when collecting metrics
x-speakeasy-unknown-values: allow
SubscriptionPlanOptions:
type: string
title: Subscription plan
description: Microsoft 365 subscription plan for your organization, typically
Microsoft 365 Enterprise
enum:
- enterprise_gcc
- gcc
- gcc_high
- dod
x-speakeasy-enum-descriptions:
- Microsoft 365 Enterprise
- Microsoft 365 GCC
- Microsoft 365 GCC High
- Microsoft 365 DoD
x-speakeasy-unknown-values: allow
LogLevelOptionsContentConfigItems:
type: string
title: Log Level
enum:
- error
- warn
- info
- debug
description: Collector runtime Log Level
x-speakeasy-unknown-values: allow
AuthenticationMethodOptionsManualSecret:
title: Authentication method
type: string
enum:
- manual
- secret
description: Enter client secret directly, or select a stored secret
x-speakeasy-unknown-values: allow
LogLevelOptionsDebugError:
type: string
title: Log level
description: Log Level (verbosity) for collection runtime behavior.
enum:
- error
- warn
- info
- debug
- silly
x-speakeasy-unknown-values: allow
CertOptionsType:
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.
AuthenticationMethodOptionsSaslManualSecret:
enum:
- manual
- secret
title: Authentication method
type: string
description: Enter password directly, or select a stored secret
x-speakeasy-unknown-values: allow
SaslMechanismOptionsSaslOauthbearerPlain:
enum:
- plain
- oauthbearer
type: string
x-speakeasy-enum-descriptions:
- PLAIN
- OAUTHBEARER
title: SASL mechanism
description: SASL mechanism
x-speakeasy-unknown-values: allow
AuthenticationMethodOptionsSaslCertificateManual:
enum:
- manual
- secret
- certificate
title: Authentication method
type: string
description: Authentication method
x-speakeasy-unknown-values: allow
MicrosoftEntraIdAuthenticationEndpointOptionsSasl:
type: string
title: Microsoft Entra ID authentication endpoint
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
TlsSettingsClientSideType:
type: object
title: TLS settings (client side)
required:
- disabled
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
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)
description: TLS settings (client side)
AuthenticationMethodOptionsAuth:
enum:
- secret
- certificate
title: Authentication method
type: string
description: Authentication method
x-speakeasy-unknown-values: allow
GoogleAuthenticationMethodOptions:
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.
enum:
- auto
- manual
- secret
x-speakeasy-enum-descriptions:
- Auto
- Manual
- Secret
x-speakeasy-unknown-values: allow
TypeOptionsGooglepubsub:
type: string
enum:
- google_pubsub
description: Connector type identifier.
AuthTokenConfInputCriblTcp:
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
description: Enable token
description:
type: string
title: Description
description: Optional token description
TypeOptionsCribltcp:
type: string
enum:
- cribl_tcp
description: Connector type identifier.
TypeOptionsTcpjson:
type: string
enum:
- tcpjson
description: Connector type identifier.
ModeOptionsHost:
type: string
description: Select level of detail for host metrics
enum:
- basic
- all
- custom
- disabled
x-speakeasy-enum-descriptions:
- Basic
- All
- Custom
- Disabled
x-speakeasy-unknown-values: allow
SetConfInputSystemMetrics:
type: object
required:
- name
- filter
properties:
name:
type: string
title: Set Name
description: Set Name
filter:
type: string
title: Filter Expression
description: Filter Expression
includeChildren:
type: boolean
title: Include Child Processes
description: Include Child Processes
ModeOptionsGpu:
type: string
description: Select the level of detail for GPU metrics
enum:
- basic
- all
- custom
- disabled
x-speakeasy-enum-descriptions:
- Basic
- All
- Custom
- Disabled
x-speakeasy-unknown-values: allow
DataCompressionFormatOptionsPersistence:
type: string
title: Data compression format
enum:
- none
- gzip
description: Data compression format
x-speakeasy-unknown-values: allow
RuleConfInputKubeMetrics:
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
CheckpointingType:
type: object
required:
- enabled
properties:
enabled:
type: boolean
title: Enable checkpointing
description: Resume processing files after an interruption
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.
maximum: 100
minimum: 0
SqsAuthenticationMethodOptions:
enum:
- auto
- secret
type: string
title: SQS authentication method
description: Choose Auto to use IAM roles
x-speakeasy-enum-descriptions:
- Auto
- Secret Key Pair
x-speakeasy-unknown-values: allow
TagAfterProcessingOptions:
enum:
- false
- true
x-speakeasy-unknown-values: allow
TypeOptionsKinesis:
type: string
enum:
- kinesis
description: Connector type identifier.
TypeOptionsS3:
type: string
enum:
- s3
description: Connector type identifier.
TypeOptionsSnmp:
type: string
enum:
- snmp
description: Connector type identifier.
TypeOptionsSqs:
type: string
enum:
- sqs
description: Connector type identifier.
TypeOptionsSyslog:
type: string
enum:
- syslog
description: Connector type identifier.
LogLevelOptionsContentConfigItemsDebugError:
type: string
title: Log level
enum:
- error
- warn
- info
- debug
- silly
description: Collector runtime log level
x-speakeasy-unknown-values: allow
TypeOptionsNetflow:
type: string
enum:
- netflow
description: Connector type identifier.
TypeOptionsSecuritylake:
type: string
enum:
- security_lake
description: Connector type identifier.
OauthParamConfInputServicenowTable:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: OAuth parameter name
value:
type: string
title: Value
description: OAuth parameter value
OauthHeaderConfInputServicenowTable:
type: object
required:
- name
- value
properties:
name:
type: string
title: Name
description: OAuth header name
value:
type: string
title: Value
description: OAuth header value
AuthenticationMethodOptionsAuthTokensItemsSecret:
title: Authentication method
type: string
enum:
- secret
description: Select Secret to use a text secret to authenticate
x-speakeasy-unknown-values: allow
MetadataConfAddHecTokenRequest:
type: object
properties:
name:
type: string
value:
type: string
required:
- name
- value
JobTypeOptionsRunnableJobCollection:
type: string
title: Job type
enum:
- collection
- executor
- scheduledSearch
description: Job type
x-speakeasy-unknown-values: allow
RunnableJobCollectionTypeCollectionConstraint:
type: object
properties:
type:
enum:
- collection
description: Resource type identifier.
x-speakeasy-unknown-values: allow
LogLevelOptionsRunnableJobCollectionScheduleRun:
type: string
title: Log level
description: Level at which to set task logging
enum:
- error
- warn
- info
- debug
- silly
x-speakeasy-unknown-values: allow
TypeOptionsRunnableJobCollectionInput:
type: string
enum:
- collection
description: Resource type identifier.
x-speakeasy-unknown-values: allow
ExecutorSpecificSettingsTypeRunnableJobExecutorExecutor:
type: object
title: Executor-specific settings
properties: {}
description: Executor-specific settings
AdditionalPropertiesTypeJobInfoStats:
oneOf:
- type: number
- type: object
additionalProperties:
type: number
HealthOptionsStatus:
type: string
enum:
- Green
- Red
- Unknown
- Yellow
description: Overall health status of the Source or Destination.
x-speakeasy-unknown-values: allow
MethodOptions:
type: string
title: Method
description: The method to use when sending events
enum:
- POST
- PUT
- PATCH
x-speakeasy-unknown-values: allow
FailedRequestLoggingModeOptions:
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
x-speakeasy-unknown-values: allow
ResponseRetrySettingConfOutputWebhook:
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
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
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
TimeoutRetrySettingsType:
type: object
required:
- timeoutRetry
properties:
timeoutRetry:
type: boolean
title: Retry timed-out HTTP requests
description: Retry timed-out HTTP requests
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
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
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
BackpressureBehaviorOptions:
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
x-speakeasy-unknown-values: allow
ModeOptions:
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
x-speakeasy-enum-descriptions:
- Error
- Backpressure
- Always On
x-speakeasy-unknown-values: allow
QueueFullBehaviorOptions:
type: string
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
TlsOptionsHostsItems:
type: string
title: TLS
description: Whether to inherit TLS configs from group setting or disable TLS
enum:
- inherit
- off
x-speakeasy-unknown-values: allow
NestedFieldSerializationOptions:
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
x-speakeasy-unknown-values: allow
MaxS2SVersionOptions:
type: string
title: Max S2S version
description: The highest S2S protocol version to advertise during handshake
enum:
- v3
- v4
x-speakeasy-unknown-values: allow
CompressionOptions:
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.
enum:
- disabled
- auto
- always
x-speakeasy-enum-descriptions:
- Disabled
- Automatic
- Always
x-speakeasy-unknown-values: allow
CompressionOptionsGzipNone:
type: string
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
DataFormatOptions:
type: string
title: Data format
description: Format of the output data
enum:
- json
- raw
- parquet
x-speakeasy-enum-descriptions:
- JSON
- Raw
- Parquet
x-speakeasy-unknown-values: allow
BackpressureBehaviorOptionsBlockDrop:
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
x-speakeasy-unknown-values: allow
DiskSpaceProtectionOptions:
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
x-speakeasy-unknown-values: allow
RetrySettingsType:
type: object
properties:
enabled:
type: boolean
title: Enable retry backoff
description: Apply exponential backoff with jitter when file uploads fail
repeatedly.
initialBackoffMs:
type: number
title: Initial backoff (ms)
description: "Initial delay before first retry attempt. Valid range: 1s-5min
(1000-300000ms). Values outside this range will be clamped to the
nearest valid value."
backoffMultiplier:
type: number
title: Backoff multiplier
description: "Multiplier applied to backoff delay after each retry. Valid range:
1-10. Values outside this range will be clamped to the nearest valid
value."
maxBackoffMs:
type: number
title: Max backoff (ms)
description: "Maximum delay between retry attempts. Valid range: 1s-10min
(1000-600000ms). Values outside this range will be clamped to the
nearest valid value."
jitterPercent:
type: number
title: Jitter (%)
description: "Random jitter percentage added to backoff delay to prevent
thundering herd. Valid range: 0-100. Values outside this range will
be clamped to the nearest valid value."
OrphanFileRecoveryType:
type: object
title: Orphan file recovery
properties:
disabled:
type: boolean
title: Disabled
description: Periodically scan the staging directory for files not tracked by
any Worker manifest to recover them
periodMin:
type: number
title: Period (minutes)
description: Minimum interval between reconciliation runs
minimum: 5
maximum: 1440
description: Orphan file recovery
CompressionOptionsHttp:
type: string
title: Compression
description: Data compression format to apply to HTTP content before it is delivered
enum:
- none
- gzip
x-speakeasy-unknown-values: allow
CompressionLevelOptions:
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
x-speakeasy-unknown-values: allow
ParquetVersionOptions:
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"
description: Determines which data types are supported and how they are represented
x-speakeasy-unknown-values: allow
DataPageVersionOptions:
type: string
title: Data page version
enum:
- DATA_PAGE_V1
- DATA_PAGE_V2
x-speakeasy-enum-descriptions:
- V1
- 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
KeyValueMetadataConfOutputFilesystem:
type: object
required:
- key
- value
properties:
key:
type: string
title: Key
description: Key
value:
type: string
title: Value
description: Value
ObjectAclOptions:
type: string
title: Object ACL
description: Object ACL to assign to uploaded objects
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
StorageClassOptions:
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
ServerSideEncryptionForUploadedObjectsOptions:
type: string
title: Server-side encryption for uploaded objects
description: Server-side encryption to use for uploaded objects
enum:
- AES256
- aws:kms
x-speakeasy-enum-descriptions:
- Amazon S3 Managed Key
- AWS KMS Managed Key
x-speakeasy-unknown-values: allow
AuthenticationMethodOptionsApi:
title: Authentication method
type: string
enum:
- manual
- secret
description: Enter API key directly, or select a stored secret
x-speakeasy-unknown-values: allow
AcknowledgmentsOptions:
type: integer
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
x-speakeasy-enums:
- Leader
- None
- All
RecordDataFormatOptions:
type: string
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
ObjectAclOptionsAuthenticatedreadBucketownerfullcontrol:
type: string
title: Object ACL
description: Object ACL to assign to uploaded objects
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
StorageClassOptionsArchiveColdline:
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
LogLabelConfOutputGoogleCloudLogging:
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.
AcknowledgmentsOptionsAllLeader:
type: integer
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
x-speakeasy-enums:
- Leader
- None
- All
RecordDataFormatOptionsJsonProtobuf:
type: string
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
CompressionOptionsGzipLz4:
type: string
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
AuthenticationMethodOptionsAuthManualManualApiKey:
enum:
- manual
- secret
- manualAPIKey
- textSecret
title: Authentication method
type: string
description: Enter credentials directly, or select a stored secret
x-speakeasy-unknown-values: allow
RegionOptions:
type: string
title: Region
description: Which New Relic region endpoint to use.
enum:
- US
- EU
- Custom
x-speakeasy-enum-descriptions:
- US
- Europe
- Custom
x-speakeasy-unknown-values: allow
StorageClassOptionsReducedredundancyStandard:
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
ServerSideEncryptionForUploadedObjectsOptionsAes256:
type: string
title: Server-side encryption for uploaded objects
description: Server-side encryption to use for uploaded objects
enum:
- AES256
x-speakeasy-enum-descriptions:
- Amazon S3 Managed Key
x-speakeasy-unknown-values: allow
DestinationProtocolOptions:
type: string
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
MessageFormatOptions:
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
x-speakeasy-unknown-values: allow
AuthenticationTypeOptionsPrometheusAuthBasicCredentialsSecret:
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)
description: Authentication type
x-speakeasy-unknown-values: allow
AuthenticationMethodOptionsAutoSecret:
type: string
title: Authentication method
description: AWS authentication method. Choose Auto to use IAM roles.
enum:
- auto
- secret
x-speakeasy-enum-descriptions:
- Auto
- Secret Key pair
x-speakeasy-unknown-values: allow
ProtocolOptions:
type: string
title: Protocol
description: Select a transport option for OpenTelemetry
enum:
- grpc
- http
x-speakeasy-enum-descriptions:
- gRPC
- HTTP
x-speakeasy-unknown-values: allow
CompressionOptionsDeflateGzip:
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
x-speakeasy-unknown-values: allow
CompressionOptionsMessages:
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
x-speakeasy-unknown-values: allow
OtlpVersionOptions131:
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
x-speakeasy-unknown-values: allow
AuthTokenConfOutputCriblHttp:
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
description: Enable token
description:
type: string
title: Description
description: Description
UrlConfOutputCriblHttp:
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
__template_url:
type: string
description: Binds 'url' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'url' at runtime.
RequestFormatOptions:
title: Request format
type: string
enum:
- JSON
- raw
x-speakeasy-enum-descriptions:
- JSON
- Raw
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
AuthenticationTypeOptions:
type: string
title: Authentication type
description: Authentication type
enum:
- none
- basic
- credentialsSecret
- sslUserCertificate
x-speakeasy-enum-descriptions:
- None
- Basic
- Basic (credentials secret)
- SSL User Certificate
x-speakeasy-unknown-values: allow
FormatOptions:
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
x-speakeasy-unknown-values: allow
MappingTypeOptions:
type: string
title: Mapping type
description: How event fields are mapped to ClickHouse columns
enum:
- automatic
- custom
x-speakeasy-enum-descriptions:
- Automatic
- Custom
x-speakeasy-unknown-values: allow
ColumnMappingConfOutputClickHouse:
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
AuthenticationMethodOptionsSecret:
type: string
title: Authentication method
description: Authentication method.
enum:
- secret
x-speakeasy-enum-descriptions:
- Secret
x-speakeasy-unknown-values: allow
AdditionalPropertiesTypeRoutesGroups:
type: object
properties:
description:
type: string
description: Brief description of the Route Group.
index:
type: integer
description: Relative position of the Route Group among all Route Groups. Routes
are evaluated in ascending order according to the index value of
their Route Group.
name:
type: string
description: Name of the Route Group.
required:
- index
- name
RouteConfInput:
type: object
properties:
clones:
type: array
items:
$ref: "#/components/schemas/RouteCloneConf"
description: Array of clone configurations, each with a key-value pair to set or
overwrite in cloned events. Original events continue to the next
Route.
context:
type: string
description: "Context for the Route: group (Worker Group or Edge
Fleet) or pack."
description:
type: string
description: Brief description of the Route.
disabled:
type: boolean
description: If true, disable the Route. Otherwise,
false.
enableOutputExpression:
type: boolean
description: If true, use the outputExpression for
dynamic Destination selection. Otherwise, false.
filter:
type: string
description: JavaScript expression to select events for routing.
groupId:
type: string
description: Unique identifier for the Route Group that the Route is associated
with.
name:
type: string
description: Name of the Route.
output:
type: string
description: Destination that the Route sends matching events to after the
Pipeline processes the events.
outputExpression:
type: string
description: JavaScript expression to evaluate for dynamic Destination
selection. Evaluation occurs when the Route is constructed, not for
each event.
pipeline:
type: string
description: Pipeline that the Route sends matching events to.
targetContext:
$ref: "#/components/schemas/TargetContext"
description: "Target context for subsequent event processing after applying the
Route: group (Worker Group or Edge Fleet) or
pack."
final:
type: boolean
description: If true (default), the Route processes matched events
and sends them to the specified Pipeline. Matched events do not
continue to the next Route, but non-matched events do continue to
the next Route. If false, the Route processes matched
events and sends them to the specified Pipeline, and all events
(matched and non-matched) continue to the next Route. Must be
false to clone events.
id:
type: string
description: Unique identifier for the Route. If omitted, the server generates a
deterministic identifier.
required:
- name
- pipeline
EstimatedIngestRateOptionsConfigGroup:
type: integer
enum:
- 1024
- 2048
- 3072
- 4096
- 5120
- 7168
- 10240
- 13312
- 15360
description: Estimated ingest rate for a Cribl.Cloud Worker Group, in GB/sec.
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
example: 4096
TypeOptionsConfigGroup:
type: string
enum:
- edge
- lake_access
- local_search
- outpost
- search
- stream
description: Explicit type of the Worker Group, Outpost Group, or Edge Fleet.
x-speakeasy-unknown-values: allow
FormatOptionsCriblLakeDataset:
type: string
enum:
- ddss
- json
- netskope
- parquet
description: Storage format used for data persisted in the Dataset.
x-speakeasy-unknown-values: allow
StorageClassOptionsCriblLakeDataset:
type: string
enum:
- Archive
- Cold
- Cool
- DEEP_ARCHIVE
- GLACIER
- GLACIER_IR
- Hot
- Inferred
- INTELLIGENT_TIERING
- ONEZONE_IA
- STANDARD
- STANDARD_IA
description: Storage class used for objects written to the Dataset.
x-speakeasy-unknown-values: allow
SslTypeSystemSettingsConfApi:
type: object
properties:
caPath:
type: string
description: Filesystem path to the PEM-encoded Certificate Authority (CA)
certificate for client authentication.
certPath:
type: string
description: Filesystem path to the PEM-encoded TLS certificate.
disabled:
type: boolean
description: If true, TLS is disabled for the API server.
Otherwise, false.
passphrase:
type: string
description: Passphrase to decrypt the TLS private key, if encrypted.
privKeyPath:
type: string
description: Filesystem path to the PEM-encoded TLS private key.
required:
- certPath
- disabled
- passphrase
- privKeyPath
description: TLS configuration for the API server.
AppsTypeSystemSettingsConf:
type: object
properties:
enabled:
type: boolean
description: If true, enable Apps. Otherwise, false.
required:
- enabled
description: App configuration.
CustomLogoTypeSystemSettingsConf:
type: object
properties:
enabled:
type: boolean
description: If true, display the custom logo in the UI. Otherwise,
false.
logoDescription:
type: string
description: Description text displayed alongside the custom logo.
logoImage:
type: string
description: Custom logo image as a base64-encoded data URI (PNG or JPEG,
maximum 2 MB).
required:
- enabled
description: Custom logo configuration for the Cribl UI login page and navigation bar.
ProxyTypeSystemSettingsConf:
type: object
properties:
useEnvVars:
type: boolean
description: If true, use proxy settings from environment variables
(HTTP_PROXY, HTTPS_PROXY,
NO_PROXY). Otherwise, false.
required:
- useEnvVars
description: HTTP proxy configuration for outbound connections.
ShutdownTypeSystemSettingsConf:
type: object
properties:
drainTimeout:
type: integer
description: Maximum time in milliseconds to wait for in-flight events to drain
before forcing a shutdown.
required:
- drainTimeout
description: Graceful shutdown configuration.
SocketsTypeSystemSettingsConf:
type: object
properties:
directory:
type: string
description: Filesystem directory path where Unix domain socket files are created.
description: Unix domain socket configuration.
FeatureFlagOverrideConfSystemSettingsConf:
type: object
properties:
disabled:
type: boolean
description: If true, the feature flag is disabled. Otherwise,
false.
flagId:
type: string
description: Unique identifier of the feature flag to override.
required:
- disabled
- flagId
UpgradeOptionsSystemSettingsConfSystem:
enum:
- api
- false
description: "Upgrade permission policy: api to allow upgrades from
the UI or API or false to disable."
x-speakeasy-unknown-values: allow
WorkersTypeSystemSettingsConf:
type: object
properties:
count:
type: integer
description: Number of Worker Processes to spawn. Set to 0 to use
the number of available CPU cores.
enableHeapSnapshots:
type: boolean
description: If true, enable V8 heap snapshot generation on
out-of-memory errors. Otherwise, false.
loadThrottlePerc:
type: integer
description: CPU load percentage threshold above which new connections are
throttled.
memory:
type: integer
description: Maximum memory (in MB) per Worker Process. Set to 0
for no limit.
minimum:
type: integer
description: Minimum number of Worker Processes to keep running.
restartUnresponsiveProcesses:
type: boolean
description: If true, automatically restart Worker Processes that
become unresponsive. Otherwise, false.
startupMaxConns:
type: integer
description: Maximum number of connections to accept during Worker Process
startup before throttling begins.
startupThrottleTimeout:
type: integer
description: Timeout in milliseconds to wait for Worker Processes to reach idle
before ending the startup throttle period.
v8SingleThread:
type: boolean
description: If true, run all worker threads in a single V8
isolate. Otherwise, false.
workerProcessConfigUpdateConcurrency:
type: integer
description: Maximum number of Worker Processes that can reload configuration
concurrently.
workerProcessReloadTimeout:
type: integer
description: Timeout in milliseconds to wait for a Worker Process to reload
configuration before treating the reload as failed.
workerThreadPoolSize:
type: integer
description: Size of the Worker thread pool used for CPU-bound tasks.
required:
- count
- memory
- minimum
description: Worker Process configuration.
TimestampFormatTypeEventBreakerExistingOrNewNew:
type: object
required:
- type
title: Timestamp format
properties:
type:
$ref: "#/components/schemas/TimestampTypeOptionsEventBreakerExistingOrNewNewTim\
estamp"
length:
type: number
title: Length
minimum: 2
description: Length
format:
type: string
title: Format
description: Format
allOf:
- $ref: "#/components/schemas/EventBreakerExistingOrNewNewTimestampType"
description: Timestamp format
TlsOptionsTypeRedisDeploymentTypeStandalone:
type: object
properties:
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
CA)
servername:
type: string
title: Server name (SNI)
description: Server name for the SNI (Server Name Indication) TLS extension.
Must be a host name, 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 certificate. 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:
$ref: "#/components/schemas/MinimumTlsVersionOptionsRedisDeploymentTypeStandalo\
neTlsOptions"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsRedisDeploymentTypeStandalo\
neTlsOptions"
TlsOptionsTypeRedisDeploymentTypeCluster:
type: object
properties:
rejectUnauthorized:
type: boolean
title: Validate server certs
description: Reject certs that are not authorized by a CA in the CA certificate
path, or by another trusted CA (such as the system's CA)
servername:
type: string
title: Server name (SNI)
description: Server name for the SNI (Server Name Indication) TLS extension.
Must be a host name, 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 certificate. 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:
$ref: "#/components/schemas/MinimumTlsVersionOptionsRedisDeploymentTypeStandalo\
neTlsOptions"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsRedisDeploymentTypeStandalo\
neTlsOptions"
PaginationTypeRestDiscoveryDiscoverTypeHttp:
type: object
required:
- type
properties:
type:
$ref: "#/components/schemas/PaginationOptionsRestDiscoveryDiscoverTypeHttpPagin\
ation"
maxPages:
type: number
title: Page limit
description: Maximum number of pages to retrieve for the discover task. Defaults
to 50 pages. Set to 0 to retrieve all pages.
minimum: 0
lastPageExpr:
type: string
title: Last-page expression
description: JavaScript expression used to determine when the last page has been
reached. The values tested by this expression must be in the
Response attributes section.
nextRelationAttribute:
type: string
title: Next page relation name
description: 'Relation name used in the link header that refers to the next page
in the result set. Example: rel="next" refers to the next page of
results: ; rel="next"'
curRelationAttribute:
type: string
title: Current page relation name
description: 'Relation name used in the link header that refers to the current
result set. Example: rel="self" refers to the current page of
results: ; rel="self" '
offsetField:
type: string
title: Offset field name
description: "Query string parameter that sets the index from which to begin
returning records. Example:
/api/v1/query?term=cribl&limit=100&offset=0"
offset:
type: number
title: Starting offset
description: Offset index from which to start request. Defaults to undefined,
which will start discovery from the first record.
limitField:
type: string
title: Limit field name
description: "Query string parameter that sets the number of records retrieved
per request. Example: /api/v1/query?term=cribl&limit=100&offset=0"
limit:
type: number
title: Record limit
description: Maximum number of records to retrieve per request
minimum: 1
totalRecordField:
type: string
title: Total record count field name
description: Name of the attribute in the response that contains the total
number of records for the query
zeroIndexed:
type: boolean
title: Zero-based index
description: Enable to indicate that the first page in the requested data is at
index 0. Disabled by default, which indicates index 1.
pageField:
type: string
title: Page number field name
description: "Query string parameter that sets the page index to be returned.
Example: /api/v1/query?term=cribl&page_size=100&page_number=0"
page:
type: number
title: Starting page number
description: Page number from which to start request. Defaults to undefined,
which will start discovery from the first page.
sizeField:
type: string
title: Page size field name
description: "Query string parameter that sets the number of records retrieved
per request. Example:
/api/v1/query?term=cribl&page_size=100&page_number=0"
size:
type: number
title: Record limit
description: Maximum number of records to retrieve per page
minimum: 1
totalPageField:
type: string
title: Total page count field name
description: Name of the attribute in the response that contains the total
number of pages for the query
allOf:
- $ref: "#/components/schemas/RestDiscoveryDiscoverTypeHttpPaginationType"
PqType:
type: object
properties:
mode:
$ref: "#/components/schemas/ModeOptionsPq"
maxBufferSizeBytes:
type: string
title: Buffer size limit (bytes)
description: The maximum size to hold in memory before writing events to disk.
Enter a numeral with units of KB, MB, etc. The minimum value is 64KB
and the maximum value is 10MB.
pattern: ^\d+\s*(?:\w{2})?$
maxBufferSize:
type: number
title: Buffer size limit (events - deprecated)
description: Maximum number of events to hold in memory before writing the
events to disk. Deprecated and only supported in workers < v4.17.0.
Use maxBufferSizeBytes instead.
minimum: 42
commitFrequency:
type: number
title: Commit frequency
description: The number of events to send downstream before committing that
Stream has read them
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})?$
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})?$
path:
type: string
title: Queue file path
description: "The location for the persistent queue files. To this field's
value, the system will append: //inputs/"
compress:
$ref: "#/components/schemas/CompressionOptionsPq"
onBackpressure:
$ref: "#/components/schemas/QueueFullBehaviorOptionsPq"
pqControls:
type: object
title: ""
description: Management controls for the persistent queue.
AuthType:
type: object
description: Credentials to use when authenticating with the schema registry
required:
- disabled
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
oauthEnabled:
type: boolean
title: Enable OAuth
description: Authenticate with the schema registry using OAuth instead of basic
HTTP authentication
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
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:
$ref: "#/components/schemas/OauthParamConfInputKafka"
identityPoolId:
type: string
title: Identity pool ID
description: Confluent Cloud identity pool ID. Sent as the
`Confluent-Identity-Pool-Id` header on requests to the schema
registry.
logicalCluster:
type: string
title: Logical cluster
description: Confluent Cloud Schema Registry logical cluster ID. Sent as the
`target-sr-cluster` header on requests to the schema registry.
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a secret that references your credentials
__template_tokenUrl:
type: string
description: Binds 'tokenUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tokenUrl' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_identityPoolId:
type: string
description: Binds 'identityPoolId' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'identityPoolId' at
runtime.
__template_logicalCluster:
type: string
description: Binds 'logicalCluster' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'logicalCluster' at
runtime.
TlsSettingsClientSideTypeCaPathCertPath:
type: object
title: TLS settings (client side)
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
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.
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:
$ref: "#/components/schemas/MinimumTlsVersionOptionsTls"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsTls"
description: TLS settings (client side)
AuthenticationType:
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
description: Disabled
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: Password
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsSasl"
credentialsSecret:
type: string
title: Credentials secret
description: Select or create a secret that references your credentials
mechanism:
$ref: "#/components/schemas/SaslMechanismOptionsSasl"
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
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
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:
$ref: "#/components/schemas/OauthParamConfInputKafka"
saslExtensions:
type: array
title: Add SASL Extension Fields
description: Additional SASL extension fields, such as Confluent's
logicalCluster or identityPoolId
items:
$ref: "#/components/schemas/SaslExtensionConfInputKafka"
__template_mechanism:
type: string
description: Binds 'mechanism' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'mechanism' at runtime.
__template_keytabLocation:
type: string
description: Binds 'keytabLocation' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'keytabLocation' at
runtime.
__template_principal:
type: string
description: Binds 'principal' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'principal' at runtime.
__template_brokerServiceClass:
type: string
description: Binds 'brokerServiceClass' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'brokerServiceClass' at runtime.
__template_tokenUrl:
type: string
description: Binds 'tokenUrl' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tokenUrl' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
TlsSettingsServerSideType:
type: object
title: TLS settings (server side)
properties:
disabled:
type: boolean
title: Disabled
description: If true, TLS is disabled on this connection.
requestCert:
type: boolean
title: Authenticate client (mutual auth)
description: Require clients to present their certificates. Used to perform
client authentication using SSL certs.
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)
commonNameRegex:
type: string
title: Common name
description: Regex matching allowable common names in peer certificates' subject
attribute
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:
$ref: "#/components/schemas/MinimumTlsVersionOptionsTls"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsTls"
description: TLS settings (server side)
AuthTokensExtConfInputHttp:
type: object
required:
- token
properties:
token:
type: string
title: Token
description: "Shared secret to be provided by any client (Authorization: )"
description:
type: string
title: Description
description: Description
metadata:
type: array
title: Fields
description: Fields to add to events referencing this token
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
RetryRulesType:
type: object
required:
- type
properties:
type:
$ref: "#/components/schemas/RetryTypeOptionsHealthCheckCollectorConfRetryRules"
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
limit:
type: number
title: Retry limit
description: The maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
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
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
items:
type: number
minimum: 100
maximum: 599
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.
retryConnectTimeout:
type: boolean
title: Retry connection timeout
description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
error occurs
retryConnectReset:
type: boolean
title: Retry connection reset
description: Retry request when a connection reset (ECONNRESET) error occurs
DiskSpoolingType:
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.
timeWindow:
type: string
title: Bucket time span
description: Time period for grouping spooled events. Default is 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))?$
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]$
compress:
$ref: "#/components/schemas/CompressionOptionsPersistence"
description: Disk Spooling
RetryRulesTypeCodesEnableHeader:
type: object
required:
- type
properties:
type:
$ref: "#/components/schemas/RetryTypeOptionsHealthCheckCollectorConfRetryRules"
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
limit:
type: number
title: Retry limit
description: The maximum number of times to retry a failed HTTP request
minimum: 0
maximum: 20
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
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
items:
type: number
minimum: 100
maximum: 599
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.
retryConnectTimeout:
type: boolean
title: Retry connection timeout
description: Make a single retry attempt when a connection timeout (ETIMEDOUT)
error occurs
retryConnectReset:
type: boolean
title: Retry connection reset
description: Retry request when a connection reset (ECONNRESET) error occurs
AuthenticationTypeUse:
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
description: Disabled
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsSaslManualSecret"
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:
$ref: "#/components/schemas/SaslMechanismOptionsSaslOauthbearerPlain"
username:
type: string
title: Username
description: The username for authentication. For Event Hubs, this should always
be $ConnectionString.
clientSecretAuthType:
$ref: "#/components/schemas/AuthenticationMethodOptionsSaslCertificateManual"
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:
$ref: "#/components/schemas/MicrosoftEntraIdAuthenticationEndpointOptionsSasl"
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
__template_password:
type: string
description: Binds 'password' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'password' at runtime.
__template_mechanism:
type: string
description: Binds 'mechanism' to a variable for dynamic value resolution. Set
to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'mechanism' at runtime.
__template_oauthEndpoint:
type: string
description: Binds 'oauthEndpoint' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'oauthEndpoint' at runtime.
__template_clientId:
type: string
description: Binds 'clientId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'clientId' at runtime.
__template_tenantId:
type: string
description: Binds 'tenantId' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'tenantId' at runtime.
__template_scope:
type: string
description: Binds 'scope' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'scope' at runtime.
ProcessType:
type: object
properties:
sets:
type: array
title: Process sets
description: Configure sets to collect process metrics
items:
$ref: "#/components/schemas/SetConfInputSystemMetrics"
GpuType:
type: object
properties:
mode:
$ref: "#/components/schemas/ModeOptionsGpu"
perGpu:
type: boolean
title: Per-GPU metrics
description: Generate metrics for each GPU
detail:
type: boolean
title: Detailed metrics
description: Generate full GPU metrics
AuthTokenConfInputCloudflareHec:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthTokensItemsSecret"
tokenSecret:
type: string
title: Token secret (text secret)
description: Select or create a stored text secret
token:
type: string
title: Token
description: "Shared secret to be provided by any client (Authorization: )"
enabled:
type: boolean
title: Enable token
description: Enable token
description:
type: string
title: Description
description: 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:
$ref: "#/components/schemas/MetadataConfInputCollection"
RunnableJobCollectionScheduleRunType:
type: object
required:
- mode
properties:
rescheduleDroppedTasks:
type: boolean
title: Reschedule tasks
description: Reschedule tasks that failed with non-fatal errors
maxTaskReschedule:
type: number
title: Task reschedule limit
description: Maximum number of times a task can be rescheduled
minimum: 1
logLevel:
$ref: "#/components/schemas/LogLevelOptionsRunnableJobCollectionScheduleRun"
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]?$
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.
timeRangeType:
type: string
title: Time range
description: Time range
earliest:
type:
- number
- string
title: Earliest
description: Earliest time to collect data for the selected timezone
latest:
type:
- number
- string
title: Latest
description: Latest time to collect data for the selected timezone
timestampTimezone: {}
timeWarning:
$ref: "#/components/schemas/BrokenEventProcessor"
expression:
type: string
title: Filter
description: A filter for tokens in the provided collect path and/or the events
being collected
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.
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.
pattern: ^((\d*\.?\d+)((KB|MB|GB|TB|PB|EB|ZB|YB|kb|mb|gb|tb|pb|eb|zb|yb){1}))$
InputTypeRunnableJobCollection:
type: object
properties:
type:
$ref: "#/components/schemas/TypeOptionsRunnableJobCollectionInput"
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
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.
preprocess:
$ref: "#/components/schemas/PreprocessType"
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])?$
metadata:
type: array
title: Fields
description: Fields to add to events from this input
items:
$ref: "#/components/schemas/MetadataConfInputCollection"
pipeline:
type: string
title: Pipeline
description: Pipeline to process results
output:
type: string
title: Destination
description: Destination to send results to
ExecutorTypeRunnableJobExecutor:
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
conf:
$ref: "#/components/schemas/ExecutorSpecificSettingsTypeRunnableJobExecutorExec\
utor"
StatusType:
type: object
properties:
error:
$ref: "#/components/schemas/StatusError"
description: Error information, if applicable.
health:
$ref: "#/components/schemas/HealthOptionsStatus"
metrics:
type: object
additionalProperties: true
description: Metrics data for the Source or Destination.
pq:
$ref: "#/components/schemas/WorkerPQStatus"
description: Persistent queue status information (if persistent queue is enabled).
timestamp:
type: integer
description: Timestamp (in Unix time) when the status was last updated.
useStatusFromLB:
type: boolean
description: Set to prefer status from the LB process, not from the worker
process.
description: "Runtime status: health, metrics, and optional persistent-queue
info. Fields may be absent when data is unavailable."
TlsSettingsClientSideTypeCaPathCertPathExtended:
type: object
title: TLS settings (client side)
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
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:
$ref: "#/components/schemas/MinimumTlsVersionOptionsTls"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsTls"
description: TLS settings (client side)
HostConfOutputSyslog:
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:
$ref: "#/components/schemas/TlsOptionsHostsItems"
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
__template_host:
type: string
description: Binds 'host' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'host' at runtime.
__template_port:
type: string
description: Binds 'port' to a variable for dynamic value resolution. Set to
variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'port' at runtime.
TlsSettingsClientSideTypeExtended:
type: object
title: TLS settings (client side)
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
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.
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:
$ref: "#/components/schemas/MinimumTlsVersionOptionsTls"
maxVersion:
$ref: "#/components/schemas/MaximumTlsVersionOptionsTls"
description: TLS settings (client side)
AuthTypeTemplatemanualApiKeyAuthType:
type: object
required:
- disabled
properties:
disabled:
type: boolean
title: Authentication Disabled
description: Authentication Disabled
username:
type: string
title: Username
description: Username
password:
type: string
title: Password
description: Password
authType:
$ref: "#/components/schemas/AuthenticationMethodOptionsAuthManualManualApiKey"
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
__template_manualAPIKey:
type: string
description: Binds 'manualAPIKey' to a variable for dynamic value resolution.
Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID
(group-scoped). Variable value overrides 'manualAPIKey' at runtime.
PrometheusAuthType:
type: object
properties:
authType:
$ref: "#/components/schemas/AuthenticationTypeOptionsPrometheusAuthBasicCredent\
ialsSecret"
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:
:"
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
ApiTypeSystemSettingsConf:
type: object
properties:
baseUrl:
type: string
description: Base URL for the API server. Used when the server is behind a
reverse proxy.
disableApiCache:
type: boolean
description: If true, disable the API response cache. Otherwise,
false.
disabled:
type: boolean
description: If true, the API server is disabled. Otherwise,
false.
headers:
type: object
additionalProperties:
type: string
description: Custom HTTP response headers to include in every API response.
host:
type: string
description: Hostname or IP address the API server listens on.
idleSessionTTL:
type: integer
description: Idle session timeout in seconds. Sessions are invalidated after the
specified seconds of inactivity.
listenOnPort:
type: boolean
description: If true, bind to the configured port as the server
listen port. Otherwise, false.
loginRateLimit:
type: string
description: Rate limit for login attempts. Value is a string such as
100/min.
port:
type: integer
description: Port number the API server listens on.
protocol:
type: string
description: "API protocol: http or https."
scripts:
type: boolean
description: If true, enable JavaScript scripting support in the
API. Otherwise, false.
sensitiveFields:
type: array
items:
type: string
description: List of field names whose values are redacted in API responses and
logs.
ssl:
$ref: "#/components/schemas/SslTypeSystemSettingsConfApi"
ssoRateLimit:
type: string
description: Rate limit for SSO authentication attempts. Value is a string such
as 100/min.
workerRemoteAccess:
type: boolean
description: If true, enable remote access (teleporting) to Worker
Processes via the API. Otherwise, false.
required:
- disabled
- host
- port
description: API server configuration for the Cribl instance.
SupportTypeSystemSettingsConf:
type: object
properties:
featureFlagOverrides:
type: array
items:
$ref: "#/components/schemas/FeatureFlagOverrideConfSystemSettingsConf"
description: List of feature flag overrides applied to this Cribl instance.
logFileMaxFiles:
type: integer
description: Maximum number of log files to retain before rotating.
logFileMaxSize:
type: string
description: Maximum size of each log file. Value is a numeral and unit such as
10 MB.
description: Support and diagnostics settings.
SystemTypeSystemSettingsConf:
type: object
properties:
intercom:
type: boolean
description: If true, enable Intercom integration for in-product
messaging. Otherwise, false.
upgrade:
$ref: "#/components/schemas/UpgradeOptionsSystemSettingsConfSystem"
required:
- intercom
- upgrade
description: System-level operational settings for the Cribl instance.
KafkaSchemaRegistryAuthenticationType:
type: object
title: Kafka Schema Registry Authentication
required:
- disabled
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
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."
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a Schema Registry connection to complete
successfully
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
minimum: 1000
maximum: 60000
maxRetries:
type: number
title: Retry limit
description: Maximum number of times to try fetching schemas from the Schema
Registry
minimum: 0
maximum: 100
auth:
$ref: "#/components/schemas/AuthType"
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
__template_schemaRegistryURL:
type: string
description: Binds 'schemaRegistryURL' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'schemaRegistryURL' at runtime.
description: Kafka Schema Registry Authentication
RunSettingsTypeRunnableJobCollectionSchedule:
type: object
title: Run settings
allOf:
- $ref: "#/components/schemas/RunnableJobCollectionTypeCollectionConstraint"
- $ref: "#/components/schemas/RunnableJobCollectionScheduleRunType"
description: Run settings
KafkaSchemaRegistryAuthenticationTypeTemplateschemaRegistryUrlAuth:
type: object
title: Kafka Schema Registry Authentication
required:
- disabled
properties:
disabled:
type: boolean
title: Disabled
description: Disabled
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."
connectionTimeout:
type: number
title: Connection timeout (ms)
description: Maximum time to wait for a Schema Registry connection to complete
successfully
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
minimum: 1000
maximum: 60000
maxRetries:
type: number
title: Retry limit
description: Maximum number of times to try fetching schemas from the Schema
Registry
minimum: 0
maximum: 100
auth:
$ref: "#/components/schemas/AuthType"
tls:
$ref: "#/components/schemas/TlsSettingsClientSideTypeCaPathCertPath"
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.
__template_schemaRegistryURL:
type: string
description: Binds 'schemaRegistryURL' to a variable for dynamic value
resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.'
prefixed ID (group-scoped). Variable value overrides
'schemaRegistryURL' at runtime.
description: Kafka Schema Registry Authentication
RunSettingsTypeSavedJobResponseCollectionSchedule:
type: object
title: Run settings
allOf:
- $ref: "#/components/schemas/RunnableJobCollectionTypeCollectionConstraint"
- $ref: "#/components/schemas/RunnableJobCollectionScheduleRunType"
description: Run settings
ScheduleTypeRunnableJobCollection:
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
resumeMissed:
type: boolean
title: Resume missed runs
description: If Stream Leader (or single instance) restarts, run all missed jobs
according to their original schedules
cronSchedule:
type: string
title: Cron schedule
description: A cron schedule on which to run this job
maxConcurrentRuns:
type: number
title: Concurrent run limit
description: The maximum number of instances of this scheduled job that may be
running at any time
minimum: 1
run:
$ref: "#/components/schemas/RunSettingsTypeRunnableJobCollectionSchedule"
ScheduleTypeSavedJobResponseCollection:
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
resumeMissed:
type: boolean
title: Resume missed runs
description: If Stream Leader (or single instance) restarts, run all missed jobs
according to their original schedules
cronSchedule:
type: string
title: Cron schedule
description: A cron schedule on which to run this job
maxConcurrentRuns:
type: number
title: Concurrent run limit
description: The maximum number of instances of this scheduled job that may be
running at any time
minimum: 1
run:
$ref: "#/components/schemas/RunSettingsTypeSavedJobResponseCollectionSchedule"
examples:
DatabaseConnectionResponseExamplesMySQLDatabaseConnection:
summary: Get a Database Connection
description: Example response for getting a Database Connection with a censored
connection string.
value:
count: 1
items:
- id: mysql-prod-db
description: Production MySQL database for customer data
databaseType: mysql
authType: connectionString
connectionString: "*****"
connectionTimeout: 10000
tags: production,mysql,customer-data
DatabaseConnectionBadRequestResponseExamplesInvalidDatabaseConnectionRequest:
summary: Return a validation error for a Database Connection request
description: Example response for returning a validation error for a Database
Connection create or update request.
value:
status: error
message: must have required property 'id'
DatabaseConnectionExamplesMySQLWithConnectionString:
summary: Create a MySQL Database Connection with a connection string
description: Example request body for creating a MySQL Database Connection using
a connection string with embedded credentials.
value:
id: mysql-prod-db
description: Production MySQL database for customer data
databaseType: mysql
authType: connectionString
connectionString: mysql://yourUsername:yourPassword@mysql.example.com:3306/production?ssl=true
connectionTimeout: 10000
tags: production,mysql,customer-data
DatabaseConnectionExamplesMySQLWithSecret:
summary: Create a MySQL Database Connection with a secret
description: Example request body for creating a MySQL Database Connection using
a stored text secret for the connection string.
value:
id: mysql-analytics-db
description: Analytics MySQL database
databaseType: mysql
authType: secret
textSecret: mysql-analytics-connection
connectionTimeout: 15000
tags: analytics,mysql
DatabaseConnectionExamplesPostgreSQLWithConnectionString:
summary: Create a PostgreSQL Database Connection with a connection string
description: Example request body for creating a PostgreSQL Database Connection
using a connection string.
value:
id: postgres-warehouse
description: Data warehouse PostgreSQL database
databaseType: postgres
authType: connectionString
connectionString: postgresql://yourUsername:yourPassword@postgres.example.com:5432/warehouse?sslmode=require
connectionTimeout: 15000
tags: warehouse,postgres,reporting
DatabaseConnectionExamplesPostgreSQLWithSecret:
summary: Create a PostgreSQL Database Connection with a secret
description: Example request body for creating a PostgreSQL Database Connection
using a stored text secret.
value:
id: postgres-logs
description: Logs PostgreSQL database
databaseType: postgres
authType: secret
textSecret: postgres-logs-connection
connectionTimeout: 10000
tags: logs,postgres
DatabaseConnectionExamplesSQLServerWithConnectionString:
summary: Create a SQL Server Database Connection with a connection string
description: Example request body for creating a SQL Server Database Connection
using a connection string.
value:
id: sqlserver-erp
description: ERP SQL Server database
databaseType: sqlserver
authType: connectionString
connectionString: Server=sqlserver.example.com;Database=ERP;User
Id=yourUsername;Password=yourPassword;Encrypt=true
connectionTimeout: 15000
requestTimeout: 30000
tags: erp,sqlserver,finance
DatabaseConnectionExamplesSQLServerWithSecret:
summary: Create a SQL Server Database Connection with a secret
description: Example request body for creating a SQL Server Database Connection
using a stored text secret.
value:
id: sqlserver-crm
description: CRM SQL Server database
databaseType: sqlserver
authType: secret
textSecret: sqlserver-crm-connection
connectionTimeout: 15000
requestTimeout: 15000
tags: crm,sqlserver,sales
DatabaseConnectionExamplesSQLServerWithConfigObject:
summary: Create a SQL Server Database Connection with a config object
description: Example request body for creating a SQL Server Database Connection
using a JSON configuration object for advanced settings.
value:
id: sqlserver-reporting
description: Reporting SQL Server database with custom config
databaseType: sqlserver
authType: configObj
configObj: '{"server":"sqlserver.example.com","database":"Reporting","user":"yourUsername","password":"yourPassword","options":{"encrypt":true,"trustServerCertificate":false,"connectTimeout":20000}}'
requestTimeout: 60000
tags: reporting,sqlserver,analytics
DatabaseConnectionExamplesOracleWithConnectionString:
summary: Create an Oracle Database Connection with a connection string
description: Example request body for creating an Oracle Database Connection
using Easy Connect format with credentials.
value:
id: oracle-erp
description: Oracle ERP database
databaseType: oracle
authType: connectionString
connectionString: oracle.example.com:1521/ORCL
user: yourUsername
password: yourPassword
connectionTimeout: 15000
tags: erp,oracle,finance
DatabaseConnectionExamplesOracleWithSecret:
summary: Create an Oracle Database Connection with a secret
description: Example request body for creating an Oracle Database Connection
using a stored text secret for the connection string.
value:
id: oracle-warehouse
description: Oracle data warehouse
databaseType: oracle
authType: secret
textSecret: oracle-warehouse-connection
user: yourUsername
password: yourPassword
connectionTimeout: 20000
tags: warehouse,oracle,reporting
DatabaseConnectionExamplesOracleWithCredentialsSecrets:
summary: Create an Oracle Database Connection with credentials secrets
description: Example request body for creating an Oracle Database Connection
using separate secrets for credentials and the connection string.
value:
id: oracle-secure-db
description: High-security Oracle database with credential secrets
databaseType: oracle
authType: secrets
credsSecrets: oracle-secure-credentials
textSecret: oracle-secure-connection
connectionTimeout: 15000
tags: secure,oracle,sensitive-data
DatabaseConnectionExamplesOracleWithMutualTLS:
summary: Oracle with mutual TLS (mTLS)
description: Create an Oracle database connection that authenticates with a
client certificate over TCPS. The certificate referenced by
`tls.certificateName` must already exist in the system certificates
store and contain the client cert, private key, and (for self-signed
server chains) the CA cert pinned by the customer.
value:
id: oracle-mtls-db
description: Oracle database reached over TCPS with mutual TLS
databaseType: oracle
authType: connectionString
connectionString: tcps://oracle.example.com:2484/ORCL
user: erp_user
password: Oracle_Pass456!
connectionTimeout: 15000
tls:
disabled: false
rejectUnauthorized: true
certificateName: oracle-client-cert
tags: erp,oracle,mtls,production
DatabaseConnectionNotFoundResponseExamplesDatabaseConnectionNotFound:
summary: Return a not found error for a Database Connection
description: Example response for returning a not found error when getting a
Database Connection by id.
value:
status: error
message: Database Connection not found
DatabaseConnectionListResponseExamplesDatabaseConnectionList:
summary: List Database Connections
description: Example response for listing Database Connections in the
items array.
value:
count: 2
items:
- id: mysql-prod-db
description: Production MySQL database for customer data
databaseType: mysql
authType: connectionString
connectionString: "*****"
connectionTimeout: 10000
tags: production,mysql,customer-data
- id: postgres-warehouse
description: Data warehouse PostgreSQL database
databaseType: postgres
authType: secret
textSecret: postgres-warehouse-connection
connectionTimeout: 15000
tags: warehouse,postgres,reporting
offset: 0
limit: 20
UpdateDatabaseConnectionExamplesUpdateMySQLDatabaseConnectionWithConnectionString:
summary: Update a MySQL Database Connection with a connection string
description: Example request body for updating a MySQL Database Connection using
a connection string with embedded credentials.
The request body
must include a complete representation of the Database Connection that
you want to update. This endpoint does not support partial updates.
value:
id: mysql-prod-db
description: Production MySQL database for customer data
databaseType: mysql
authType: connectionString
connectionString: mysql://yourUsername:yourPassword@mysql.example.com:3306/production?ssl=true
connectionTimeout: 10000
tags: production,mysql,customer-data
UpdateDatabaseConnectionExamplesUpdateMySQLDatabaseConnectionWithSecret:
summary: Update a MySQL Database Connection with a secret
description: Example request body for updating a MySQL Database Connection using
a stored text secret for the connection string.
The request
body must include a complete representation of the Database Connection
that you want to update. This endpoint does not support partial updates.
value:
id: mysql-analytics-db
description: Analytics MySQL database
databaseType: mysql
authType: secret
textSecret: mysql-analytics-connection
connectionTimeout: 15000
tags: analytics,mysql
UpdateDatabaseConnectionExamplesUpdatePostgreSQLDatabaseConnectionWithConnectionString:
summary: Update a PostgreSQL Database Connection with a connection string
description: Example request body for updating a PostgreSQL Database Connection
using a connection string.
The request body must include a
complete representation of the Database Connection that you want to
update. This endpoint does not support partial updates.
value:
id: postgres-warehouse
description: Data warehouse PostgreSQL database
databaseType: postgres
authType: connectionString
connectionString: postgresql://yourUsername:yourPassword@postgres.example.com:5432/warehouse?sslmode=require
connectionTimeout: 15000
tags: warehouse,postgres,reporting
UpdateDatabaseConnectionExamplesUpdatePostgreSQLDatabaseConnectionWithSecret:
summary: Update a PostgreSQL Database Connection with a secret
description: Example request body for updating a PostgreSQL Database Connection
using a stored text secret.
The request body must include a
complete representation of the Database Connection that you want to
update. This endpoint does not support partial updates.
value:
id: postgres-logs
description: Logs PostgreSQL database
databaseType: postgres
authType: secret
textSecret: postgres-logs-connection
connectionTimeout: 10000
tags: logs,postgres
UpdateDatabaseConnectionExamplesUpdateSQLServerDatabaseConnectionWithConnectionString:
summary: Update a SQL Server Database Connection with a connection string
description: Example request body for updating a SQL Server Database Connection
using a connection string.
The request body must include a
complete representation of the Database Connection that you want to
update. This endpoint does not support partial updates.
value:
id: sqlserver-erp
description: ERP SQL Server database
databaseType: sqlserver
authType: connectionString
connectionString: Server=sqlserver.example.com;Database=ERP;User
Id=yourUsername;Password=yourPassword;Encrypt=true
connectionTimeout: 15000
requestTimeout: 30000
tags: erp,sqlserver,finance
UpdateDatabaseConnectionExamplesUpdateSQLServerDatabaseConnectionWithSecret:
summary: Update a SQL Server Database Connection with a secret
description: Example request body for updating a SQL Server Database Connection
using a stored text secret.
The request body must include a
complete representation of the Database Connection that you want to
update. This endpoint does not support partial updates.
value:
id: sqlserver-crm
description: CRM SQL Server database
databaseType: sqlserver
authType: secret
textSecret: sqlserver-crm-connection
connectionTimeout: 15000
requestTimeout: 15000
tags: crm,sqlserver,sales
UpdateDatabaseConnectionExamplesUpdateSQLServerDatabaseConnectionWithConfigObject:
summary: Update a SQL Server Database Connection with a config object
description: Example request body for updating a SQL Server Database Connection
using a JSON configuration object for advanced settings.
The
request body must include a complete representation of the Database
Connection that you want to update. This endpoint does not support
partial updates.
value:
id: sqlserver-reporting
description: Reporting SQL Server database with custom config
databaseType: sqlserver
authType: configObj
configObj: '{"server":"sqlserver.example.com","database":"Reporting","user":"yourUsername","password":"yourPassword","options":{"encrypt":true,"trustServerCertificate":false,"connectTimeout":20000}}'
requestTimeout: 60000
tags: reporting,sqlserver,analytics
UpdateDatabaseConnectionExamplesUpdateOracleDatabaseConnectionWithConnectionString:
summary: Update an Oracle Database Connection with a connection string
description: Example request body for updating an Oracle Database Connection
using Easy Connect format with credentials.
The request body
must include a complete representation of the Database Connection that
you want to update. This endpoint does not support partial updates.
value:
id: oracle-erp
description: Oracle ERP database
databaseType: oracle
authType: connectionString
connectionString: oracle.example.com:1521/ORCL
user: yourUsername
password: yourPassword
connectionTimeout: 15000
tags: erp,oracle,finance
UpdateDatabaseConnectionExamplesUpdateOracleDatabaseConnectionWithSecret:
summary: Update an Oracle Database Connection with a secret
description: Example request body for updating an Oracle Database Connection
using a stored text secret for the connection string.
The
request body must include a complete representation of the Database
Connection that you want to update. This endpoint does not support
partial updates.
value:
id: oracle-warehouse
description: Oracle data warehouse
databaseType: oracle
authType: secret
textSecret: oracle-warehouse-connection
user: yourUsername
password: yourPassword
connectionTimeout: 20000
tags: warehouse,oracle,reporting
UpdateDatabaseConnectionExamplesUpdateOracleDatabaseConnectionWithCredentialsSecrets:
summary: Update an Oracle Database Connection with credentials secrets
description: Example request body for updating an Oracle Database Connection
using separate secrets for credentials and the connection
string.
The request body must include a complete representation
of the Database Connection that you want to update. This endpoint does
not support partial updates.
value:
id: oracle-secure-db
description: High-security Oracle database with credential secrets
databaseType: oracle
authType: secrets
credsSecrets: oracle-secure-credentials
textSecret: oracle-secure-connection
connectionTimeout: 15000
tags: secure,oracle,sensitive-data
FunctionResponseExamplesEvalFunction:
summary: Get the Eval Function
description: Example response for getting the Eval Function.
value:
count: 1
items:
- id: eval
name: Eval
version: "0.4"
group: Standard
__filename: eval/index.js
loadTime: 0
modTime: 0
uischema: {}
description: Adds, removes, or updates event fields using JavaScript
expressions.
category: fields
tags: eval,fields
FunctionResponseExamplesDropFunction:
summary: Get the Drop Function
description: Example response for getting the Drop Function, which removes
events that match a specified filter expression.
value:
count: 1
items:
- id: drop
name: Drop
version: "0.1"
group: Standard
__filename: drop/index.js
loadTime: 0
modTime: 0
uischema: {}
description: Removes events that match the specified filter expression.
category: filtering
tags: drop,filter
FunctionListResponseExamplesFunctionList:
summary: List all Functions
description: Example response for listing all Functions.
value:
count: 2
items:
- id: eval
name: Eval
version: "0.4"
group: Standard
__filename: eval/index.js
loadTime: 0
modTime: 0
uischema: {}
description: Adds, removes, or updates event fields using JavaScript
expressions.
category: fields
tags: eval,fields
- id: drop
name: Drop
version: "0.1"
group: Standard
__filename: drop/index.js
loadTime: 0
modTime: 0
uischema: {}
description: Removes events that match the specified filter expression.
category: filtering
tags: drop,filter
offset: 0
limit: 20
HecTokenResponseExamplesSplunkHecSource:
summary: Splunk HEC Source with HEC tokens
description: Example response for adding or updating an HEC token on a Splunk
HEC Source.
value:
count: 1
items:
- id: splunk-hec-source
type: splunk_hec
host: 0.0.0.0
port: 8088
splunkHecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
authTokens:
- token: "12345678901"
enabled: true
metadata:
- name: fieldX
value: valueX
HecTokenExamplesHecToken:
summary: Basic HEC token
description: Example request body for adding an HEC token with metadata to a
Splunk HEC Source.
value:
enabled: true
metadata:
- name: fieldX
value: valueX
token: "12345678901"
HecTokenExamplesHecTokenWithIndexAccess:
summary: HEC token with allowed indexes
description: Example request body for adding an HEC token with index-level
access control.
value:
enabled: true
allowedIndexesAtToken:
- myIndex6
token: "12345678901"
ClearPQResponseExamplesClearPQJob:
summary: Clear PQ job ID
description: Example response for clearing the persistent queue. Returns the job
ID of the background clear operation.
value:
count: 1
items:
- "1727123456.1234567890"
PQStatusResponseExamplesCompletedJob:
summary: Completed clear-PQ job
description: Example response for retrieving the status of a completed clear-PQ job.
value:
count: 1
items:
- id: "1727123456.1234567890"
type: collection
status:
state: 5
stats: {}
args:
type: collection
collector:
type: filesystem
conf:
path: /var/log/*.log
run:
mode: run
type: adhoc
InputResponseExamplesSyslogSource:
summary: Syslog Source response
description: Example response for getting or updating a Syslog Source.
value:
items:
- id: syslog-source
type: syslog
host: 0.0.0.0
udpPort: 514
sendToRoutes: true
pqEnabled: false
count: 1
InputResponseExamplesSyslogWithPQSource:
summary: Syslog Source with PQ response
description: Example response for getting or updating a Syslog Source with
persistent queue and drop-on-backpressure configured.
value:
items:
- id: syslog-pq-source
type: syslog
host: 0.0.0.0
udpPort: 514
sendToRoutes: true
pqEnabled: true
pq:
mode: always
maxBufferSizeBytes: 1MB
maxFileSize: 10MB
maxSize: 5GB
path: $CRIBL_HOME/state/queues
compress: none
onBackpressure: drop
count: 1
InputResponseExamplesSplunkHecSource:
summary: Splunk HEC Source response
description: Example response for getting or updating a Splunk HEC Source.
value:
items:
- id: splunk-hec-source
type: splunk_hec
host: 0.0.0.0
port: 8088
splunkHecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
count: 1
InputResponseExamplesHttpSource:
summary: HTTP Source response
description: Example response for getting or updating an HTTP Source.
value:
items:
- id: http-source
type: http
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
count: 1
InputCreateExamplesAnthropicCompliance:
summary: Anthropic Compliance
value:
id: anthropic-compliance-source
type: anthropic_compliance
textSecret: anthropic-api-key-secret
contentConfig:
- contentType: activities
contentDescription: Compliance Activities
enabled: true
cronSchedule: "*/5 * * * *"
earliest: -7d@d
latest: now
jobTimeout: "300"
stateTracking: true
stateUpdateExpression: "__timestampExtracted !== false && {latestTime:
(state.latestTime || 0) > _time ? state.latestTime : _time}"
stateMergeExpression: "prevState.latestTime > newState.latestTime ? prevState : newState"
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Anthropic Compliance Source.
InputCreateExamplesAppleUnifiedLogs:
summary: Apple Unified Logs
value:
id: apple-unified-logs-source
type: apple_unified_logs
predicate: subsystem == "com.apple.security"
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Apple Unified Logs Source.
InputCreateExamplesAppscope:
summary: AppScope
value:
id: appscope-source
type: appscope
host: 0.0.0.0
port: 9109
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a AppScope Source.
InputCreateExamplesAzureBlob:
summary: Azure Blob
value:
id: azure-blob-source
type: azure_blob
queueName: azure-blob-queue
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Azure Blob Source.
InputCreateExamplesCloudflareHec:
summary: Cloudflare HEC
value:
id: cloudflare-hec-source
type: cloudflare_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Cloudflare HEC Source.
InputCreateExamplesConfluentCloud:
summary: Confluent Cloud
value:
id: confluent-cloud-source
type: confluent_cloud
brokers:
- pkc-xxxxx.us-east-1.aws.confluent.cloud:9092
topics:
- logs
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Confluent Cloud Source.
InputCreateExamplesCollection:
summary: Collection
value:
id: collection-source
type: collection
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Collection Source.
InputCreateExamplesCriblHttp:
summary: Cribl HTTP
value:
id: cribl-http-source
type: cribl_http
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Cribl HTTP Source.
InputCreateExamplesCriblLakeHttp:
summary: Cribl Lake HTTP
value:
id: cribl-lake-http-source
type: cribl_lake_http
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Cribl Lake HTTP Source.
InputCreateExamplesCriblTcp:
summary: Cribl TCP
value:
id: cribl-tcp-source
type: cribl_tcp
host: 0.0.0.0
port: 10090
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Cribl TCP Source.
InputCreateExamplesCrowdstrike:
summary: CrowdStrike FDR
value:
id: crowdstrike-source
type: crowdstrike
queueName: crowdstrike-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a CrowdStrike FDR Source.
InputCreateExamplesDatadogAgent:
summary: Datadog Agent
value:
id: datadog-agent-source
type: datadog_agent
host: 0.0.0.0
port: 8126
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Datadog Agent Source.
InputCreateExamplesDatagen:
summary: Datagen
value:
id: datagen-source
type: datagen
samples:
- sample: sample.json
eventsPerSec: 10
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Datagen Source.
InputCreateExamplesEdgePrometheus:
summary: Edge Prometheus
value:
id: edge-prometheus-source
type: edge_prometheus
interval: 60
discoveryType: static
targets:
- host: localhost
scrapeProtocol: http
scrapePort: 9090
scrapePath: /metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Edge Prometheus Source.
InputCreateExamplesElastic:
summary: Elasticsearch
value:
id: elastic-source
type: elastic
host: localhost
port: 9200
elasticAPI: /
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Elasticsearch Source.
InputCreateExamplesEventhub:
summary: Event Hubs
value:
id: eventhub-source
type: eventhub
brokers:
- myeventhub.servicebus.windows.net:9093
topics:
- logs
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Event Hubs Source.
InputCreateExamplesEventhubAmqp:
summary: Event Hubs AMQP
value:
id: eventhub-amqp-source
type: eventhub_amqp
eventHubName: my-event-hub
consumerGroup: $Default
checkpointing:
blobStore:
containerName: my-container
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Event Hubs AMQP Source.
InputCreateExamplesExec:
summary: Exec
value:
id: exec-source
type: exec
command: echo "Hello World"
interval: 60
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Exec Source.
InputCreateExamplesFile:
summary: File Monitor
value:
id: file-source
type: file
mode: manual
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a File Monitor Source.
InputCreateExamplesFirehose:
summary: Firehose
value:
id: firehose-source
type: firehose
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Firehose Source.
InputCreateExamplesGrafana:
summary: Grafana
value:
id: grafana-source
type: grafana
host: 0.0.0.0
port: 10080
prometheusAPI: /api/prom/push
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Grafana Source.
InputCreateExamplesGooglePubsub:
summary: Google Pub/Sub
value:
id: google-pubsub-source
type: google_pubsub
subscriptionName: my-subscription
topicName: my-topic
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Google Pub/Sub Source.
InputCreateExamplesHttp:
summary: HTTP
value:
id: http-source
type: http
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a HTTP Source.
InputCreateExamplesHttpRaw:
summary: HTTP Raw
value:
id: http-raw-source
type: http_raw
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a HTTP Raw Source.
InputCreateExamplesJournalFiles:
summary: Journal Files
value:
id: journal-files-source
type: journal_files
path: /var/log/journal
journals:
- system
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Journal Files Source.
InputCreateExamplesKafka:
summary: Kafka
value:
id: kafka-source
type: kafka
brokers:
- localhost:9092
topics:
- logs
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Kafka Source.
InputCreateExamplesKinesis:
summary: Kinesis
value:
id: kinesis-source
type: kinesis
streamName: my-stream
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Kinesis Source.
InputCreateExamplesKubeEvents:
summary: Kubernetes Events
value:
id: kube-events-source
type: kube_events
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Kubernetes Events Source.
InputCreateExamplesKubeLogs:
summary: Kubernetes Logs
value:
id: kube-logs-source
type: kube_logs
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Kubernetes Logs Source.
InputCreateExamplesKubeMetrics:
summary: Kubernetes Metrics
value:
id: kube-metrics-source
type: kube_metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Kubernetes Metrics Source.
InputCreateExamplesLoki:
summary: Loki
value:
id: loki-source
type: loki
host: 0.0.0.0
port: 10080
lokiAPI: /loki/api/v1/push
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Loki Source.
InputCreateExamplesMetrics:
summary: Metrics
value:
id: metrics-source
type: metrics
host: 0.0.0.0
udpPort: 8125
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Metrics Source.
InputCreateExamplesModelDrivenTelemetry:
summary: Model Driven Telemetry
value:
id: mdt-source
type: model_driven_telemetry
host: 0.0.0.0
port: 57000
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Model Driven Telemetry Source.
InputCreateExamplesMsk:
summary: MSK
value:
id: msk-source
type: msk
brokers:
- b-1.example.xxxxx.c2.kafka.us-east-1.amazonaws.com:9092
topics:
- logs
region: us-east-1
awsAuthenticationMethod: auto
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a MSK Source.
InputCreateExamplesNetflow:
summary: Netflow
value:
id: netflow-source
type: netflow
host: 0.0.0.0
port: 2055
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Netflow Source.
InputCreateExamplesOffice365Mgmt:
summary: Microsoft 365 Management Activity
value:
id: office365-mgmt-source
type: office365_mgmt
tenantId: tenant-id
appId: app-id
planType: enterprise_gcc
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Microsoft 365 Management
Activity Source.
InputCreateExamplesMicrosoftGraph:
summary: Microsoft Graph
value:
id: microsoft-graph-source
type: microsoft_graph
url: https://graph.microsoft.com/v1.0/admin/exchange/tracing/messageTraces
interval: 15
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Microsoft Graph Source.
InputCreateExamplesOffice365MsgTrace:
summary: Microsoft 365 Message Trace
value:
id: office365-msg-trace-source
type: office365_msg_trace
url: https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MessageTrace
interval: 15
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Microsoft 365 Message Trace Source.
InputCreateExamplesOffice365Service:
summary: Microsoft 365 Services
value:
id: office365-service-source
type: office365_service
tenantId: tenant-id
appId: app-id
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Microsoft 365 Services Source.
InputCreateExamplesOkta:
summary: Okta
value:
id: okta-source
type: okta
textSecret: okta-api-token-secret
oktaDomain: your-org
cronSchedule: "*/5 * * * *"
earliest: -7d@d
latest: now
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Okta Source.
InputCreateExamplesOpenAI:
summary: OpenAI
value:
id: openai-source
type: openai
textSecret: openai-api-key-secret
contentConfig:
- contentType: Audit Logs
contentDescription: Get organization audit logs.
collectPath: /v1/organization/audit_logs
requestParams:
- name: effective_at[gt]
value: "`${Math.round(Date.now()/1000 - 3600)}`"
- name: limit
value: "100"
paginationType: response_body
paginationAttribute:
- last_id
paginationLastPageExpr: has_more === false
cronSchedule: 0 * * * *
earliest: -1h
latest: now
disabled: false
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a OpenAI Source.
InputCreateExamplesOpenAIComplianceLogs:
summary: OpenAI Compliance Logs
value:
id: openai-compliance-logs-source
type: openai_compliance_logs
textSecret: openai-api-key-secret
accountType: workspace
workspaceId: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
workspaceEventTypes:
- AUDIT_LOG
- AUTH_LOG
cronSchedule: "*/15 * * * *"
earliest: -1h
latest: now
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a OpenAI Compliance Logs Source.
InputCreateExamplesOpenTelemetry:
summary: OpenTelemetry
value:
id: otel-source
type: open_telemetry
host: 0.0.0.0
port: 4317
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a OpenTelemetry Source.
InputCreateExamplesPrometheus:
summary: Prometheus Scraper
value:
id: prometheus-source
type: prometheus
interval: 60
logLevel: info
discoveryType: static
targetList:
- http://localhost:9090/metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Prometheus Scraper Source.
InputCreateExamplesPrometheusRw:
summary: Prometheus Remote Write
value:
id: prometheus-rw-source
type: prometheus_rw
host: 0.0.0.0
port: 10080
prometheusAPI: /write
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Prometheus Remote Write Source.
InputCreateExamplesRawUdp:
summary: Raw UDP
value:
id: raw-udp-source
type: raw_udp
host: 0.0.0.0
port: 514
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Raw UDP Source.
InputCreateExamplesBedrockS3:
summary: Bedrock
value:
id: bedrock-s3-source
type: bedrock_s3
queueName: s3-notifications-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Bedrock Source.
InputCreateExamplesS3:
summary: S3
value:
id: s3-source
type: s3
queueName: s3-notifications-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a S3 Source.
InputCreateExamplesS3Inventory:
summary: S3 Inventory
value:
id: s3-inventory-source
type: s3_inventory
queueName: s3-inventory-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a S3 Inventory Source.
InputCreateExamplesSecurityLake:
summary: Security Lake
value:
id: security-lake-source
type: security_lake
queueName: security-lake-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Security Lake Source.
InputCreateExamplesServiceNowTable:
summary: ServiceNow Table API
value:
id: servicenow-table-source
type: servicenow_table
instance: https://example.service-now.com
tableName: incident
fields:
- sys_id
- number
- short_description
pageSize: 10000
cronSchedule: 0 * * * *
earliest: -1d
latest: now
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a ServiceNow Table API Source.
InputCreateExamplesSnmp:
summary: SNMP
value:
id: snmp-source
type: snmp
host: 192.168.1.1
port: 161
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a SNMP Source.
InputCreateExamplesSplunk:
summary: Splunk TCP
value:
id: splunk-source
type: splunk
host: 0.0.0.0
port: 9997
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Splunk TCP Source.
InputCreateExamplesSplunkHec:
summary: Splunk HEC
value:
id: splunk-hec-source
type: splunk_hec
host: 0.0.0.0
port: 8088
splunkHecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Splunk HEC Source.
InputCreateExamplesSplunkSearch:
summary: Splunk Search
value:
id: splunk-search-source
type: splunk_search
authType: basic
searchHead: https://localhost:8089
search: index=main
cronSchedule: "*/15 * * * *"
endpoint: /services/search/v2/jobs/export
outputMode: json
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Splunk Search Source.
InputCreateExamplesSqs:
summary: SQS
value:
id: sqs-source
type: sqs
queueName: my-queue
queueType: standard
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a SQS Source.
InputCreateExamplesSysdigHec:
summary: Sysdig Cloud NSS
value:
id: sysdig-hec-source
type: sysdig_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Sysdig Cloud NSS Source.
InputCreateExamplesSyslog:
summary: Syslog
value:
id: syslog-source
type: syslog
host: 0.0.0.0
udpPort: 514
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Syslog Source.
InputCreateExamplesSyslogWithPQ:
summary: Syslog with Persistent Queue
value:
id: syslog-pq-source
type: syslog
host: 0.0.0.0
udpPort: 514
sendToRoutes: true
pqEnabled: true
pq:
mode: always
maxBufferSizeBytes: 1MB
maxFileSize: 10MB
maxSize: 5GB
path: $CRIBL_HOME/state/queues
compress: none
onBackpressure: drop
description: Example request body for creating a Syslog with Persistent Queue Source.
InputCreateExamplesSystemMetrics:
summary: System Metrics
value:
id: system-metrics-source
type: system_metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a System Metrics Source.
InputCreateExamplesSystemState:
summary: System State
value:
id: system-state-source
type: system_state
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a System State Source.
InputCreateExamplesTcp:
summary: TCP
value:
id: tcp-source
type: tcp
host: 0.0.0.0
port: 10090
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a TCP Source.
InputCreateExamplesTcpjson:
summary: TCP JSON
value:
id: tcpjson-source
type: tcpjson
host: 0.0.0.0
port: 10090
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a TCP JSON Source.
InputCreateExamplesUpwindHec:
summary: Upwind
value:
id: upwind-hec-source
type: upwind_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Upwind Source.
InputCreateExamplesWef:
summary: Windows Event Forwarder
value:
id: wef-source
type: wef
host: 0.0.0.0
port: 5985
privKeyPath: /path/to/private.key
certPath: /path/to/certificate.crt
caPath: /path/to/ca.crt
subscriptions:
- subscriptionName: subscription-1
contentFormat: RenderedText
heartbeatInterval: 60
batchTimeout: 5
targets: []
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Windows Event Forwarder Source.
InputCreateExamplesWinEventLogs:
summary: Windows Event Logs
value:
id: win-event-logs-source
type: win_event_logs
logNames:
- Application
- System
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Windows Event Logs Source.
InputCreateExamplesWindowsMetrics:
summary: Windows Metrics
value:
id: windows-metrics-source
type: windows_metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Windows Metrics Source.
InputCreateExamplesWiz:
summary: Wiz API
value:
id: wiz-source
type: wiz
endpoint: https://api.wiz.io
authUrl: https://auth.wiz.io/oauth/token
clientId: client-id
contentConfig: []
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Wiz API Source.
InputCreateExamplesWizWebhook:
summary: Wiz Webhook
value:
id: wiz-webhook-source
type: wiz_webhook
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Wiz Webhook Source.
InputCreateExamplesZscalerHec:
summary: Zscaler Cloud NSS
value:
id: zscaler-hec-source
type: zscaler_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for creating a Zscaler Cloud NSS Source.
UpdateInputExamplesAnthropicCompliance:
summary: Anthropic Compliance
value:
id: anthropic-compliance-source
type: anthropic_compliance
textSecret: anthropic-api-key-secret
contentConfig:
- contentType: activities
contentDescription: Compliance Activities
enabled: true
cronSchedule: "*/5 * * * *"
earliest: -7d@d
latest: now
jobTimeout: "300"
stateTracking: true
stateUpdateExpression: "__timestampExtracted !== false && {latestTime:
(state.latestTime || 0) > _time ? state.latestTime : _time}"
stateMergeExpression: "prevState.latestTime > newState.latestTime ? prevState : newState"
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Anthropic Compliance
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesAppleUnifiedLogs:
summary: Apple Unified Logs
value:
id: apple-unified-logs-source
type: apple_unified_logs
predicate: subsystem == "com.apple.security"
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Apple Unified Logs
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesAppscope:
summary: AppScope
value:
id: appscope-source
type: appscope
host: 0.0.0.0
port: 9109
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a AppScope Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesAzureBlob:
summary: Azure Blob
value:
id: azure-blob-source
type: azure_blob
queueName: azure-blob-queue
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Azure Blob Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesCloudflareHec:
summary: Cloudflare HEC
value:
id: cloudflare-hec-source
type: cloudflare_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Cloudflare HEC
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesConfluentCloud:
summary: Confluent Cloud
value:
id: confluent-cloud-source
type: confluent_cloud
brokers:
- pkc-xxxxx.us-east-1.aws.confluent.cloud:9092
topics:
- logs
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Confluent Cloud
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesCollection:
summary: Collection
value:
id: collection-source
type: collection
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Collection Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesCribl:
summary: Cribl Internal
value:
id: cribl-source
type: cribl
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Cribl Internal
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesCriblHttp:
summary: Cribl HTTP
value:
id: cribl-http-source
type: cribl_http
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Cribl HTTP Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesCriblLakeHttp:
summary: Cribl Lake HTTP
value:
id: cribl-lake-http-source
type: cribl_lake_http
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Cribl Lake HTTP
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesCriblMetrics:
summary: Cribl Metrics
value:
id: cribl-metrics-source
type: criblmetrics
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Cribl Metrics
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesCriblTcp:
summary: Cribl TCP
value:
id: cribl-tcp-source
type: cribl_tcp
host: 0.0.0.0
port: 10090
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Cribl TCP Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesCrowdstrike:
summary: CrowdStrike FDR
value:
id: crowdstrike-source
type: crowdstrike
queueName: crowdstrike-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a CrowdStrike FDR
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesDatadogAgent:
summary: Datadog Agent
value:
id: datadog-agent-source
type: datadog_agent
host: 0.0.0.0
port: 8126
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Datadog Agent
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesDatagen:
summary: Datagen
value:
id: datagen-source
type: datagen
samples:
- sample: sample.json
eventsPerSec: 10
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Datagen Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesEdgePrometheus:
summary: Edge Prometheus
value:
id: edge-prometheus-source
type: edge_prometheus
interval: 60
discoveryType: static
targets:
- host: localhost
scrapeProtocol: http
scrapePort: 9090
scrapePath: /metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Edge Prometheus
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesElastic:
summary: Elasticsearch
value:
id: elastic-source
type: elastic
host: localhost
port: 9200
elasticAPI: /
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Elasticsearch
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesEventhub:
summary: Event Hubs
value:
id: eventhub-source
type: eventhub
brokers:
- myeventhub.servicebus.windows.net:9093
topics:
- logs
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Event Hubs Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesEventhubAmqp:
summary: Event Hubs AMQP
value:
id: eventhub-amqp-source
type: eventhub_amqp
eventHubName: my-event-hub
consumerGroup: $Default
checkpointing:
blobStore:
containerName: my-container
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Event Hubs AMQP
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesExec:
summary: Exec
value:
id: exec-source
type: exec
command: echo "Hello World"
interval: 60
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Exec Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesFile:
summary: File Monitor
value:
id: file-source
type: file
mode: manual
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a File Monitor
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesFirehose:
summary: Firehose
value:
id: firehose-source
type: firehose
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Firehose Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesGrafana:
summary: Grafana
value:
id: grafana-source
type: grafana
host: 0.0.0.0
port: 10080
prometheusAPI: /api/prom/push
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Grafana Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesGooglePubsub:
summary: Google Pub/Sub
value:
id: google-pubsub-source
type: google_pubsub
subscriptionName: my-subscription
topicName: my-topic
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Google Pub/Sub
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesHttp:
summary: HTTP
value:
id: http-source
type: http
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a HTTP Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesHttpRaw:
summary: HTTP Raw
value:
id: http-raw-source
type: http_raw
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a HTTP Raw Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesJournalFiles:
summary: Journal Files
value:
id: journal-files-source
type: journal_files
path: /var/log/journal
journals:
- system
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Journal Files
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesKafka:
summary: Kafka
value:
id: kafka-source
type: kafka
brokers:
- localhost:9092
topics:
- logs
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Kafka Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesKinesis:
summary: Kinesis
value:
id: kinesis-source
type: kinesis
streamName: my-stream
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Kinesis Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesKubeEvents:
summary: Kubernetes Events
value:
id: kube-events-source
type: kube_events
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Kubernetes Events
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesKubeLogs:
summary: Kubernetes Logs
value:
id: kube-logs-source
type: kube_logs
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Kubernetes Logs
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesKubeMetrics:
summary: Kubernetes Metrics
value:
id: kube-metrics-source
type: kube_metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Kubernetes Metrics
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesLoki:
summary: Loki
value:
id: loki-source
type: loki
host: 0.0.0.0
port: 10080
lokiAPI: /loki/api/v1/push
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Loki Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesMetrics:
summary: Metrics
value:
id: metrics-source
type: metrics
host: 0.0.0.0
udpPort: 8125
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Metrics Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesModelDrivenTelemetry:
summary: Model Driven Telemetry
value:
id: mdt-source
type: model_driven_telemetry
host: 0.0.0.0
port: 57000
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Model Driven Telemetry
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesMsk:
summary: MSK
value:
id: msk-source
type: msk
brokers:
- b-1.example.xxxxx.c2.kafka.us-east-1.amazonaws.com:9092
topics:
- logs
region: us-east-1
awsAuthenticationMethod: auto
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a MSK Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesNetflow:
summary: Netflow
value:
id: netflow-source
type: netflow
host: 0.0.0.0
port: 2055
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Netflow Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesOffice365Mgmt:
summary: Microsoft 365 Management Activity
value:
id: office365-mgmt-source
type: office365_mgmt
tenantId: tenant-id
appId: app-id
planType: enterprise_gcc
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Microsoft 365 Management
Activity Source.
The request body must include a complete
representation of the Source that you want to update. This endpoint does
not support partial updates.
UpdateInputExamplesMicrosoftGraph:
summary: Microsoft Graph
value:
id: microsoft-graph-source
type: microsoft_graph
url: https://graph.microsoft.com/v1.0/admin/exchange/tracing/messageTraces
interval: 15
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Microsoft Graph
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesOffice365MsgTrace:
summary: Microsoft 365 Message Trace
value:
id: office365-msg-trace-source
type: office365_msg_trace
url: https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MessageTrace
interval: 15
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Microsoft 365 Message Trace
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesOffice365Service:
summary: Microsoft 365 Services
value:
id: office365-service-source
type: office365_service
tenantId: tenant-id
appId: app-id
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Microsoft 365 Services
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesOkta:
summary: Okta
value:
id: okta-source
type: okta
textSecret: okta-api-token-secret
oktaDomain: your-org
cronSchedule: "*/5 * * * *"
earliest: -7d@d
latest: now
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Okta Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesOpenAI:
summary: OpenAI
value:
id: openai-source
type: openai
textSecret: openai-api-key-secret
contentConfig:
- contentType: Audit Logs
contentDescription: Get organization audit logs.
collectPath: /v1/organization/audit_logs
requestParams:
- name: effective_at[gt]
value: "`${Math.round(Date.now()/1000 - 3600)}`"
- name: limit
value: "100"
paginationType: response_body
paginationAttribute:
- last_id
paginationLastPageExpr: has_more === false
cronSchedule: 0 * * * *
earliest: -1h
latest: now
disabled: false
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a OpenAI Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesOpenAIComplianceLogs:
summary: OpenAI Compliance Logs
value:
id: openai-compliance-logs-source
type: openai_compliance_logs
textSecret: openai-api-key-secret
accountType: workspace
workspaceId: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
workspaceEventTypes:
- AUDIT_LOG
- AUTH_LOG
cronSchedule: "*/15 * * * *"
earliest: -1h
latest: now
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a OpenAI Compliance Logs
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesOpenTelemetry:
summary: OpenTelemetry
value:
id: otel-source
type: open_telemetry
host: 0.0.0.0
port: 4317
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a OpenTelemetry
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesPrometheus:
summary: Prometheus Scraper
value:
id: prometheus-source
type: prometheus
interval: 60
logLevel: info
discoveryType: static
targetList:
- http://localhost:9090/metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Prometheus Scraper
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesPrometheusRw:
summary: Prometheus Remote Write
value:
id: prometheus-rw-source
type: prometheus_rw
host: 0.0.0.0
port: 10080
prometheusAPI: /write
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Prometheus Remote Write
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesRawUdp:
summary: Raw UDP
value:
id: raw-udp-source
type: raw_udp
host: 0.0.0.0
port: 514
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Raw UDP Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesBedrockS3:
summary: Bedrock
value:
id: bedrock-s3-source
type: bedrock_s3
queueName: s3-notifications-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Bedrock Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesS3:
summary: S3
value:
id: s3-source
type: s3
queueName: s3-notifications-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a S3 Source.
The request
body must include a complete representation of the Source that you want
to update. This endpoint does not support partial updates.
UpdateInputExamplesS3Inventory:
summary: S3 Inventory
value:
id: s3-inventory-source
type: s3_inventory
queueName: s3-inventory-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a S3 Inventory
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesSecurityLake:
summary: Security Lake
value:
id: security-lake-source
type: security_lake
queueName: security-lake-queue
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Security Lake
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesServiceNowTable:
summary: ServiceNow Table API
value:
id: servicenow-table-source
type: servicenow_table
instance: https://example.service-now.com
tableName: incident
fields:
- sys_id
- number
- short_description
pageSize: 10000
cronSchedule: 0 * * * *
earliest: -1d
latest: now
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a ServiceNow Table API
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesSnmp:
summary: SNMP
value:
id: snmp-source
type: snmp
host: 192.168.1.1
port: 161
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a SNMP Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesSplunk:
summary: Splunk TCP
value:
id: splunk-source
type: splunk
host: 0.0.0.0
port: 9997
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Splunk TCP Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesSplunkHec:
summary: Splunk HEC
value:
id: splunk-hec-source
type: splunk_hec
host: 0.0.0.0
port: 8088
splunkHecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Splunk HEC Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesSplunkSearch:
summary: Splunk Search
value:
id: splunk-search-source
type: splunk_search
authType: basic
searchHead: https://localhost:8089
search: index=main
cronSchedule: "*/15 * * * *"
endpoint: /services/search/v2/jobs/export
outputMode: json
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Splunk Search
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesSqs:
summary: SQS
value:
id: sqs-source
type: sqs
queueName: my-queue
queueType: standard
region: us-east-1
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a SQS Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesSysdigHec:
summary: Sysdig Cloud NSS
value:
id: sysdig-hec-source
type: sysdig_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Sysdig Cloud NSS
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesSyslog:
summary: Syslog
value:
id: syslog-source
type: syslog
host: 0.0.0.0
udpPort: 514
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Syslog Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesSyslogWithPQ:
summary: Syslog with Persistent Queue
value:
id: syslog-pq-source
type: syslog
host: 0.0.0.0
udpPort: 514
sendToRoutes: true
pqEnabled: true
pq:
mode: always
maxBufferSizeBytes: 1MB
maxFileSize: 10MB
maxSize: 5GB
path: $CRIBL_HOME/state/queues
compress: none
onBackpressure: drop
description: Example request body for updating a Syslog with Persistent Queue
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesSystemMetrics:
summary: System Metrics
value:
id: system-metrics-source
type: system_metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a System Metrics
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesSystemState:
summary: System State
value:
id: system-state-source
type: system_state
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a System State
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesTcp:
summary: TCP
value:
id: tcp-source
type: tcp
host: 0.0.0.0
port: 10090
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a TCP Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesTcpjson:
summary: TCP JSON
value:
id: tcpjson-source
type: tcpjson
host: 0.0.0.0
port: 10090
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a TCP JSON Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesUpwindHec:
summary: Upwind
value:
id: upwind-hec-source
type: upwind_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Upwind Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesWef:
summary: Windows Event Forwarder
value:
id: wef-source
type: wef
host: 0.0.0.0
port: 5985
privKeyPath: /path/to/private.key
certPath: /path/to/certificate.crt
caPath: /path/to/ca.crt
subscriptions:
- subscriptionName: subscription-1
contentFormat: RenderedText
heartbeatInterval: 60
batchTimeout: 5
targets: []
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Windows Event Forwarder
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesWinEventLogs:
summary: Windows Event Logs
value:
id: win-event-logs-source
type: win_event_logs
logNames:
- Application
- System
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Windows Event Logs
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesWindowsMetrics:
summary: Windows Metrics
value:
id: windows-metrics-source
type: windows_metrics
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Windows Metrics
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesWiz:
summary: Wiz API
value:
id: wiz-source
type: wiz
endpoint: https://api.wiz.io
authUrl: https://auth.wiz.io/oauth/token
clientId: client-id
contentConfig: []
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Wiz API Source.
The
request body must include a complete representation of the Source that
you want to update. This endpoint does not support partial updates.
UpdateInputExamplesWizWebhook:
summary: Wiz Webhook
value:
id: wiz-webhook-source
type: wiz_webhook
host: 0.0.0.0
port: 10080
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Wiz Webhook
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
UpdateInputExamplesZscalerHec:
summary: Zscaler Cloud NSS
value:
id: zscaler-hec-source
type: zscaler_hec
host: 0.0.0.0
port: 8088
hecAPI: /services/collector
sendToRoutes: true
pqEnabled: false
description: Example request body for updating a Zscaler Cloud NSS
Source.
The request body must include a complete representation
of the Source that you want to update. This endpoint does not support
partial updates.
OutputClearPQResponseExamplesClearPQJobId:
summary: Clear persistent queue for a Destination
description: Example response for clearing the persistent queue (PQ) for a
Destination.
value:
items:
- ceb17a42-f785-4f5e-b52a-7f0e1b2c3d4e
count: 1
OutputResponseExamplesSplunkHecDestination:
summary: Splunk HEC Destination response
description: Example response for getting or updating a Splunk HEC Destination.
value:
items:
- id: splunk-hec-output
type: splunk_hec
host: localhost
port: 8088
hecToken: 1234abcd5678efgh9101ijklEXAMPLETOKEN
count: 1
OutputResponseExamplesS3Destination:
summary: Amazon S3 Destination response
description: Example response for getting or updating an Amazon S3 Destination.
value:
items:
- id: s3-output
type: s3
bucket: my-bucket
region: us-east-1
stagePath: /tmp/staging
count: 1
OutputResponseExamplesSyslogDestination:
summary: Syslog Destination response
description: Example response for getting or updating a Syslog Destination.
value:
items:
- id: syslog-output
type: syslog
host: localhost
port: 514
count: 1
OutputResponseExamplesSnowflakeStreamingDestination:
summary: Snowflake Streaming Destination response
description: Example response for getting or updating a Snowflake Streaming
Destination.
value:
items:
- id: snowflake-streaming-output
type: snowflake_streaming
accountIdentifier: MYORG-MYACCOUNT
user: STREAMING_USER
pem:
keyName: my-snowflake-private-key
database: EVENTS_DB
schema: PUBLIC
table: RAW_EVENTS
count: 1
OutputCreateExamplesTcpjson:
summary: TCP JSON
value:
id: tcpjson-output
type: tcpjson
host: localhost
port: 10090
description: Example request body for creating a TCP JSON Destination.
OutputCreateExamplesSplunk:
summary: Splunk
value:
id: splunk-output
type: splunk
host: localhost
port: 9997
description: Example request body for creating a Splunk Destination.
OutputCreateExamplesSplunkLb:
summary: Splunk Load Balanced
value:
id: splunk-lb-output
type: splunk_lb
hosts:
- host: localhost
port: 9997
description: Example request body for creating a Splunk Load Balanced Destination.
OutputCreateExamplesSplunkHec:
summary: Splunk HEC
value:
id: splunk-hec-output
type: splunk_hec
host: localhost
port: 8088
hecToken: your-hec-token
description: Example request body for creating a Splunk HEC Destination.
OutputCreateExamplesSyslog:
summary: Syslog
value:
id: syslog-output
type: syslog
host: localhost
port: 514
description: Example request body for creating a Syslog Destination.
OutputCreateExamplesFilesystem:
summary: Filesystem
value:
id: filesystem-output
type: filesystem
destPath: /var/log/output
description: Example request body for creating a Filesystem Destination.
OutputCreateExamplesS3:
summary: S3
value:
id: s3-output
type: s3
bucket: my-bucket
region: us-east-1
stagePath: /tmp/staging
description: Example request body for creating a S3 Destination.
OutputCreateExamplesNutanixObjects:
summary: Nutanix Objects
value:
id: nutanix-objects-output
type: nutanix_objects
bucket: my-bucket
endpoint: https://nutanix-objects.example.com
stagePath: /tmp/staging
description: Example request body for creating a Nutanix Objects Destination.
OutputCreateExamplesStorjS3:
summary: Storj
value:
id: storj-s3-output
type: storj_s3
bucket: my-bucket
endpoint: https://gateway.storjshare.io
stagePath: /tmp/staging
description: Example request body for creating a Storj Destination.
OutputCreateExamplesAlphasocS3:
summary: AlphaSOC
value:
id: alphasoc-s3-output
type: alphasoc_s3
bucket: events
endpoint: https://s3.alphasoc.net
stagePath: /tmp/staging
description: Example request body for creating a AlphaSOC Destination.
OutputCreateExamplesdellS3:
summary: Dell PowerScale OneFS
value:
id: dell-s3-output
type: dell_s3
bucket: my-bucket
endpoint: https://powerscale.example.com:9021
stagePath: /tmp/staging
description: Example request body for creating a Dell PowerScale OneFS Destination.
OutputCreateExamplescloudianS3:
summary: Cloudian
value:
id: cloudian-s3-output
type: cloudian_s3
bucket: my-bucket
endpoint: https://s3.hyperstore.example.com
stagePath: /tmp/staging
description: Example request body for creating a Cloudian Destination.
OutputCreateExamplesscalityS3:
summary: Scality
value:
id: scality-s3-output
type: scality_s3
bucket: my-bucket
endpoint: https://s3.scality.example.com
stagePath: /tmp/staging
description: Example request body for creating a Scality Destination.
OutputCreateExamplesalibabaCloudS3:
summary: Alibaba OSS
value:
id: alibaba-oss-output
type: alibaba_cloud_s3
bucket: my-bucket
endpoint: https://s3.oss-cn-hangzhou.aliyuncs.com
stagePath: /tmp/staging
description: Example request body for creating a Alibaba OSS Destination.
OutputCreateExamplesibmCloudS3:
summary: IBM Cloud Object Storage
value:
id: ibm-cloud-s3-output
type: ibm_cloud_s3
bucket: my-bucket
endpoint: https://s3.us-south.cloud-object-storage.appdomain.cloud
stagePath: /tmp/staging
description: Example request body for creating a IBM Cloud Object Storage Destination.
OutputCreateExamplesAzureBlob:
summary: Azure Blob
value:
id: azure-blob-output
type: azure_blob
containerName: my-container
stagePath: /tmp/staging
description: Example request body for creating a Azure Blob Destination.
OutputCreateExamplesAzureDataExplorer:
summary: Azure Data Explorer
value:
id: azure-data-explorer-output
type: azure_data_explorer
clusterUrl: https://mycluster.kusto.windows.net
database: mydatabase
table: mytable
oauthEndpoint: https://login.microsoftonline.com
tenantId: tenant-id
clientId: client-id
scope: https://mycluster.kusto.windows.net/.default
oauthType: clientSecret
clientSecret: client-secret
ingestMode: streaming
format: json
compress: gzip
description: Example request body for creating a Azure Data Explorer Destination.
OutputCreateExamplesSentinel:
summary: Azure Sentinel
value:
id: sentinel-output
type: sentinel
endpointURLConfiguration: url
url: https://your-workspace.ingest.monitor.azure.com
loginUrl: https://login.microsoftonline.com
secret: client-secret
client_id: client-id
description: Example request body for creating a Azure Sentinel Destination.
OutputCreateExamplesAzureLogs:
summary: Azure Logs
value:
id: azure-logs-output
type: azure_logs
workspaceId: workspace-id
workspaceKey: workspace-key
logType: Cribl
authType: manual
description: Example request body for creating a Azure Logs Destination.
OutputCreateExamplesKafka:
summary: Kafka
value:
id: kafka-output
type: kafka
brokers:
- localhost:9092
topic: logs
description: Example request body for creating a Kafka Destination.
OutputCreateExamplesConfluentCloud:
summary: Confluent Cloud
value:
id: confluent-cloud-output
type: confluent_cloud
brokers:
- pkc-xxxxx.us-east-1.aws.confluent.cloud:9092
topic: logs
description: Example request body for creating a Confluent Cloud Destination.
OutputCreateExamplesMsk:
summary: MSK
value:
id: msk-output
type: msk
brokers:
- b-1.example.xxxxx.c2.kafka.us-east-1.amazonaws.com:9092
topic: logs
region: us-east-1
awsAuthenticationMethod: auto
description: Example request body for creating a MSK Destination.
OutputCreateExamplesKinesis:
summary: Kinesis
value:
id: kinesis-output
type: kinesis
streamName: my-stream
region: us-east-1
description: Example request body for creating a Kinesis Destination.
OutputCreateExamplesElastic:
summary: Elasticsearch
value:
id: elastic-output
type: elastic
host: localhost
port: 9200
index: logs
description: Example request body for creating a Elasticsearch Destination.
OutputCreateExamplesElasticCloud:
summary: Elastic Cloud
value:
id: elastic-cloud-output
type: elastic_cloud
url: my-cloud-id
index: logs
description: Example request body for creating a Elastic Cloud Destination.
OutputCreateExamplesMicrosoftFabric:
summary: Microsoft Fabric
value:
id: microsoft-fabric-output
type: microsoft_fabric
bootstrap_server: myeventstream.servicebus.windows.net:9093
topic: logs
description: Example request body for creating a Microsoft Fabric Destination.
OutputCreateExamplesCloudflareR2:
summary: Cloudflare R2
value:
id: cloudflare-r2-output
type: cloudflare_r2
bucket: my-bucket
endpoint: https://account-id.r2.cloudflarestorage.com
stagePath: /tmp/staging
description: Example request body for creating a Cloudflare R2 Destination.
OutputCreateExamplesHoneycomb:
summary: Honeycomb
value:
id: honeycomb-output
type: honeycomb
apiKey: your-api-key
dataset: my-dataset
description: Example request body for creating a Honeycomb Destination.
OutputCreateExamplesNewrelic:
summary: New Relic
value:
id: newrelic-output
type: newrelic
apiKey: your-api-key
baseUrl: https://insights-collector.newrelic.com
description: Example request body for creating a New Relic Destination.
OutputCreateExamplesNewrelicEvents:
summary: New Relic Events
value:
id: newrelic-events-output
type: newrelic_events
accountId: "123456"
eventType: CriblEvent
apiKey: your-api-key
baseUrl: https://insights-collector.newrelic.com
description: Example request body for creating a New Relic Events Destination.
OutputCreateExamplesSnmp:
summary: SNMP
value:
id: snmp-output
type: snmp
hosts:
- host: 192.168.1.1
port: 161
description: Example request body for creating a SNMP Destination.
OutputCreateExamplesInfluxdb:
summary: InfluxDB
value:
id: influxdb-output
type: influxdb
url: http://localhost:8086
database: mydb
description: Example request body for creating a InfluxDB Destination.
OutputCreateExamplesMinio:
summary: MinIO
value:
id: minio-output
type: minio
bucket: my-bucket
stagePath: /tmp/staging
endpoint: http://localhost:9000
description: Example request body for creating a MinIO Destination.
OutputCreateExamplesCloudwatch:
summary: CloudWatch
value:
id: cloudwatch-output
type: cloudwatch
logGroupName: my-log-group
logStreamName: my-log-stream
region: us-east-1
description: Example request body for creating a CloudWatch Destination.
OutputCreateExamplesAzureEventhub:
summary: Azure Event Hub
value:
id: azure-eventhub-output
type: azure_eventhub
brokers:
- myeventhub.servicebus.windows.net:9093
topic: logs
description: Example request body for creating a Azure Event Hub Destination.
OutputCreateExamplesStatsd:
summary: StatsD
value:
id: statsd-output
type: statsd
protocol: udp
host: localhost
port: 8125
description: Example request body for creating a StatsD Destination.
OutputCreateExamplesStatsdExt:
summary: StatsD Extended
value:
id: statsd-ext-output
type: statsd_ext
protocol: udp
host: localhost
port: 8125
description: Example request body for creating a StatsD Extended Destination.
OutputCreateExamplesGraphite:
summary: Graphite
value:
id: graphite-output
type: graphite
protocol: tcp
host: localhost
port: 2003
description: Example request body for creating a Graphite Destination.
OutputCreateExamplesWavefront:
summary: Wavefront
value:
id: wavefront-output
type: wavefront
domain: longboard
endpoint: https://your-instance.wavefront.com
token: your-token
description: Example request body for creating a Wavefront Destination.
OutputCreateExamplesSignalfx:
summary: SignalFx
value:
id: signalfx-output
type: signalfx
realm: us0
endpoint: https://ingest.signalfx.com
token: your-token
description: Example request body for creating a SignalFx Destination.
OutputCreateExamplesSqs:
summary: SQS
value:
id: sqs-output
type: sqs
queueName: my-queue
queueType: standard
region: us-east-1
description: Example request body for creating a SQS Destination.
OutputCreateExamplesGoogleCloudStorage:
summary: Google Cloud Storage
value:
id: google-cloud-storage-output
type: google_cloud_storage
bucket: my-bucket
endpoint: https://storage.googleapis.com
region: us-east1
stagePath: /tmp/staging
projectId: my-project
description: Example request body for creating a Google Cloud Storage Destination.
OutputCreateExamplesSumoLogic:
summary: Sumo Logic
value:
id: sumo-logic-output
type: sumo_logic
url: https://endpoint1.collection.us2.sumologic.com
sourceCategory: logs
description: Example request body for creating a Sumo Logic Destination.
OutputCreateExamplesDatadog:
summary: Datadog
value:
id: datadog-output
type: datadog
endpoint: https://http-intake.logs.datadoghq.com
apiKey: your-api-key
description: Example request body for creating a Datadog Destination.
OutputCreateExamplesWebhook:
summary: Webhook
value:
id: webhook-output
type: webhook
url: https://example.com/webhook
description: Example request body for creating a Webhook Destination.
OutputCreateExamplesPrometheus:
summary: Prometheus
value:
id: prometheus-output
type: prometheus
url: http://localhost:9091/api/v1/write
description: Example request body for creating a Prometheus Destination.
OutputCreateExamplesAmazonManagedPrometheus:
summary: Amazon Managed Service for Prometheus
value:
id: amazon-managed-prometheus-output
type: amazon_managed_prometheus
url: https://aps-workspaces.us-east-1.amazonaws.com/workspaces/ws-example/api/v1/remote_write
region: us-east-1
awsAuthenticationMethod: auto
description: Example request body for creating a Amazon Managed Service for
Prometheus Destination.
OutputCreateExamplesGooglePubsub:
summary: Google Pub/Sub
value:
id: google-pubsub-output
type: google_pubsub
projectId: my-project
topicName: my-topic
description: Example request body for creating a Google Pub/Sub Destination.
OutputCreateExamplesGoogleBigQuery:
summary: Google BigQuery
value:
id: google-bigquery-output
type: google_bigquery
projectId: my-project
datasetId: my-dataset
tableId: my-table
googleAuthMethod: auto
description: Example request body for creating a Google BigQuery Destination.
OutputCreateExamplesGoogleChronicle:
summary: Google Chronicle
value:
id: google-chronicle-output
type: google_chronicle
logFormatType: unstructured
region: us
customerId: customer-id
description: Example request body for creating a Google Chronicle Destination.
OutputCreateExamplesChronicle:
summary: Chronicle
value:
id: chronicle-output
type: chronicle
gcpProjectId: my-project
gcpInstance: customer-id
region: us
logType: UNKNOWN
description: Example request body for creating a Chronicle Destination.
OutputCreateExamplesGrafanaCloud:
summary: Grafana Cloud
value:
id: grafana-cloud-output
type: grafana_cloud
lokiUrl: https://logs-prod-us-central1.grafana.net
description: Example request body for creating a Grafana Cloud Destination.
OutputCreateExamplesLoki:
summary: Loki
value:
id: loki-output
type: loki
url: http://localhost:3100/loki/api/v1/push
description: Example request body for creating a Loki Destination.
OutputCreateExamplesOpenTelemetry:
summary: OpenTelemetry
value:
id: opentelemetry-output
type: open_telemetry
endpoint: http://localhost:4317
description: Example request body for creating a OpenTelemetry Destination.
OutputCreateExamplesServiceNow:
summary: ServiceNow
value:
id: servicenow-output
type: service_now
endpoint: ingest.lightstep.com:443
protocol: http
otlpVersion: 1.3.1
tokenSecret: your-token-secret
description: Example request body for creating a ServiceNow Destination.
OutputCreateExamplesDynatraceOtlp:
summary: Dynatrace OTLP
value:
id: dynatrace-otlp-output
type: dynatrace_otlp
endpoint: https://your-environment.live.dynatrace.com/api/v2/otlp
endpointType: saas
protocol: http
otlpVersion: 1.3.1
tokenSecret: your-token-secret
description: Example request body for creating a Dynatrace OTLP Destination.
OutputCreateExamplesGoogleCloudObservability:
summary: Google Cloud Observability
value:
id: google-cloud-observability-output
type: google_cloud_observability
googleAuthMethod: auto
description: Example request body for creating a Google Cloud Observability
Destination.
OutputCreateExamplesSentinelOneAiSiem:
summary: SentinelOne AI SIEM
value:
id: sentinel-one-ai-siem-output
type: sentinel_one_ai_siem
region: US
endpoint: /services/collector/event
description: Example request body for creating a SentinelOne AI SIEM Destination.
OutputCreateExamplesDataset:
summary: Dataset
value:
id: dataset-output
type: dataset
dataset: my-dataset
description: Example request body for creating a Dataset Destination.
OutputCreateExamplesRing:
summary: Ring Buffer
value:
id: ring-output
type: ring
description: Example request body for creating a Ring Buffer Destination.
OutputCreateExamplesRouter:
summary: Output Router
value:
id: router-output
type: router
rules:
- filter: "true"
output: my-output
description: Example request body for creating a Output Router Destination.
OutputCreateExamplesWizHec:
summary: Wiz Defend
value:
id: wiz-hec-output
type: wiz_hec
data_center: us1
wiz_sourcetype: placeholder
wiz_connector_id: 00000000-0000-0000-0000-000000000000
wiz_environment: test
authType: manual
hecToken: your-hec-token
description: Example request body for creating a Wiz Defend Destination.
OutputCreateExamplesHumioHec:
summary: Humio HEC
value:
id: humio-hec-output
type: humio_hec
url: https://cloud.us.humio.com/api/v1/ingest/hec
format: JSON
authType: manual
token: your-token
description: Example request body for creating a Humio HEC Destination.
OutputCreateExamplesCrowdstrikeNextGenSiem:
summary: CrowdStrike Next Gen SIEM
value:
id: crowdstrike-next-gen-siem-output
type: crowdstrike_next_gen_siem
url: https://ingest.us.crowdstrike.com/api/ingest/hec/connection-id/v1/services/collector
format: JSON
authType: manual
token: your-token
description: Example request body for creating a CrowdStrike Next Gen SIEM
Destination.
OutputCreateExamplesCriblHttp:
summary: Cribl HTTP
value:
id: cribl-http-output
type: cribl_http
host: localhost
port: 10080
description: Example request body for creating a Cribl HTTP Destination.
OutputCreateExamplesCriblTcp:
summary: Cribl TCP
value:
id: cribl-tcp-output
type: cribl_tcp
host: localhost
port: 10090
description: Example request body for creating a Cribl TCP Destination.
OutputCreateExamplesCriblSearchEngine:
summary: Cribl Search Engine
value:
id: cribl-search-engine-output
systemFields:
- cribl_pipe
streamtags: []
loadBalanced: false
tls:
disabled: true
tokenTTLMinutes: 60
excludeFields:
- __kube_*
- __metadata
- __winEvent
compression: gzip
concurrency: 5
maxPayloadSizeKB: 4096
maxPayloadEvents: 0
rejectUnauthorized: true
timeoutSec: 30
flushPeriodSec: 1
failedRequestLoggingMode: none
safeHeaders: []
throttleRatePerSec: "0"
responseRetrySettings:
- httpStatus: 401
initialBackoff: 1000
backoffRate: 2
maxBackoff: 20000
- httpStatus: 403
initialBackoff: 1000
backoffRate: 2
maxBackoff: 20000
- httpStatus: 408
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 429
initialBackoff: 1000
backoffRate: 2
maxBackoff: 10000
- httpStatus: 500
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 502
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 503
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 504
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 509
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
timeoutRetrySettings:
timeoutRetry: false
responseHonorRetryAfterHeader: true
onBackpressure: block
useRoundRobinDns: true
type: cribl_search_engine
url: https://0.0.0.0:10200
description: Example request body for creating a Cribl Search Engine Destination.
OutputCreateExamplesGoogleCloudLogging:
summary: Google Cloud Logging
value:
id: google-cloud-logging-output
type: google_cloud_logging
logLocationType: project
logLocationExpression: my-project
logNameExpression: my-log
projectId: my-project
description: Example request body for creating a Google Cloud Logging Destination.
OutputCreateExamplesSns:
summary: SNS
value:
id: sns-output
type: sns
topicArn: arn:aws:sns:us-east-1:123456789012:my-topic
messageGroupId: my-message-group
region: us-east-1
description: Example request body for creating a SNS Destination.
OutputCreateExamplesDlS3:
summary: Data Lake S3
value:
id: dl-s3-output
type: dl_s3
bucket: my-bucket
stagePath: /tmp/staging
region: us-east-1
description: Example request body for creating a Data Lake S3 Destination.
OutputCreateExamplesSecurityLake:
summary: Security Lake
value:
id: security-lake-output
type: security_lake
bucket: my-bucket
stagePath: /tmp/staging
region: us-east-1
accountId: "123456789012"
customSource: my-custom-source
assumeRoleArn: arn:aws:iam::123456789012:role/my-role
description: Example request body for creating a Security Lake Destination.
OutputCreateExamplesCriblLake:
summary: Cribl Lake
value:
id: cribl-lake-output
type: cribl_lake
dataset: my-dataset
description: Example request body for creating a Cribl Lake Destination.
OutputCreateExamplesExabeam:
summary: Exabeam
value:
id: exabeam-output
type: exabeam
bucket: my-bucket
region: us-east1
endpoint: https://storage.googleapis.com
stagePath: /tmp/staging
collectorInstanceId: 11112222-3333-4444-5555-666677778888
description: Example request body for creating a Exabeam Destination.
OutputCreateExamplesDiskSpool:
summary: Disk Spool
value:
id: disk-spool-output
type: disk_spool
path: /var/spool/cribl
description: Example request body for creating a Disk Spool Destination.
OutputCreateExamplesClickHouse:
summary: ClickHouse
value:
id: clickhouse-output
type: click_house
url: http://localhost:8123/
database: mydb
tableName: mytable
description: Example request body for creating a ClickHouse Destination.
OutputCreateExamplesLocalSearchStorage:
summary: Local Search Storage
value:
id: local-search-storage-output
type: local_search_storage
url: http://localhost:8123/
database: default
tableName: mytable
description: Example request body for creating a Local Search Storage Destination.
OutputCreateExamplesCustomerMetricsStorage:
summary: Customer Metrics Storage
value:
id: customer-metrics-storage-output
type: customer_metrics_storage
url: http://localhost:8123/
database: default
tableName: mytable
description: Example request body for creating a Customer Metrics Storage Destination.
OutputCreateExamplesXsiam:
summary: XSIAM
value:
id: xsiam-output
type: xsiam
endpoint: https://api.paloaltonetworks.com
apiKey: your-api-key
description: Example request body for creating a XSIAM Destination.
OutputCreateExamplesNetflow:
summary: Netflow
value:
id: netflow-output
type: netflow
hosts:
- host: localhost
port: 2055
description: Example request body for creating a Netflow Destination.
OutputCreateExamplesDynatraceHttp:
summary: Dynatrace HTTP
value:
id: dynatrace-http-output
type: dynatrace_http
format: json_array
endpoint: cloud
telemetryType: logs
authType: token
token: your-api-key
description: Example request body for creating a Dynatrace HTTP Destination.
OutputCreateExamplesDatabricks:
summary: Databricks
value:
id: databricks-output
type: databricks
workspaceId: your-workspace-id
scope: all-apis
clientId: your-client-id
clientTextSecret: your-client-secret
catalog: main
schema: external
eventsVolumeName: events
description: Example request body for creating a Databricks Destination.
OutputCreateExamplesSnowflakeStreaming:
summary: Snowflake Streaming
value:
id: snowflake-streaming-output
type: snowflake_streaming
accountIdentifier: MYORG-MYACCOUNT
user: STREAMING_USER
pem:
keyName: my-snowflake-private-key
database: EVENTS_DB
schema: PUBLIC
table: RAW_EVENTS
description: Example request body for creating a Snowflake Streaming Destination.
OutputSamplesResponseExamplesSampleEvents:
summary: Get sample events for a Destination
description: Example response for getting sample event data for a Destination.
value:
items:
- events:
- _raw: Sample event for Destination
source: test
sourcetype: manual
count: 1
OutputTestResponseExamplesSuccessfulTest:
summary: Successful Destination test
description: Example response when a Destination successfully receives sample
event data.
value:
items:
- outputId: splunk-hec-output
success: true
successDetail: Successfully sent 1 event(s) to the Destination.
count: 1
OutputTestResponseExamplesFailedTest:
summary: Failed Destination test
description: Example response when a Destination fails to receive sample event data.
value:
items:
- outputId: s3-output
success: false
error: Connection timed out after 30000ms
count: 1
OutputTestExamplesSingleEvent:
summary: Send a single test event
description: Example request body for sending a single test event to the Destination.
value:
events:
- _raw: This is a test event
source: test
sourcetype: manual
OutputTestExamplesMultipleEvents:
summary: Send multiple test events
description: Example request body for sending multiple test events to the Destination.
value:
events:
- _raw: Test event 1
source: test
sourcetype: manual
- _raw: Test event 2
source: test
sourcetype: manual
UpdateOutputExamplesDefault:
summary: Default
value:
id: default-output
type: default
defaultId: my-default-output
description: Example request body for updating a Default
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesTcpjson:
summary: TCP JSON
value:
id: tcpjson-output
type: tcpjson
host: localhost
port: 10090
description: Example request body for updating a TCP JSON
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSplunk:
summary: Splunk
value:
id: splunk-output
type: splunk
host: localhost
port: 9997
description: Example request body for updating a Splunk
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSplunkLb:
summary: Splunk Load Balanced
value:
id: splunk-lb-output
type: splunk_lb
hosts:
- host: localhost
port: 9997
description: Example request body for updating a Splunk Load Balanced
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSplunkHec:
summary: Splunk HEC
value:
id: splunk-hec-output
type: splunk_hec
host: localhost
port: 8088
hecToken: your-hec-token
description: Example request body for updating a Splunk HEC
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSyslog:
summary: Syslog
value:
id: syslog-output
type: syslog
host: localhost
port: 514
description: Example request body for updating a Syslog
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesFilesystem:
summary: Filesystem
value:
id: filesystem-output
type: filesystem
destPath: /var/log/output
description: Example request body for updating a Filesystem
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesS3:
summary: S3
value:
id: s3-output
type: s3
bucket: my-bucket
region: us-east-1
stagePath: /tmp/staging
description: Example request body for updating a S3 Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesNutanixObjects:
summary: Nutanix Objects
value:
id: nutanix-objects-output
type: nutanix_objects
bucket: my-bucket
endpoint: https://nutanix-objects.example.com
stagePath: /tmp/staging
description: Example request body for updating a Nutanix Objects
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesStorjS3:
summary: Storj
value:
id: storj-s3-output
type: storj_s3
bucket: my-bucket
endpoint: https://gateway.storjshare.io
stagePath: /tmp/staging
description: Example request body for updating a Storj Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesAlphasocS3:
summary: AlphaSOC
value:
id: alphasoc-s3-output
type: alphasoc_s3
bucket: events
endpoint: https://s3.alphasoc.net
stagePath: /tmp/staging
description: Example request body for updating a AlphaSOC
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesdellS3:
summary: Dell PowerScale OneFS
value:
id: dell-s3-output
type: dell_s3
bucket: my-bucket
endpoint: https://powerscale.example.com:9021
stagePath: /tmp/staging
description: Example request body for updating a Dell PowerScale OneFS
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplescloudianS3:
summary: Cloudian
value:
id: cloudian-s3-output
type: cloudian_s3
bucket: my-bucket
endpoint: https://s3.hyperstore.example.com
stagePath: /tmp/staging
description: Example request body for updating a Cloudian
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesscalityS3:
summary: Scality
value:
id: scality-s3-output
type: scality_s3
bucket: my-bucket
endpoint: https://s3.scality.example.com
stagePath: /tmp/staging
description: Example request body for updating a Scality
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesalibabaCloudS3:
summary: Alibaba OSS
value:
id: alibaba-oss-output
type: alibaba_cloud_s3
bucket: my-bucket
endpoint: https://s3.oss-cn-hangzhou.aliyuncs.com
stagePath: /tmp/staging
description: Example request body for updating a Alibaba OSS
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesibmCloudS3:
summary: IBM Cloud Object Storage
value:
id: ibm-cloud-s3-output
type: ibm_cloud_s3
bucket: my-bucket
endpoint: https://s3.us-south.cloud-object-storage.appdomain.cloud
stagePath: /tmp/staging
description: Example request body for updating a IBM Cloud Object Storage
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesAzureBlob:
summary: Azure Blob
value:
id: azure-blob-output
type: azure_blob
containerName: my-container
stagePath: /tmp/staging
description: Example request body for updating a Azure Blob
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesAzureDataExplorer:
summary: Azure Data Explorer
value:
id: azure-data-explorer-output
type: azure_data_explorer
clusterUrl: https://mycluster.kusto.windows.net
database: mydatabase
table: mytable
oauthEndpoint: https://login.microsoftonline.com
tenantId: tenant-id
clientId: client-id
scope: https://mycluster.kusto.windows.net/.default
oauthType: clientSecret
clientSecret: client-secret
ingestMode: streaming
format: json
compress: gzip
description: Example request body for updating a Azure Data Explorer
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSentinel:
summary: Azure Sentinel
value:
id: sentinel-output
type: sentinel
endpointURLConfiguration: url
url: https://your-workspace.ingest.monitor.azure.com
loginUrl: https://login.microsoftonline.com
secret: client-secret
client_id: client-id
description: Example request body for updating a Azure Sentinel
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesAzureLogs:
summary: Azure Logs
value:
id: azure-logs-output
type: azure_logs
workspaceId: workspace-id
workspaceKey: workspace-key
logType: Cribl
authType: manual
description: Example request body for updating a Azure Logs
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesKafka:
summary: Kafka
value:
id: kafka-output
type: kafka
brokers:
- localhost:9092
topic: logs
description: Example request body for updating a Kafka Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesConfluentCloud:
summary: Confluent Cloud
value:
id: confluent-cloud-output
type: confluent_cloud
brokers:
- pkc-xxxxx.us-east-1.aws.confluent.cloud:9092
topic: logs
description: Example request body for updating a Confluent Cloud
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesMsk:
summary: MSK
value:
id: msk-output
type: msk
brokers:
- b-1.example.xxxxx.c2.kafka.us-east-1.amazonaws.com:9092
topic: logs
region: us-east-1
awsAuthenticationMethod: auto
description: Example request body for updating a MSK Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesKinesis:
summary: Kinesis
value:
id: kinesis-output
type: kinesis
streamName: my-stream
region: us-east-1
description: Example request body for updating a Kinesis
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesElastic:
summary: Elasticsearch
value:
id: elastic-output
type: elastic
host: localhost
port: 9200
index: logs
description: Example request body for updating a Elasticsearch
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesElasticCloud:
summary: Elastic Cloud
value:
id: elastic-cloud-output
type: elastic_cloud
url: my-cloud-id
index: logs
description: Example request body for updating a Elastic Cloud
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesMicrosoftFabric:
summary: Microsoft Fabric
value:
id: microsoft-fabric-output
type: microsoft_fabric
bootstrap_server: myeventstream.servicebus.windows.net:9093
topic: logs
description: Example request body for updating a Microsoft Fabric
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesCloudflareR2:
summary: Cloudflare R2
value:
id: cloudflare-r2-output
type: cloudflare_r2
bucket: my-bucket
endpoint: https://account-id.r2.cloudflarestorage.com
stagePath: /tmp/staging
description: Example request body for updating a Cloudflare R2
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesHoneycomb:
summary: Honeycomb
value:
id: honeycomb-output
type: honeycomb
apiKey: your-api-key
dataset: my-dataset
description: Example request body for updating a Honeycomb
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesNewrelic:
summary: New Relic
value:
id: newrelic-output
type: newrelic
apiKey: your-api-key
baseUrl: https://insights-collector.newrelic.com
description: Example request body for updating a New Relic
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesNewrelicEvents:
summary: New Relic Events
value:
id: newrelic-events-output
type: newrelic_events
accountId: "123456"
eventType: CriblEvent
apiKey: your-api-key
baseUrl: https://insights-collector.newrelic.com
description: Example request body for updating a New Relic Events
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSnmp:
summary: SNMP
value:
id: snmp-output
type: snmp
hosts:
- host: 192.168.1.1
port: 161
description: Example request body for updating a SNMP Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesInfluxdb:
summary: InfluxDB
value:
id: influxdb-output
type: influxdb
url: http://localhost:8086
database: mydb
description: Example request body for updating a InfluxDB
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesMinio:
summary: MinIO
value:
id: minio-output
type: minio
bucket: my-bucket
stagePath: /tmp/staging
endpoint: http://localhost:9000
description: Example request body for updating a MinIO Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesCloudwatch:
summary: CloudWatch
value:
id: cloudwatch-output
type: cloudwatch
logGroupName: my-log-group
logStreamName: my-log-stream
region: us-east-1
description: Example request body for updating a CloudWatch
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesAzureEventhub:
summary: Azure Event Hub
value:
id: azure-eventhub-output
type: azure_eventhub
brokers:
- myeventhub.servicebus.windows.net:9093
topic: logs
description: Example request body for updating a Azure Event Hub
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesStatsd:
summary: StatsD
value:
id: statsd-output
type: statsd
protocol: udp
host: localhost
port: 8125
description: Example request body for updating a StatsD
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesStatsdExt:
summary: StatsD Extended
value:
id: statsd-ext-output
type: statsd_ext
protocol: udp
host: localhost
port: 8125
description: Example request body for updating a StatsD Extended
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesGraphite:
summary: Graphite
value:
id: graphite-output
type: graphite
protocol: tcp
host: localhost
port: 2003
description: Example request body for updating a Graphite
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesWavefront:
summary: Wavefront
value:
id: wavefront-output
type: wavefront
domain: longboard
endpoint: https://your-instance.wavefront.com
token: your-token
description: Example request body for updating a Wavefront
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSignalfx:
summary: SignalFx
value:
id: signalfx-output
type: signalfx
realm: us0
endpoint: https://ingest.signalfx.com
token: your-token
description: Example request body for updating a SignalFx
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSqs:
summary: SQS
value:
id: sqs-output
type: sqs
queueName: my-queue
queueType: standard
region: us-east-1
description: Example request body for updating a SQS Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesGoogleCloudStorage:
summary: Google Cloud Storage
value:
id: google-cloud-storage-output
type: google_cloud_storage
bucket: my-bucket
endpoint: https://storage.googleapis.com
region: us-east1
stagePath: /tmp/staging
projectId: my-project
description: Example request body for updating a Google Cloud Storage
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSumoLogic:
summary: Sumo Logic
value:
id: sumo-logic-output
type: sumo_logic
url: https://endpoint1.collection.us2.sumologic.com
sourceCategory: logs
description: Example request body for updating a Sumo Logic
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesDatadog:
summary: Datadog
value:
id: datadog-output
type: datadog
endpoint: https://http-intake.logs.datadoghq.com
apiKey: your-api-key
description: Example request body for updating a Datadog
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesWebhook:
summary: Webhook
value:
id: webhook-output
type: webhook
url: https://example.com/webhook
description: Example request body for updating a Webhook
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesPrometheus:
summary: Prometheus
value:
id: prometheus-output
type: prometheus
url: http://localhost:9091/api/v1/write
description: Example request body for updating a Prometheus
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesAmazonManagedPrometheus:
summary: Amazon Managed Service for Prometheus
value:
id: amazon-managed-prometheus-output
type: amazon_managed_prometheus
url: https://aps-workspaces.us-east-1.amazonaws.com/workspaces/ws-example/api/v1/remote_write
region: us-east-1
awsAuthenticationMethod: auto
description: Example request body for updating a Amazon Managed Service for
Prometheus Destination.
The request body must include a
complete representation of the Destination that you want to update. This
endpoint does not support partial updates.
UpdateOutputExamplesGooglePubsub:
summary: Google Pub/Sub
value:
id: google-pubsub-output
type: google_pubsub
projectId: my-project
topicName: my-topic
description: Example request body for updating a Google Pub/Sub
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesGoogleBigQuery:
summary: Google BigQuery
value:
id: google-bigquery-output
type: google_bigquery
projectId: my-project
datasetId: my-dataset
tableId: my-table
googleAuthMethod: auto
description: Example request body for updating a Google BigQuery
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesGoogleChronicle:
summary: Google Chronicle
value:
id: google-chronicle-output
type: google_chronicle
logFormatType: unstructured
region: us
customerId: customer-id
description: Example request body for updating a Google Chronicle
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesChronicle:
summary: Chronicle
value:
id: chronicle-output
type: chronicle
gcpProjectId: my-project
gcpInstance: customer-id
region: us
logType: UNKNOWN
description: Example request body for updating a Chronicle
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesGrafanaCloud:
summary: Grafana Cloud
value:
id: grafana-cloud-output
type: grafana_cloud
lokiUrl: https://logs-prod-us-central1.grafana.net
description: Example request body for updating a Grafana Cloud
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesLoki:
summary: Loki
value:
id: loki-output
type: loki
url: http://localhost:3100/loki/api/v1/push
description: Example request body for updating a Loki Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesOpenTelemetry:
summary: OpenTelemetry
value:
id: opentelemetry-output
type: open_telemetry
endpoint: http://localhost:4317
description: Example request body for updating a OpenTelemetry
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesServiceNow:
summary: ServiceNow
value:
id: servicenow-output
type: service_now
endpoint: ingest.lightstep.com:443
protocol: http
otlpVersion: 1.3.1
tokenSecret: your-token-secret
description: Example request body for updating a ServiceNow
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesDynatraceOtlp:
summary: Dynatrace OTLP
value:
id: dynatrace-otlp-output
type: dynatrace_otlp
endpoint: https://your-environment.live.dynatrace.com/api/v2/otlp
endpointType: saas
protocol: http
otlpVersion: 1.3.1
tokenSecret: your-token-secret
description: Example request body for updating a Dynatrace OTLP
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesGoogleCloudObservability:
summary: Google Cloud Observability
value:
id: google-cloud-observability-output
type: google_cloud_observability
googleAuthMethod: auto
description: Example request body for updating a Google Cloud Observability
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSentinelOneAiSiem:
summary: SentinelOne AI SIEM
value:
id: sentinel-one-ai-siem-output
type: sentinel_one_ai_siem
region: US
endpoint: /services/collector/event
description: Example request body for updating a SentinelOne AI SIEM
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesDataset:
summary: Dataset
value:
id: dataset-output
type: dataset
dataset: my-dataset
description: Example request body for updating a Dataset
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesRing:
summary: Ring Buffer
value:
id: ring-output
type: ring
description: Example request body for updating a Ring Buffer
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesRouter:
summary: Output Router
value:
id: router-output
type: router
rules:
- filter: "true"
output: my-output
description: Example request body for updating a Output Router
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesWizHec:
summary: Wiz Defend
value:
id: wiz-hec-output
type: wiz_hec
data_center: us1
wiz_sourcetype: placeholder
wiz_connector_id: 00000000-0000-0000-0000-000000000000
wiz_environment: test
authType: manual
hecToken: your-hec-token
description: Example request body for updating a Wiz Defend
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesHumioHec:
summary: Humio HEC
value:
id: humio-hec-output
type: humio_hec
url: https://cloud.us.humio.com/api/v1/ingest/hec
format: JSON
authType: manual
token: your-token
description: Example request body for updating a Humio HEC
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesCrowdstrikeNextGenSiem:
summary: CrowdStrike Next Gen SIEM
value:
id: crowdstrike-next-gen-siem-output
type: crowdstrike_next_gen_siem
url: https://ingest.us.crowdstrike.com/api/ingest/hec/connection-id/v1/services/collector
format: JSON
authType: manual
token: your-token
description: Example request body for updating a CrowdStrike Next Gen SIEM
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesCriblHttp:
summary: Cribl HTTP
value:
id: cribl-http-output
type: cribl_http
host: localhost
port: 10080
description: Example request body for updating a Cribl HTTP
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesCriblTcp:
summary: Cribl TCP
value:
id: cribl-tcp-output
type: cribl_tcp
host: localhost
port: 10090
description: Example request body for updating a Cribl TCP
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesCriblSearchEngine:
summary: Cribl Search Engine
value:
id: cribl-search-engine-output
systemFields:
- cribl_pipe
streamtags: []
loadBalanced: false
tls:
disabled: true
tokenTTLMinutes: 60
excludeFields:
- __kube_*
- __metadata
- __winEvent
compression: gzip
concurrency: 5
maxPayloadSizeKB: 4096
maxPayloadEvents: 0
rejectUnauthorized: true
timeoutSec: 30
flushPeriodSec: 1
failedRequestLoggingMode: none
safeHeaders: []
throttleRatePerSec: "0"
responseRetrySettings:
- httpStatus: 401
initialBackoff: 1000
backoffRate: 2
maxBackoff: 20000
- httpStatus: 403
initialBackoff: 1000
backoffRate: 2
maxBackoff: 20000
- httpStatus: 408
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 429
initialBackoff: 1000
backoffRate: 2
maxBackoff: 10000
- httpStatus: 500
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 502
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 503
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 504
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
- httpStatus: 509
initialBackoff: 250
backoffRate: 2
maxBackoff: 10000
timeoutRetrySettings:
timeoutRetry: false
responseHonorRetryAfterHeader: true
onBackpressure: block
useRoundRobinDns: true
type: cribl_search_engine
url: https://0.0.0.0:10200
description: Example request body for updating a Cribl Search Engine
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesGoogleCloudLogging:
summary: Google Cloud Logging
value:
id: google-cloud-logging-output
type: google_cloud_logging
logLocationType: project
logLocationExpression: my-project
logNameExpression: my-log
projectId: my-project
description: Example request body for updating a Google Cloud Logging
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSns:
summary: SNS
value:
id: sns-output
type: sns
topicArn: arn:aws:sns:us-east-1:123456789012:my-topic
messageGroupId: my-message-group
region: us-east-1
description: Example request body for updating a SNS Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesDlS3:
summary: Data Lake S3
value:
id: dl-s3-output
type: dl_s3
bucket: my-bucket
stagePath: /tmp/staging
region: us-east-1
description: Example request body for updating a Data Lake S3
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSecurityLake:
summary: Security Lake
value:
id: security-lake-output
type: security_lake
bucket: my-bucket
stagePath: /tmp/staging
region: us-east-1
accountId: "123456789012"
customSource: my-custom-source
assumeRoleArn: arn:aws:iam::123456789012:role/my-role
description: Example request body for updating a Security Lake
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesCriblLake:
summary: Cribl Lake
value:
id: cribl-lake-output
type: cribl_lake
dataset: my-dataset
description: Example request body for updating a Cribl Lake
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesExabeam:
summary: Exabeam
value:
id: exabeam-output
type: exabeam
bucket: my-bucket
region: us-east1
endpoint: https://storage.googleapis.com
stagePath: /tmp/staging
collectorInstanceId: 11112222-3333-4444-5555-666677778888
description: Example request body for updating a Exabeam
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesDiskSpool:
summary: Disk Spool
value:
id: disk-spool-output
type: disk_spool
path: /var/spool/cribl
description: Example request body for updating a Disk Spool
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesClickHouse:
summary: ClickHouse
value:
id: clickhouse-output
type: click_house
url: http://localhost:8123/
database: mydb
tableName: mytable
description: Example request body for updating a ClickHouse
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesLocalSearchStorage:
summary: Local Search Storage
value:
id: local-search-storage-output
type: local_search_storage
url: http://localhost:8123/
database: default
tableName: mytable
description: Example request body for updating a Local Search Storage
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesCustomerMetricsStorage:
summary: Customer Metrics Storage
value:
id: customer-metrics-storage-output
type: customer_metrics_storage
url: http://localhost:8123/
database: default
tableName: mytable
description: Example request body for updating a Customer Metrics Storage
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesXsiam:
summary: XSIAM
value:
id: xsiam-output
type: xsiam
endpoint: https://api.paloaltonetworks.com
apiKey: your-api-key
description: Example request body for updating a XSIAM Destination.
The
request body must include a complete representation of the Destination
that you want to update. This endpoint does not support partial updates.
UpdateOutputExamplesNetflow:
summary: Netflow
value:
id: netflow-output
type: netflow
hosts:
- host: localhost
port: 2055
description: Example request body for updating a Netflow
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesDynatraceHttp:
summary: Dynatrace HTTP
value:
id: dynatrace-http-output
type: dynatrace_http
format: json_array
endpoint: cloud
telemetryType: logs
authType: token
token: your-api-key
description: Example request body for updating a Dynatrace HTTP
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesDatabricks:
summary: Databricks
value:
id: databricks-output
type: databricks
workspaceId: your-workspace-id
scope: all-apis
clientId: your-client-id
clientTextSecret: your-client-secret
catalog: main
schema: external
eventsVolumeName: events
description: Example request body for updating a Databricks
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
UpdateOutputExamplesSnowflakeStreaming:
summary: Snowflake Streaming
value:
id: snowflake-streaming-output
type: snowflake_streaming
accountIdentifier: MYORG-MYACCOUNT
user: STREAMING_USER
pem:
keyName: my-snowflake-private-key
database: EVENTS_DB
schema: PUBLIC
table: RAW_EVENTS
description: Example request body for updating a Snowflake Streaming
Destination.
The request body must include a complete
representation of the Destination that you want to update. This endpoint
does not support partial updates.
PipelineResponseExamplesEmptyPipeline:
summary: Show an empty Pipeline response
description: Example response for showing an empty Pipeline with no functions.
value:
items:
- id: empty-pipeline
conf:
asyncFuncTimeout: 3000
description: ""
functions: []
count: 1
PipelineResponseExamplesEvalPipeline:
summary: Show an Eval Pipeline response
description: Example response for showing a Pipeline that uses an Eval function
to add fields to events.
value:
items:
- id: eval-pipeline
conf:
asyncFuncTimeout: 3000
description: Adds environment metadata to events.
functions:
- id: eval
filter: "true"
disabled: false
conf:
add:
- name: env
value: "'production'"
count: 1
PipelineExamplesEmpty:
summary: Create a new empty Pipeline
description: Example request body for creating a new Pipeline with no functions.
value:
id: empty-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
functions: []
description: ""
PipelineExamplesAggregations:
summary: Create a Pipeline with an aggregation function that sums rejected bytes
grouped by source address
description: Example request body for creating a Pipeline with an aggregation
function that sums rejected bytes grouped by source address.
value:
id: aggregation-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that aggregates rejected bytes grouped by source address
every 10 seconds
functions:
- id: aggregation
filter: "true"
conf:
passthrough: false
preserveGroupBys: false
sufficientStatsOnly: false
metricsMode: false
timeWindow: 10s
aggregations:
- sum(bytes).where(action=="REJECT").as(TotalBytes)
groupbys:
- srcaddr
cumulative: false
shouldTreatDotsAsLiterals: false
flushOnInputClose: true
PipelineExamplesAggregateMetrics:
summary: Create a Pipeline with an aggregate metrics function that computes
statistics on process metrics
description: Example request body for creating a Pipeline with an aggregate
metrics function that computes statistics on process metrics.
value:
id: aggregate-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: "Pipeline that aggregates process metrics: CPU, memory, and bytes
over time windows"
functions:
- id: aggregate_metrics
filter: (_metric == 'proc.cpu_perc' ||
__criblMetrics[0].nameExpr.includes("'proc.cpu_perc'")) ||
(_metric == 'proc.mem_perc' ||
__criblMetrics[0].nameExpr.includes("'proc.mem_perc'")) ||
(_metric == 'proc.bytes_in' ||
__criblMetrics[0].nameExpr.includes("'proc.bytes_in'"))
conf:
passthrough: false
preserveGroupBys: false
sufficientStatsOnly: false
timeWindow: 10s
aggregations:
- metricType: gauge
agg: avg(_value || proc.cpu_perc).as(proc.cpu_perc_avg)
- metricType: gauge
agg: sum(_value || proc.mem_perc).as(proc.mem_perc_sum)
- metricType: counter
agg: count(_value || proc.bytes_in).as(proc.bytes_in_count)
groupbys:
- proc
cumulative: false
shouldTreatDotsAsLiterals: true
flushOnInputClose: true
PipelineExamplesAutoTimestamp:
summary: Create a Pipeline with an auto timestamp function that extracts
timestamps from event data
description: Example request body for creating a Pipeline with an auto timestamp
function that extracts timestamps from event data.
value:
id: auto-timestamp-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts timestamps from event data using auto
timestamp function
functions:
- id: auto_timestamp
filter: "true"
conf:
srcField: _raw
dstField: _time
defaultTimezone: local
timeExpression: time.getTime() / 1000
offset: 0
maxLen: 150
defaultTime: now
latestDateAllowed: +1week
earliestDateAllowed: -420weeks
timestamps:
- regex: /(\d{1,2}\/\d{2}\/\d{4}\s\d{1,2}:\d{2}:\d{2}\s\w{2})/
strptime: "%Y-%m-%d %H:%M:%S"
PipelineExamplesCEFSerializer:
summary: Create a Pipeline with a CEF serializer function that formats events in
Common Event Format
description: Example request body for creating a Pipeline with a CEF serializer
function that formats events in Common Event Format.
value:
id: cef-serializer-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that formats events in CEF format with custom header and
extension fields
functions:
- id: cef
filter: "true"
conf:
outputField: _raw
header:
- name: cef_version
value: "'CEF:0'"
- name: device_vendor
value: "'Cribl'"
- name: device_product
value: "'Cribl'"
- name: device_version
value: C.version
- name: device_event_class_id
value: "420"
- name: name
value: "'Cribl Event'"
- name: severity
value: "6"
extension:
- name: c6a1Label
value: "'Colorado_Ext_Bldg7'"
PipelineExamplesChain:
summary: Create a Pipeline with a chain function that connects to another
pipeline for sequential processing
description: Example request body for creating a Pipeline with a chain function
that connects to another pipeline for sequential processing.
value:
id: chain-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that chains to another pipeline for sequential data
processing
functions:
- id: chain
filter: "true"
conf:
processor: prometheus_metrics
PipelineExamplesClone:
summary: Create a Pipeline with a clone function that creates copies of events
with additional fields
description: Example request body for creating a Pipeline with a clone function
that creates copies of events with additional fields.
value:
id: clone-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that creates cloned events with additional fields for
comparison or routing
functions:
- id: clone
filter: "true"
conf:
clones:
- env: staging
- index: clones
PipelineExamplesComment:
summary: Create a Pipeline with a comment function that adds documentation
annotations
description: Example request body for creating a Pipeline with a comment
function that adds documentation annotations.
value:
id: comment-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline with comment function for documentation
functions:
- id: comment
filter: "true"
conf:
comment: This function processes security events and enriches them with DNS
lookups
PipelineExamplesDNSLookup:
summary: Create a Pipeline with a DNS lookup function that resolves hostnames
and IP addresses
description: Example request body for creating a Pipeline with a DNS lookup
function that resolves hostnames and IP addresses.
value:
id: dns-lookup-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that performs DNS lookups to resolve hostnames and IP
addresses
functions:
- id: dns_lookup
filter: "true"
conf:
dnsLookupFields:
- inFieldName: hostname
resourceRecordType: A
outFieldName: hostname_ip
reverseLookupFields:
- inFieldName: src_ip
outFieldName: src_hostname
cacheTTL: 30
maxCacheSize: 5000
useResolvConf: false
lookupFallback: false
lookupFailLogLevel: error
PipelineExamplesDrop:
summary: Create a Pipeline with a drop function that filters out events matching
specified criteria
description: Example request body for creating a Pipeline with a drop function
that filters out events matching specified criteria.
value:
id: drop-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that drops events containing success messages
functions:
- id: drop
filter: _raw.search(/success/i)>=0
conf: {}
PipelineExamplesDropDimensions:
summary: Create a Pipeline with a drop dimensions function that reduces metric
cardinality by removing dimensions
description: Example request body for creating a Pipeline with a drop dimensions
function that reduces metric cardinality by removing specified
dimensions.
value:
id: drop-dimensions-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that drops specified dimensions from metrics to reduce
cardinality
functions:
- id: drop_dimensions
filter: (_metric == 'proc.cpu_perc' ||
__criblMetrics[0].nameExpr.includes("'proc.cpu_perc'")) &&
(__criblMetrics[0].dims.includes("proc"))
conf:
timeWindow: 10s
dropDimensions:
- proc
- pie
- unit
flushOnInputClose: true
PipelineExamplesDynamicSampling:
summary: Create a Pipeline with a dynamic sampling function that automatically
adjusts sample rates based on event volume
description: Example request body for creating a Pipeline with a dynamic
sampling function that automatically adjusts sample rates based on event
volume.
value:
id: dynamic-sampling-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that dynamically samples events based on volume using
square root mode
functions:
- id: dynamic_sampling
filter: "true"
conf:
mode: sqrt
keyExpr: "`${domain}:${httpCode}`"
samplePeriod: 20
minEvents: 3
maxSampleRate: 3
PipelineExamplesEval:
summary: Create a Pipeline with an eval function that adds, modifies, and
removes event fields using JavaScript expressions
description: Example request body for creating a Pipeline with an eval function
that adds, modifies, and removes event fields using JavaScript
expressions.
value:
id: eval-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that evaluates JavaScript expressions to add, modify, and
remove fields
functions:
- id: eval
filter: "true"
conf:
add:
- name: action
value: "login == 'error' ? 'blocked' : action"
- name: myTags
value: "login == 'error' ? [...myTags, 'error'] : myTags"
keep:
- host
- source
- action
- myTags
remove:
- identification
PipelineExamplesEventBreaker:
summary: Create a Pipeline with an event breaker function that splits large
blobs or streams into discrete events
description: Example request body for creating a Pipeline with an event breaker
function that splits large blobs or streams into discrete events.
value:
id: event-breaker-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that breaks large event streams into discrete events using
regex
functions:
- id: event_breaker
filter: "true"
conf:
existingOrNew: new
ruleType: regex
eventBreakerRegex: /[\n\r]+(?!\s)/
maxEventBytes: 51200
timestampAnchorRegex: /^/
timestamp:
type: auto
length: 150
timestampTimezone: local
timestampEarliest: -420weeks
timestampLatest: +1week
shouldMarkCriblBreaker: true
PipelineExamplesFlatten:
summary: Create a Pipeline with a flatten function that pulls nested fields up
to a higher level in the object
description: Example request body for creating a Pipeline with a flatten
function that pulls nested fields up to a higher level in the object.
value:
id: flatten-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that flattens nested JSON structures into top-level fields
functions:
- id: flatten
filter: "true"
conf:
fields: []
prefix: ""
depth: 5
delimiter: _
PipelineExamplesFoldKeys:
summary: Create a Pipeline with a fold keys function that transforms flat field
names into nested structures
description: Example request body for creating a Pipeline with a fold keys
function that transforms flat field names into nested structures.
value:
id: fold-keys-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that transforms flat field names with separators into
nested structures
functions:
- id: foldkeys
filter: "true"
conf:
deleteOriginal: true
separator: _
selectionRegExp: ^data
PipelineExamplesGeoIP:
summary: Create a Pipeline with a GeoIP function that enriches events with
geographic information based on IP addresses
description: Example request body for creating a Pipeline with a GeoIP function
that enriches events with geographic information based on IP addresses.
value:
id: geoip-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that enriches events with geolocation data from IP addresses
functions:
- id: geoip
filter: "true"
conf:
file: GeoLite2-City.mmdb
inField: ip
outField: geoip
additionalFields:
- extraInField: src_ip
extraOutField: src_geoip
PipelineExamplesGrok:
summary: Create a Pipeline with a grok function that extracts structured fields
from unstructured log data using named patterns
description: Example request body for creating a Pipeline with a grok function
that extracts structured fields from unstructured log data using named
patterns.
value:
id: grok-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts structured fields from log data using Grok
patterns
functions:
- id: grok
filter: "true"
conf:
pattern: "%{TIMESTAMP_ISO8601:event_time} %{LOGLEVEL:log_level}
%{GREEDYDATA:log_message}"
source: _raw
patternList: []
PipelineExamplesGuard:
summary: Create a Pipeline with a guard function that detects and protects
sensitive data using AI-driven scanning rulesets
description: Example request body for creating a Pipeline with a guard function
that detects and protects sensitive data using AI-driven scanning
rulesets.
value:
id: guard-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that scans for sensitive data and applies mitigation
expressions
functions:
- id: sensitive_data_scanner
filter: "true"
conf:
rules:
- rulesetId: Finance_Global
replaceExpr: "'REDACTED'"
disabled: false
fields:
- _raw
excludeFields: []
flags:
- name: _sensitive
value: "true"
includeDetectedRules: true
PipelineExamplesJSONUnroll:
summary: Create a Pipeline with a JSON unroll function that explodes arrays of
objects into individual events
description: Example request body for creating a Pipeline with a JSON unroll
function that explodes arrays of objects into individual events.
value:
id: json-unroll-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that unrolls JSON arrays into individual events while
retaining parent fields
functions:
- id: json_unroll
filter: "true"
conf:
path: allCars
name: cars
PipelineExamplesLookup:
summary: Create a Pipeline with a lookup function that enriches events with
external fields from lookup tables
description: Example request body for creating a Pipeline with a lookup function
that enriches events with external fields from lookup tables.
value:
id: lookup-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that enriches events with location data from IP address
lookups
functions:
- id: lookup
filter: "true"
conf:
file: ip_locations.csv
dbLookup: false
matchMode: exact
reloadPeriodSec: -1
inFields:
- eventField: destination_ip
lookupField: ip
outFields:
- lookupField: location
eventField: location
defaultValue: Unknown
addToEvent: false
ignoreCase: false
PipelineExamplesMask:
summary: Create a Pipeline with a mask function that redacts sensitive data
using pattern matching and replacement
description: Example request body for creating a Pipeline with a mask function
that redacts sensitive data using pattern matching and replacement.
value:
id: mask-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that masks Social Security numbers and other sensitive data
functions:
- id: mask
filter: "true"
conf:
rules:
- matchRegex: /(social=)(\d+)/
replaceExpr: "`${g1}${C.Mask.md5(g2)}`"
disabled: false
fields:
- _raw
depth: 5
PipelineExamplesNumerify:
summary: Create a Pipeline with a numerify function that converts string number
values to numeric types
description: Example request body for creating a Pipeline with a numerify
function that converts string number values to numeric types for
mathematical operations.
value:
id: numerify-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that converts string numbers to numeric type for
mathematical operations
functions:
- id: numerify
filter: "true"
conf:
depth: 5
ignoreFields: []
filterExpr: ""
format: none
PipelineExamplesOTLPLogs:
summary: Create a Pipeline with an OTLP logs function that normalizes and
batches OpenTelemetry log events
description: Example request body for creating a Pipeline with an OTLP logs
function that normalizes and batches OpenTelemetry log events.
value:
id: otlp-logs-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that normalizes and batches OTLP log events from
OpenTelemetry sources
functions:
- id: otlp_logs
filter: __inputId=='open_telemetry:open_telemetry'
conf:
dropNonLogEvents: false
batchOTLPLogs: true
sendBatchSize: 8192
timeout: 200
sendBatchMaxSize: 0
metadataKeys: []
metadataCardinalityLimit: 1000
PipelineExamplesOTLPMetrics:
summary: Create a Pipeline with an OTLP metrics function that converts
dimensional metrics to OpenTelemetry format
description: Example request body for creating a Pipeline with an OTLP metrics
function that converts dimensional metrics to OpenTelemetry format.
value:
id: otlp-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that converts dimensional metrics to OTLP format and
batches them by resource attributes
functions:
- id: otlp_metrics
filter: __inputId=='prometheus_rw:prom_rw_in'
conf:
resourceAttributePrefixes:
- service
- system
- telemetry
- k8s
- cloud
- host
- process
dropNonMetricEvents: false
otlpVersion: 0.10.0
batchOTLPMetrics: true
sendBatchSize: 8192
timeout: 200
sendBatchMaxSize: 0
metadataKeys: []
metadataCardinalityLimit: 1000
PipelineExamplesOTLPTraces:
summary: Create a Pipeline with an OTLP traces function that normalizes and
batches OpenTelemetry trace events
description: Example request body for creating a Pipeline with an OTLP traces
function that normalizes and batches OpenTelemetry trace events.
value:
id: otlp-traces-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that normalizes and batches OTLP trace events from
OpenTelemetry sources
functions:
- id: otlp_traces
filter: __inputId=='open_telemetry:open_telemetry'
conf:
dropNonTraceEvents: false
otlpVersion: 0.10.0
batchOTLPTraces: true
sendBatchSize: 8192
timeout: 200
sendBatchMaxSize: 0
metadataKeys: []
metadataCardinalityLimit: 1000
PipelineExamplesParser:
summary: Create a Pipeline with a parser function that extracts fields from
key-value pairs
description: Example request body for creating a Pipeline with a parser function
that extracts fields from key-value pair formatted data.
value:
id: parser-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts fields from key-value pair formatted data
functions:
- id: serde
filter: "true"
conf:
mode: extract
type: kvp
srcField: _raw
keep:
- a
- b
- c
remove:
- "*"
cleanFields: false
PipelineExamplesPublishMetrics:
summary: Create a Pipeline with a publish metrics function that extracts and
formats metrics from events
description: Example request body for creating a Pipeline with a publish metrics
function that extracts and formats metrics from events for aggregation
platforms.
value:
id: publish-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts metrics from events and formats them for
metrics aggregation platforms
functions:
- id: publish_metrics
filter: "true"
conf:
fields:
- inFieldName: bytes
outFieldExpr: "'metric_name.bytes'"
metricType: gauge
- inFieldName: packets
outFieldExpr: "'metric_name.packets'"
metricType: gauge
overwrite: false
dimensions:
- action
- interface_id
- dstaddr
removeMetrics: []
removeDimensions: []
PipelineExamplesRedis:
summary: Create a Pipeline with a Redis function that interacts with Redis
stores using GET and SET commands
description: Example request body for creating a Pipeline with a Redis function
that interacts with Redis stores using GET and SET commands.
value:
id: redis-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that retrieves values from Redis using GET command
functions:
- id: redis
filter: "true"
conf:
commands:
- outField: cached_value
command: get
keyExpr: "'user_session'"
argsExpr: ""
deploymentType: standalone
url: "'redis://localhost:6379/0'"
authType: none
maxBlockSecs: 60
PipelineExamplesRegexExtract:
summary: Create a Pipeline with a regex extract function that extracts fields
from events using regular expressions with named capture groups
description: Example request body for creating a Pipeline with a regex extract
function that extracts fields from events using regular expressions with
named capture groups.
value:
id: regex-extract-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts structured fields from log data using regex
patterns with named capture groups
functions:
- id: regex_extract
filter: "true"
conf:
regex: /metric1=(?\d+)/
source: _raw
iterations: 100
overwrite: false
PipelineExamplesRegexFilter:
summary: Create a Pipeline with a regex filter function that filters out events
based on regular expression matches
description: Example request body for creating a Pipeline with a regex filter
function that filters out events based on regular expression matches.
value:
id: regex-filter-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that filters out events matching specific regex patterns
functions:
- id: regex_filter
filter: "true"
conf:
regex: /Opera/
field: _raw
PipelineExamplesRename:
summary: Create a Pipeline with a rename function that changes or reformats
field names within events
description: Example request body for creating a Pipeline with a rename function
that changes or reformats field names within events.
value:
id: rename-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that renames fields using key-value pairs and expressions
functions:
- id: rename
filter: "true"
conf:
rename:
- currentName: level
newName: LEVEL
renameExpr: "name.startsWith('out') ? name.toUpperCase() : name"
baseFields: []
wildcardDepth: 5
PipelineExamplesRollupMetrics:
summary: Create a Pipeline with a rollup metrics function that consolidates
high-frequency metrics into time windows
description: Example request body for creating a Pipeline with a rollup metrics
function that consolidates high-frequency metrics into manageable time
windows.
value:
id: rollup-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that consolidates high-frequency metrics into manageable
time windows
functions:
- id: rollup_metrics
filter: "true"
conf:
dimensions:
- "*"
timeWindow: 30s
gaugeRollup: last
PipelineExamplesSampling:
summary: Create a Pipeline with a sampling function that filters events based on
criteria and sampling rates
description: Example request body for creating a Pipeline with a sampling
function that filters events based on criteria and sampling rates.
value:
id: sampling-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that samples events at specified rates based on filter
criteria
functions:
- id: sampling
filter: "true"
conf:
rules:
- filter: __status == 200
rate: 5
PipelineExamplesSerialize:
summary: Create a Pipeline with a serialize function that converts event content
into predefined formats
description: Example request body for creating a Pipeline with a serialize
function that converts event content into predefined formats.
value:
id: serialize-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that serializes event fields into JSON format
functions:
- id: serialize
filter: "true"
conf:
type: json
fields:
- city
- state
srcField: ""
dstField: _raw
PipelineExamplesSNMPTrapSerialize:
summary: Create a Pipeline with an SNMP trap serialize function that converts
compliant events into SNMP trap format
description: Example request body for creating a Pipeline with an SNMP trap
serialize function that converts compliant events into SNMP trap format.
value:
id: snmp-trap-serialize-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that serializes events into SNMP trap format for SNMP trap
destinations
functions:
- id: snmp_trap_serialize
filter: "true"
conf:
strict: true
dropFailedEvents: true
PipelineExamplesSuppress:
summary: Create a Pipeline with a suppress function that suppresses duplicate
events based on key expressions
description: Example request body for creating a Pipeline with a suppress
function that suppresses duplicate events based on key expressions.
value:
id: suppress-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that suppresses duplicate events based on a key expression
functions:
- id: suppress
filter: "true"
conf:
keyExpr: "`${ip}:${port}`"
allow: 1
suppressPeriodSec: 30
dropEventsMode: true
maxCacheSize: 50000
cacheIdleTimeoutPeriods: 2
numEventsIdleTimeoutTrigger: 10000
PipelineExamplesTee:
summary: Create a Pipeline with a tee function that sends events to an external
command via stdin for debugging and verification
description: Example request body for creating a Pipeline with a tee function
that sends events to an external command via stdin for debugging and
verification.
value:
id: tee-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that sends events to a command via stdin for debugging
purposes
functions:
- id: tee
filter: "true"
conf:
command: tee
args:
- /opt/cribl/foo.log
restartOnExit: true
env: {}
PipelineExamplesUnroll:
summary: Create a Pipeline with an unroll function that breaks array fields into
individual events
description: Example request body for creating a Pipeline with an unroll
function that breaks array fields into individual events.
value:
id: unroll-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that unrolls array fields into separate events
functions:
- id: unroll
filter: "true"
conf:
srcExpr: _raw.split(/\n/)
dstField: _raw
PipelineExamplesXMLUnroll:
summary: Create a Pipeline with an XML unroll function that converts XML
elements into individual events
description: Example request body for creating a Pipeline with an XML unroll
function that converts XML elements into individual events.
value:
id: xml-unroll-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that unrolls XML elements into separate events
functions:
- id: xml_unroll
filter: "true"
conf:
unroll: ^Parent\.Child$
inherit: ^Parent\.(myID|branchLocation)$
unrollIdxField: unroll_idx
pretty: false
UpdatePipelineExamplesEmpty:
summary: Update an empty Pipeline
description: Example request body for updating an existing Pipeline with no
functions.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: empty-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
functions: []
description: ""
UpdatePipelineExamplesAggregations:
summary: Update a Pipeline with an aggregation function that sums rejected bytes
grouped by source address
description: Example request body for updating a Pipeline with an aggregation
function that sums rejected bytes grouped by source
address.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: aggregation-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that aggregates rejected bytes grouped by source address
every 10 seconds
functions:
- id: aggregation
filter: "true"
conf:
passthrough: false
preserveGroupBys: false
sufficientStatsOnly: false
metricsMode: false
timeWindow: 10s
aggregations:
- sum(bytes).where(action=="REJECT").as(TotalBytes)
groupbys:
- srcaddr
cumulative: false
shouldTreatDotsAsLiterals: false
flushOnInputClose: true
UpdatePipelineExamplesAggregateMetrics:
summary: Update a Pipeline with an aggregate metrics function that computes
statistics on process metrics
description: Example request body for updating a Pipeline with an aggregate
metrics function that computes statistics on process
metrics.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: aggregate-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: "Pipeline that aggregates process metrics: CPU, memory, and bytes
over time windows"
functions:
- id: aggregate_metrics
filter: (_metric == 'proc.cpu_perc' ||
__criblMetrics[0].nameExpr.includes("'proc.cpu_perc'")) ||
(_metric == 'proc.mem_perc' ||
__criblMetrics[0].nameExpr.includes("'proc.mem_perc'")) ||
(_metric == 'proc.bytes_in' ||
__criblMetrics[0].nameExpr.includes("'proc.bytes_in'"))
conf:
passthrough: false
preserveGroupBys: false
sufficientStatsOnly: false
timeWindow: 10s
aggregations:
- metricType: gauge
agg: avg(_value || proc.cpu_perc).as(proc.cpu_perc_avg)
- metricType: gauge
agg: sum(_value || proc.mem_perc).as(proc.mem_perc_sum)
- metricType: counter
agg: count(_value || proc.bytes_in).as(proc.bytes_in_count)
groupbys:
- proc
cumulative: false
shouldTreatDotsAsLiterals: true
flushOnInputClose: true
UpdatePipelineExamplesAutoTimestamp:
summary: Update a Pipeline with an auto timestamp function that extracts
timestamps from event data
description: Example request body for updating a Pipeline with an auto timestamp
function that extracts timestamps from event data.
The request
body must include a complete representation of the Pipeline that you
want to update. This endpoint does not support partial updates.
value:
id: auto-timestamp-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts timestamps from event data using auto
timestamp function
functions:
- id: auto_timestamp
filter: "true"
conf:
srcField: _raw
dstField: _time
defaultTimezone: local
timeExpression: time.getTime() / 1000
offset: 0
maxLen: 150
defaultTime: now
latestDateAllowed: +1week
earliestDateAllowed: -420weeks
timestamps:
- regex: /(\d{1,2}\/\d{2}\/\d{4}\s\d{1,2}:\d{2}:\d{2}\s\w{2})/
strptime: "%Y-%m-%d %H:%M:%S"
UpdatePipelineExamplesCEFSerializer:
summary: Update a Pipeline with a CEF serializer function that formats events in
Common Event Format
description: Example request body for updating a Pipeline with a CEF serializer
function that formats events in Common Event Format.
The
request body must include a complete representation of the Pipeline that
you want to update. This endpoint does not support partial updates.
value:
id: cef-serializer-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that formats events in CEF format with custom header and
extension fields
functions:
- id: cef
filter: "true"
conf:
outputField: _raw
header:
- name: cef_version
value: "'CEF:0'"
- name: device_vendor
value: "'Cribl'"
- name: device_product
value: "'Cribl'"
- name: device_version
value: C.version
- name: device_event_class_id
value: "420"
- name: name
value: "'Cribl Event'"
- name: severity
value: "6"
extension:
- name: c6a1Label
value: "'Colorado_Ext_Bldg7'"
UpdatePipelineExamplesChain:
summary: Update a Pipeline with a chain function that connects to another
pipeline for sequential processing
description: Example request body for updating a Pipeline with a chain function
that connects to another pipeline for sequential
processing.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: chain-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that chains to another pipeline for sequential data
processing
functions:
- id: chain
filter: "true"
conf:
processor: prometheus_metrics
UpdatePipelineExamplesClone:
summary: Update a Pipeline with a clone function that creates copies of events
with additional fields
description: Example request body for updating a Pipeline with a clone function
that creates copies of events with additional fields.
The
request body must include a complete representation of the Pipeline that
you want to update. This endpoint does not support partial updates.
value:
id: clone-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that creates cloned events with additional fields for
comparison or routing
functions:
- id: clone
filter: "true"
conf:
clones:
- env: staging
- index: clones
UpdatePipelineExamplesComment:
summary: Update a Pipeline with a comment function that adds documentation
annotations
description: Example request body for updating a Pipeline with a comment
function that adds documentation annotations.
The request body
must include a complete representation of the Pipeline that you want to
update. This endpoint does not support partial updates.
value:
id: comment-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline with comment function for documentation
functions:
- id: comment
filter: "true"
conf:
comment: This function processes security events and enriches them with DNS
lookups
UpdatePipelineExamplesDNSLookup:
summary: Update a Pipeline with a DNS lookup function that resolves hostnames
and IP addresses
description: Example request body for updating a Pipeline with a DNS lookup
function that resolves hostnames and IP addresses.
The request
body must include a complete representation of the Pipeline that you
want to update. This endpoint does not support partial updates.
value:
id: dns-lookup-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that performs DNS lookups to resolve hostnames and IP
addresses
functions:
- id: dns_lookup
filter: "true"
conf:
dnsLookupFields:
- inFieldName: hostname
resourceRecordType: A
outFieldName: hostname_ip
reverseLookupFields:
- inFieldName: src_ip
outFieldName: src_hostname
cacheTTL: 30
maxCacheSize: 5000
useResolvConf: false
lookupFallback: false
lookupFailLogLevel: error
UpdatePipelineExamplesDrop:
summary: Update a Pipeline with a drop function that filters out events matching
specified criteria
description: Example request body for updating a Pipeline with a drop function
that filters out events matching specified criteria.
The
request body must include a complete representation of the Pipeline that
you want to update. This endpoint does not support partial updates.
value:
id: drop-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that drops events containing success messages
functions:
- id: drop
filter: _raw.search(/success/i)>=0
conf: {}
UpdatePipelineExamplesDropDimensions:
summary: Update a Pipeline with a drop dimensions function that reduces metric
cardinality by removing dimensions
description: Example request body for updating a Pipeline with a drop dimensions
function that reduces metric cardinality by removing specified
dimensions.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: drop-dimensions-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that drops specified dimensions from metrics to reduce
cardinality
functions:
- id: drop_dimensions
filter: (_metric == 'proc.cpu_perc' ||
__criblMetrics[0].nameExpr.includes("'proc.cpu_perc'")) &&
(__criblMetrics[0].dims.includes("proc"))
conf:
timeWindow: 10s
dropDimensions:
- proc
- pie
- unit
flushOnInputClose: true
UpdatePipelineExamplesDynamicSampling:
summary: Update a Pipeline with a dynamic sampling function that automatically
adjusts sample rates based on event volume
description: Example request body for updating a Pipeline with a dynamic
sampling function that automatically adjusts sample rates based on event
volume.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: dynamic-sampling-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that dynamically samples events based on volume using
square root mode
functions:
- id: dynamic_sampling
filter: "true"
conf:
mode: sqrt
keyExpr: "`${domain}:${httpCode}`"
samplePeriod: 20
minEvents: 3
maxSampleRate: 3
UpdatePipelineExamplesEval:
summary: Update a Pipeline with an eval function that adds, modifies, and
removes event fields using JavaScript expressions
description: Example request body for updating a Pipeline with an eval function
that adds, modifies, and removes event fields using JavaScript
expressions.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: eval-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that evaluates JavaScript expressions to add, modify, and
remove fields
functions:
- id: eval
filter: "true"
conf:
add:
- name: action
value: "login == 'error' ? 'blocked' : action"
- name: myTags
value: "login == 'error' ? [...myTags, 'error'] : myTags"
keep:
- host
- source
- action
- myTags
remove:
- identification
UpdatePipelineExamplesEventBreaker:
summary: Update a Pipeline with an event breaker function that splits large
blobs or streams into discrete events
description: Example request body for updating a Pipeline with an event breaker
function that splits large blobs or streams into discrete
events.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: event-breaker-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that breaks large event streams into discrete events using
regex
functions:
- id: event_breaker
filter: "true"
conf:
existingOrNew: new
ruleType: regex
eventBreakerRegex: /[\n\r]+(?!\s)/
maxEventBytes: 51200
timestampAnchorRegex: /^/
timestamp:
type: auto
length: 150
timestampTimezone: local
timestampEarliest: -420weeks
timestampLatest: +1week
shouldMarkCriblBreaker: true
UpdatePipelineExamplesFlatten:
summary: Update a Pipeline with a flatten function that pulls nested fields up
to a higher level in the object
description: Example request body for updating a Pipeline with a flatten
function that pulls nested fields up to a higher level in the
object.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: flatten-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that flattens nested JSON structures into top-level fields
functions:
- id: flatten
filter: "true"
conf:
fields: []
prefix: ""
depth: 5
delimiter: _
UpdatePipelineExamplesFoldKeys:
summary: Update a Pipeline with a fold keys function that transforms flat field
names into nested structures
description: Example request body for updating a Pipeline with a fold keys
function that transforms flat field names into nested
structures.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: fold-keys-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that transforms flat field names with separators into
nested structures
functions:
- id: foldkeys
filter: "true"
conf:
deleteOriginal: true
separator: _
selectionRegExp: ^data
UpdatePipelineExamplesGeoIP:
summary: Update a Pipeline with a GeoIP function that enriches events with
geographic information based on IP addresses
description: Example request body for updating a Pipeline with a GeoIP function
that enriches events with geographic information based on IP
addresses.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: geoip-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that enriches events with geolocation data from IP addresses
functions:
- id: geoip
filter: "true"
conf:
file: GeoLite2-City.mmdb
inField: ip
outField: geoip
additionalFields:
- extraInField: src_ip
extraOutField: src_geoip
UpdatePipelineExamplesGrok:
summary: Update a Pipeline with a grok function that extracts structured fields
from unstructured log data using named patterns
description: Example request body for updating a Pipeline with a grok function
that extracts structured fields from unstructured log data using named
patterns.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: grok-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts structured fields from log data using Grok
patterns
functions:
- id: grok
filter: "true"
conf:
pattern: "%{TIMESTAMP_ISO8601:event_time} %{LOGLEVEL:log_level}
%{GREEDYDATA:log_message}"
source: _raw
patternList: []
UpdatePipelineExamplesGuard:
summary: Update a Pipeline with a guard function that detects and protects
sensitive data using AI-driven scanning rulesets
description: Example request body for updating a Pipeline with a guard function
that detects and protects sensitive data using AI-driven scanning
rulesets.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: guard-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that scans for sensitive data and applies mitigation
expressions
functions:
- id: sensitive_data_scanner
filter: "true"
conf:
rules:
- rulesetId: Finance_Global
replaceExpr: "'REDACTED'"
disabled: false
fields:
- _raw
excludeFields: []
flags:
- name: _sensitive
value: "true"
includeDetectedRules: true
UpdatePipelineExamplesJSONUnroll:
summary: Update a Pipeline with a JSON unroll function that explodes arrays of
objects into individual events
description: Example request body for updating a Pipeline with a JSON unroll
function that explodes arrays of objects into individual
events.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: json-unroll-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that unrolls JSON arrays into individual events while
retaining parent fields
functions:
- id: json_unroll
filter: "true"
conf:
path: allCars
name: cars
UpdatePipelineExamplesLookup:
summary: Update a Pipeline with a lookup function that enriches events with
external fields from lookup tables
description: Example request body for updating a Pipeline with a lookup function
that enriches events with external fields from lookup
tables.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: lookup-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that enriches events with location data from IP address
lookups
functions:
- id: lookup
filter: "true"
conf:
file: ip_locations.csv
dbLookup: false
matchMode: exact
reloadPeriodSec: -1
inFields:
- eventField: destination_ip
lookupField: ip
outFields:
- lookupField: location
eventField: location
defaultValue: Unknown
addToEvent: false
ignoreCase: false
UpdatePipelineExamplesMask:
summary: Update a Pipeline with a mask function that redacts sensitive data
using pattern matching and replacement
description: Example request body for updating a Pipeline with a mask function
that redacts sensitive data using pattern matching and
replacement.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: mask-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that masks Social Security numbers and other sensitive data
functions:
- id: mask
filter: "true"
conf:
rules:
- matchRegex: /(social=)(\d+)/
replaceExpr: "`${g1}${C.Mask.md5(g2)}`"
disabled: false
fields:
- _raw
depth: 5
UpdatePipelineExamplesNumerify:
summary: Update a Pipeline with a numerify function that converts string number
values to numeric types
description: Example request body for updating a Pipeline with a numerify
function that converts string number values to numeric types for
mathematical operations.
The request body must include a
complete representation of the Pipeline that you want to update. This
endpoint does not support partial updates.
value:
id: numerify-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that converts string numbers to numeric type for
mathematical operations
functions:
- id: numerify
filter: "true"
conf:
depth: 5
ignoreFields: []
filterExpr: ""
format: none
UpdatePipelineExamplesOTLPLogs:
summary: Update a Pipeline with an OTLP logs function that normalizes and
batches OpenTelemetry log events
description: Example request body for updating a Pipeline with an OTLP logs
function that normalizes and batches OpenTelemetry log
events.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: otlp-logs-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that normalizes and batches OTLP log events from
OpenTelemetry sources
functions:
- id: otlp_logs
filter: __inputId=='open_telemetry:open_telemetry'
conf:
dropNonLogEvents: false
batchOTLPLogs: true
sendBatchSize: 8192
timeout: 200
sendBatchMaxSize: 0
metadataKeys: []
metadataCardinalityLimit: 1000
UpdatePipelineExamplesOTLPMetrics:
summary: Update a Pipeline with an OTLP metrics function that converts
dimensional metrics to OpenTelemetry format
description: Example request body for updating a Pipeline with an OTLP metrics
function that converts dimensional metrics to OpenTelemetry
format.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: otlp-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that converts dimensional metrics to OTLP format and
batches them by resource attributes
functions:
- id: otlp_metrics
filter: __inputId=='prometheus_rw:prom_rw_in'
conf:
resourceAttributePrefixes:
- service
- system
- telemetry
- k8s
- cloud
- host
- process
dropNonMetricEvents: false
otlpVersion: 0.10.0
batchOTLPMetrics: true
sendBatchSize: 8192
timeout: 200
sendBatchMaxSize: 0
metadataKeys: []
metadataCardinalityLimit: 1000
UpdatePipelineExamplesOTLPTraces:
summary: Update a Pipeline with an OTLP traces function that normalizes and
batches OpenTelemetry trace events
description: Example request body for updating a Pipeline with an OTLP traces
function that normalizes and batches OpenTelemetry trace
events.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: otlp-traces-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that normalizes and batches OTLP trace events from
OpenTelemetry sources
functions:
- id: otlp_traces
filter: __inputId=='open_telemetry:open_telemetry'
conf:
dropNonTraceEvents: false
otlpVersion: 0.10.0
batchOTLPTraces: true
sendBatchSize: 8192
timeout: 200
sendBatchMaxSize: 0
metadataKeys: []
metadataCardinalityLimit: 1000
UpdatePipelineExamplesParser:
summary: Update a Pipeline with a parser function that extracts fields from
key-value pairs
description: Example request body for updating a Pipeline with a parser function
that extracts fields from key-value pair formatted data.
The
request body must include a complete representation of the Pipeline that
you want to update. This endpoint does not support partial updates.
value:
id: parser-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts fields from key-value pair formatted data
functions:
- id: serde
filter: "true"
conf:
mode: extract
type: kvp
srcField: _raw
keep:
- a
- b
- c
remove:
- "*"
cleanFields: false
UpdatePipelineExamplesPublishMetrics:
summary: Update a Pipeline with a publish metrics function that extracts and
formats metrics from events
description: Example request body for updating a Pipeline with a publish metrics
function that extracts and formats metrics from events for aggregation
platforms.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: publish-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts metrics from events and formats them for
metrics aggregation platforms
functions:
- id: publish_metrics
filter: "true"
conf:
fields:
- inFieldName: bytes
outFieldExpr: "'metric_name.bytes'"
metricType: gauge
- inFieldName: packets
outFieldExpr: "'metric_name.packets'"
metricType: gauge
overwrite: false
dimensions:
- action
- interface_id
- dstaddr
removeMetrics: []
removeDimensions: []
UpdatePipelineExamplesRedis:
summary: Update a Pipeline with a Redis function that interacts with Redis
stores using GET and SET commands
description: Example request body for updating a Pipeline with a Redis function
that interacts with Redis stores using GET and SET
commands.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: redis-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that retrieves values from Redis using GET command
functions:
- id: redis
filter: "true"
conf:
commands:
- outField: cached_value
command: get
keyExpr: "'user_session'"
argsExpr: ""
deploymentType: standalone
url: "'redis://localhost:6379/0'"
authType: none
maxBlockSecs: 60
UpdatePipelineExamplesRegexExtract:
summary: Update a Pipeline with a regex extract function that extracts fields
from events using regular expressions with named capture groups
description: Example request body for updating a Pipeline with a regex extract
function that extracts fields from events using regular expressions with
named capture groups.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: regex-extract-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that extracts structured fields from log data using regex
patterns with named capture groups
functions:
- id: regex_extract
filter: "true"
conf:
regex: /metric1=(?\d+)/
source: _raw
iterations: 100
overwrite: false
UpdatePipelineExamplesRegexFilter:
summary: Update a Pipeline with a regex filter function that filters out events
based on regular expression matches
description: Example request body for updating a Pipeline with a regex filter
function that filters out events based on regular expression
matches.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: regex-filter-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that filters out events matching specific regex patterns
functions:
- id: regex_filter
filter: "true"
conf:
regex: /Opera/
field: _raw
UpdatePipelineExamplesRename:
summary: Update a Pipeline with a rename function that changes or reformats
field names within events
description: Example request body for updating a Pipeline with a rename function
that changes or reformats field names within events.
The
request body must include a complete representation of the Pipeline that
you want to update. This endpoint does not support partial updates.
value:
id: rename-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that renames fields using key-value pairs and expressions
functions:
- id: rename
filter: "true"
conf:
rename:
- currentName: level
newName: LEVEL
renameExpr: "name.startsWith('out') ? name.toUpperCase() : name"
baseFields: []
wildcardDepth: 5
UpdatePipelineExamplesRollupMetrics:
summary: Update a Pipeline with a rollup metrics function that consolidates
high-frequency metrics into time windows
description: Example request body for updating a Pipeline with a rollup metrics
function that consolidates high-frequency metrics into manageable time
windows.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: rollup-metrics-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that consolidates high-frequency metrics into manageable
time windows
functions:
- id: rollup_metrics
filter: "true"
conf:
dimensions:
- "*"
timeWindow: 30s
gaugeRollup: last
UpdatePipelineExamplesSampling:
summary: Update a Pipeline with a sampling function that filters events based on
criteria and sampling rates
description: Example request body for updating a Pipeline with a sampling
function that filters events based on criteria and sampling
rates.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: sampling-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that samples events at specified rates based on filter
criteria
functions:
- id: sampling
filter: "true"
conf:
rules:
- filter: __status == 200
rate: 5
UpdatePipelineExamplesSerialize:
summary: Update a Pipeline with a serialize function that converts event content
into predefined formats
description: Example request body for updating a Pipeline with a serialize
function that converts event content into predefined
formats.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: serialize-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that serializes event fields into JSON format
functions:
- id: serialize
filter: "true"
conf:
type: json
fields:
- city
- state
srcField: ""
dstField: _raw
UpdatePipelineExamplesSNMPTrapSerialize:
summary: Update a Pipeline with an SNMP trap serialize function that converts
compliant events into SNMP trap format
description: Example request body for updating a Pipeline with an SNMP trap
serialize function that converts compliant events into SNMP trap
format.
The request body must include a complete representation
of the Pipeline that you want to update. This endpoint does not support
partial updates.
value:
id: snmp-trap-serialize-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that serializes events into SNMP trap format for SNMP trap
destinations
functions:
- id: snmp_trap_serialize
filter: "true"
conf:
strict: true
dropFailedEvents: true
UpdatePipelineExamplesSuppress:
summary: Update a Pipeline with a suppress function that suppresses duplicate
events based on key expressions
description: Example request body for updating a Pipeline with a suppress
function that suppresses duplicate events based on key
expressions.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: suppress-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that suppresses duplicate events based on a key expression
functions:
- id: suppress
filter: "true"
conf:
keyExpr: "`${ip}:${port}`"
allow: 1
suppressPeriodSec: 30
dropEventsMode: true
maxCacheSize: 50000
cacheIdleTimeoutPeriods: 2
numEventsIdleTimeoutTrigger: 10000
UpdatePipelineExamplesTee:
summary: Update a Pipeline with a tee function that sends events to an external
command via stdin for debugging and verification
description: Example request body for updating a Pipeline with a tee function
that sends events to an external command via stdin for debugging and
verification.
The request body must include a complete
representation of the Pipeline that you want to update. This endpoint
does not support partial updates.
value:
id: tee-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that sends events to a command via stdin for debugging
purposes
functions:
- id: tee
filter: "true"
conf:
command: tee
args:
- /opt/cribl/foo.log
restartOnExit: true
env: {}
UpdatePipelineExamplesUnroll:
summary: Update a Pipeline with an unroll function that breaks array fields into
individual events
description: Example request body for updating a Pipeline with an unroll
function that breaks array fields into individual events.
The
request body must include a complete representation of the Pipeline that
you want to update. This endpoint does not support partial updates.
value:
id: unroll-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that unrolls array fields into separate events
functions:
- id: unroll
filter: "true"
conf:
srcExpr: _raw.split(/\n/)
dstField: _raw
UpdatePipelineExamplesXMLUnroll:
summary: Update a Pipeline with an XML unroll function that converts XML
elements into individual events
description: Example request body for updating a Pipeline with an XML unroll
function that converts XML elements into individual events.
The
request body must include a complete representation of the Pipeline that
you want to update. This endpoint does not support partial updates.
value:
id: xml-unroll-pipeline
conf:
output: default
streamtags: []
groups: {}
asyncFuncTimeout: 1000
description: Pipeline that unrolls XML elements into separate events
functions:
- id: xml_unroll
filter: "true"
conf:
unroll: ^Parent\.Child$
inherit: ^Parent\.(myID|branchLocation)$
unrollIdxField: unroll_idx
pretty: false
RoutesResponseExamplesDefaultRoutingTable:
summary: Default Routing table response
description: Example response for listing the default Routing table with a
single pass-through Route.
value:
count: 1
items:
- id: default
routes:
- id: default
name: default
final: true
disabled: false
pipeline: main
filter: "true"
output: default
RoutesResponseExamplesMultiRouteTable:
summary: Multi-route Routing table response
description: Example response for listing a Routing table with multiple Routes
that send events to different Pipelines.
value:
count: 1
items:
- id: default
routes:
- id: route-security
name: Security events
final: false
disabled: false
pipeline: security-pipeline
filter: sourcetype=='syslog'
output: splunk-hec
- id: default
name: default
final: true
disabled: false
pipeline: main
filter: "true"
output: default
RoutesUpdateExamplesBasicRoute:
summary: Update Routes with a basic Route configuration
description: "Example request body for updating the default Routes table
(id: default) with a simple Route that filters access.log
events and sends them to the main Pipeline.
The request body
must include a complete representation of the Routing table that you
want to update. This endpoint does not support partial updates."
value:
id: default
routes:
- id: default
name: my-route
pipeline: main
filter: source == "access.log"
description: Route access logs to main Pipeline
final: true
RoutesUpdateExamplesMultipleRoutes:
summary: Update Routes with multiple Routes and a catch-all
description: "Example request body for updating the default Routes table
(id: default) with multiple specific Routes evaluated in
order, followed by a default catch-all Route.
The request body
must include a complete representation of the Routing table that you
want to update. This endpoint does not support partial updates."
value:
id: default
routes:
- id: route-speedtest
name: speedtest
pipeline: main
output: default
filter: source == "speedtest.log"
description: Route speedtest logs
final: false
- id: route-mtr
name: mtr
pipeline: passthru
output: default
filter: source == "mtr.log"
description: Route mtr logs
final: false
- id: route-statsd
name: statsd
pipeline: prometheus_metrics
output: devnull
filter: source == "statsd.log"
description: Route statsd metrics
final: false
- id: route-default
name: default
pipeline: main
output: default
filter: "true"
description: Catch-all Route for all other events
final: true
RoutesUpdateExamplesRouteWithOutputExpression:
summary: Update Routes with dynamic Destination expression
description: "Example request body for updating the default Routes table
(id: default) with a Route that uses a JavaScript
expression to dynamically determine the Destination.
The
request body must include a complete representation of the Routing table
that you want to update. This endpoint does not support partial
updates."
value:
id: default
routes:
- id: route-dynamic
name: dynamic-output
pipeline: main
enableOutputExpression: true
outputExpression: "`myDest_${C.logStreamEnv}`"
filter: source == "dynamic.log"
description: Route with dynamic Destination based on environment
final: true
RoutesUpdateExamplesRouteWithDefaults:
summary: Update the basic Route configuration
description: "Example request body for updating the default Routes table
(id: default) with a basic Route that omits the
id and final fields. The server generates a
deterministic id and sets final to
true by default.
The request body must include a
complete representation of the Routing table that you want to update.
This endpoint does not support partial updates."
value:
id: default
routes:
- name: my-route
pipeline: main
filter: source == "access.log"
description: Route access logs to main Pipeline
RoutesAppendExamplesSingleRoute:
summary: Append a single Route to the Routing table
description: "Example request body for appending a single Route to the end of
the default Routing table (id: default)."
value:
- id: route-new
name: new-route
pipeline: main
filter: source == "new.log"
description: Route new logs to main pipeline
final: true
RoutesAppendExamplesMultipleRoutes:
summary: Append multiple Routes to the Routing table
description: "Example request body for appending multiple Routes to the end of
the default Routing table (id: default) in a single
request."
value:
- id: route-audit
name: audit
pipeline: main
output: default
filter: source == "audit.log"
description: Route audit logs
final: false
- id: route-security
name: security
pipeline: passthru
output: devnull
filter: source == "security.log"
description: Route security logs
final: false
RoutesAppendExamplesRouteWithOutputExpression:
summary: Append a Route with dynamic Destination expression
description: "Example request body for appending a Route to the end of the
default Routing table (id: default) that uses a JavaScript
expression to dynamically determine the Destination at Route startup."
value:
- id: route-dynamic-append
name: dynamic-append
pipeline: main
enableOutputExpression: true
outputExpression: "`myDest_${C.logStreamEnv}`"
filter: source == "dynamic.log"
description: Route with dynamic Destination based on environment
final: true
RoutesAppendExamplesRouteWithDefaults:
summary: Append a Route omitting optional id and final fields
description: "Example request body for adding a Route to the end of the default
Routes table (id: default) omitting the id and
final fields. The server generates a deterministic
id and sets final to true by
default."
value:
- name: new-route
pipeline: main
filter: source == "new.log"
description: Route with server-generated id and default final value
InputStatusResponseExamplesGreenSource:
summary: Source with Green health status
description: Example response for getting the status of a Source that is healthy.
value:
items:
- id: syslog-source
type: syslog
status:
health: Green
healthCounts:
Green: 2
Yellow: 0
Red: 0
Unknown: 0
timestamp: 1627123456789
count: 1
InputStatusResponseExamplesYellowSource:
summary: Source with Yellow health status
description: Example response for getting the status of a Source that is
experiencing issues.
value:
items:
- id: splunk-hec-source
type: splunk_hec
status:
health: Yellow
healthCounts:
Green: 1
Yellow: 1
Red: 0
Unknown: 0
timestamp: 1627123456789
count: 1
OutputStatusResponseExamplesGreenDestination:
summary: Destination with Green health status
description: Example response for getting the status of a Destination that is healthy.
value:
items:
- id: splunk-hec-output
type: splunk_hec
status:
health: Green
healthCounts:
Green: 2
Yellow: 0
Red: 0
Unknown: 0
timestamp: 1627123456789
count: 1
OutputStatusResponseExamplesYellowDestination:
summary: Destination with Yellow health status
description: Example response for getting the status of a Destination that is
experiencing issues.
value:
items:
- id: s3-output
type: s3
status:
health: Yellow
healthCounts:
Green: 1
Yellow: 1
Red: 0
Unknown: 0
timestamp: 1627123456789
count: 1
CollectorResponseExamplesRestCollector:
summary: Get a REST API Collector
description: Example response for a REST API Collector in a response envelope
with count and items.
value:
count: 1
items:
- id: rest-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */4 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: rest
sendToRoutes: true
throttleRatePerSec: 100
conf:
collectUrl: "'https://api.example.com/data'"
collectMethod: get
authentication: none
decodeUrl: true
timeout: 600
pipelines:
- main
destinations:
- default
history: []
notifications: []
CollectorExamplesRest:
summary: Create a REST API Collector
description: Example request body for creating a Collector that fetches data
from a REST API endpoint on a recurring schedule.
value:
id: rest-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */4 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: rest
sendToRoutes: true
throttleRatePerSec: 100
conf:
collectUrl: "'https://api.example.com/data'"
collectMethod: get
authentication: none
decodeUrl: true
timeout: 600
pipelines:
- main
destinations:
- default
CollectorExamplesS3:
summary: Create an S3 Bucket Collector
description: Example request body for creating a Collector that ingests data
from an Amazon S3 bucket.
value:
id: s3-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */6 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: s3
sendToRoutes: true
throttleRatePerSec: 500
conf:
bucket: "'my-data-bucket'"
region: us-east-1
pattern: "*.json"
awsAuthenticationMethod: auto
partitioningScheme: ddss
pipelines:
- data-processing
destinations:
- s3-output
CollectorExamplesFilesystem:
summary: Create a Filesystem Collector
description: Example request body for creating a Collector that reads log files
from the local filesystem.
value:
id: filesystem-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */2 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: filesystem
sendToRoutes: true
throttleRatePerSec: 1000
conf:
path: "'/var/log/application/*.log'"
pipelines:
- log-processing
destinations:
- elasticsearch
CollectorExamplesAzureBlob:
summary: Create an Azure Blob Storage Collector
description: Example request body for creating a Collector that ingests data
from an Azure Blob Storage container.
value:
id: azure-blob-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */8 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: azure_blob
sendToRoutes: true
throttleRatePerSec: 200
conf:
accountName: "'mystorageaccount'"
containerName: "'data-container'"
pattern: "'*.json'"
authType: manual
connectionString: "'DefaultEndpointsProtocol=https;AccountName=mystorageaccount\
;AccountKey=...'"
pipelines:
- data-pipeline
destinations:
- azure-output
CollectorExamplesGoogleCloudStorage:
summary: Create a Google Cloud Storage Collector
description: Example request body for creating a Collector that ingests data
from a Google Cloud Storage bucket.
value:
id: gcs-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */12 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: google_cloud_storage
sendToRoutes: true
throttleRatePerSec: 300
conf:
bucket: "'my-gcs-bucket'"
path: "'data/'"
authType: manual
serviceAccountCredentials: "'{ \"type\": \"service_account\", \"project_id\":
\"my-project\", \"private_key_id\": \"key123\" }'"
pipelines:
- csv-processing
destinations:
- bigquery
CollectorExamplesDatabase:
summary: Create a Database Collector
description: Example request body for creating a Collector that queries a
relational database on a nightly schedule.
value:
id: database-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 2 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: database
sendToRoutes: true
throttleRatePerSec: 50
conf:
connectionId: "'my-postgres-connection'"
query: "`SELECT * FROM events WHERE created_at > '${earliest}'`"
pipelines:
- database-processing
destinations:
- postgres-output
CollectorExamplesSplunk:
summary: Create a Splunk Collector
description: Example request body for creating a Collector that retrieves events
from a Splunk search head using a saved search query.
value:
id: splunk-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */1 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: splunk
sendToRoutes: true
throttleRatePerSec: 1000
conf:
search: "'index=main sourcetype=syslog'"
searchHead: "'https://splunk.example.com:8089'"
endpoint: "'services/search/jobs/export'"
authentication: basic
username: "'admin'"
password: "'changeme'"
outputMode: json
pipelines:
- splunk-processing
destinations:
- splunk-output
CollectorExamplesScript:
summary: Create a Script Collector
description: Example request body for creating a Collector that runs custom
discovery and collection scripts.
value:
id: script-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */3 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: script
sendToRoutes: true
throttleRatePerSec: 10
conf:
discoverScript: "'/opt/scripts/discover.py'"
collectScript: "'/opt/scripts/collect.py'"
pipelines:
- script-output-processing
destinations:
- file-output
CollectorExamplesCriblLake:
summary: Create a Cribl Lake Dataset Collector
description: Example request body for creating a Collector that reads from a
Cribl Lake dataset (Cribl.Cloud only).
value:
id: cribl-lake-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */2 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: cribl_lake
sendToRoutes: true
throttleRatePerSec: 1000
conf:
storageLocationId: cribl_lake
dataset: cribl_logs
query: "*"
timeRange:
start: -1h
end: now
pipelines:
- lake-data-processing
destinations:
- analytics-platform
CollectorListResponseExamplesListed:
summary: Return all Collectors
description: Example response for listing all Collectors in a response envelope
with count and items.
value:
count: 2
items:
- id: rest-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */4 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: rest
sendToRoutes: true
throttleRatePerSec: 100
conf:
collectUrl: "'https://api.example.com/data'"
collectMethod: get
authentication: none
decodeUrl: true
timeout: 600
pipelines:
- main
destinations:
- default
history: []
notifications: []
- id: s3-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */4 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: s3
sendToRoutes: true
throttleRatePerSec: 500
conf:
bucket: "'my-data-bucket'"
region: us-east-1
pattern: "*.json"
awsAuthenticationMethod: auto
partitioningScheme: ddss
pipelines:
- data-processing
destinations:
- s3-output
history: []
notifications: []
offset: 0
limit: 20
UpdateCollectorExamplesRest:
summary: Update a REST API Collector
description: Example request body for updating an existing REST API Collector
with a revised schedule.
The request body must include a
complete representation of the Collector that you want to update. This
endpoint does not support partial updates.
value:
id: rest-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */4 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: rest
sendToRoutes: true
throttleRatePerSec: 100
conf:
collectUrl: "'https://api.example.com/data'"
collectMethod: get
authentication: none
decodeUrl: true
timeout: 600
pipelines:
- main
destinations:
- default
UpdateCollectorExamplesS3:
summary: Update an S3 Bucket Collector
description: Example request body for updating an existing S3 Collector with a
new bucket and pipeline configuration.
The request body must
include a complete representation of the Collector that you want to
update. This endpoint does not support partial updates.
value:
id: s3-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */6 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: s3
sendToRoutes: true
throttleRatePerSec: 500
conf:
bucket: "'my-data-bucket'"
region: us-east-1
pattern: "*.json"
awsAuthenticationMethod: auto
partitioningScheme: ddss
pipelines:
- data-processing
destinations:
- s3-output
UpdateCollectorExamplesFilesystem:
summary: Update a Filesystem Collector
description: Example request body for updating an existing Filesystem Collector
with a revised path configuration.
The request body must
include a complete representation of the Collector that you want to
update. This endpoint does not support partial updates.
value:
id: filesystem-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */2 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: filesystem
sendToRoutes: true
throttleRatePerSec: 1000
conf:
path: "'/var/log/application/*.log'"
pipelines:
- log-processing
destinations:
- elasticsearch
UpdateCollectorExamplesAzureBlob:
summary: Update an Azure Blob Storage Collector
description: Example request body for updating an existing Azure Blob Storage
Collector with revised container settings.
The request body
must include a complete representation of the Collector that you want to
update. This endpoint does not support partial updates.
value:
id: azure-blob-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */8 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: azure_blob
sendToRoutes: true
throttleRatePerSec: 200
conf:
accountName: "'mystorageaccount'"
containerName: "'data-container'"
pattern: "'*.json'"
authType: manual
connectionString: "'DefaultEndpointsProtocol=https;AccountName=mystorageaccount\
;AccountKey=...'"
pipelines:
- data-pipeline
destinations:
- azure-output
UpdateCollectorExamplesGoogleCloudStorage:
summary: Update a Google Cloud Storage Collector
description: Example request body for updating an existing Google Cloud Storage
Collector with revised bucket settings.
The request body must
include a complete representation of the Collector that you want to
update. This endpoint does not support partial updates.
value:
id: gcs-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */12 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: google_cloud_storage
sendToRoutes: true
throttleRatePerSec: 300
conf:
bucket: "'my-gcs-bucket'"
path: "'data/'"
authType: manual
serviceAccountCredentials: "'{ \"type\": \"service_account\", \"project_id\":
\"my-project\", \"private_key_id\": \"key123\" }'"
pipelines:
- csv-processing
destinations:
- bigquery
UpdateCollectorExamplesDatabase:
summary: Update a Database Collector
description: Example request body for updating an existing Database Collector
with revised query settings.
The request body must include a
complete representation of the Collector that you want to update. This
endpoint does not support partial updates.
value:
id: database-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 2 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: database
sendToRoutes: true
throttleRatePerSec: 50
conf:
connectionId: "'my-postgres-connection'"
query: "`SELECT * FROM events WHERE created_at > '${earliest}'`"
pipelines:
- database-processing
destinations:
- postgres-output
UpdateCollectorExamplesSplunk:
summary: Update a Splunk Collector
description: Example request body for updating an existing Splunk Collector with
revised search settings.
The request body must include a
complete representation of the Collector that you want to update. This
endpoint does not support partial updates.
value:
id: splunk-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */1 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: splunk
sendToRoutes: true
throttleRatePerSec: 1000
conf:
search: "'index=main sourcetype=syslog'"
searchHead: "'https://splunk.example.com:8089'"
endpoint: "'services/search/jobs/export'"
authentication: basic
username: "'admin'"
password: "'changeme'"
outputMode: json
pipelines:
- splunk-processing
destinations:
- splunk-output
UpdateCollectorExamplesScript:
summary: Update a Script Collector
description: Example request body for updating an existing Script Collector with
revised script settings.
The request body must include a
complete representation of the Collector that you want to update. This
endpoint does not support partial updates.
value:
id: script-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */3 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: script
sendToRoutes: true
throttleRatePerSec: 10
conf:
discoverScript: "'/opt/scripts/discover.py'"
collectScript: "'/opt/scripts/collect.py'"
pipelines:
- script-output-processing
destinations:
- file-output
UpdateCollectorExamplesCriblLake:
summary: Update a Cribl Lake Dataset Collector
description: Example request body for updating an existing Cribl Lake Dataset
Collector with revised dataset settings.
The request body must
include a complete representation of the Collector that you want to
update. This endpoint does not support partial updates.
value:
id: cribl-lake-collector
type: collection
schedule:
enabled: true
cronSchedule: 0 */2 * * *
tz: UTC
run:
mode: run
timeRangeType: relative
earliest: -300
expression: "true"
logLevel: info
collector:
type: cribl_lake
sendToRoutes: true
throttleRatePerSec: 1000
conf:
storageLocationId: cribl_lake
dataset: cribl_logs
query: "*"
timeRange:
start: -1h
end: now
pipelines:
- lake-data-processing
destinations:
- analytics-platform
CreateGroupExamplesCloudWg:
summary: Create a Worker Group in Cribl.Cloud
description: Example request body for creating a Worker Group on Cribl.Cloud
sized for a low-ingest deployment.
value:
id: goatCloudIanWg
name: goatcloudianwg
cloud:
provider: aws
region: us-west-2
workerRemoteAccess: true
type: stream
onPrem: false
estimatedIngestRate: 2048
provisioned: true
CreateGroupExamplesOnPremWg:
summary: Create a Worker Group in customer-managed deployment
description: Example request body for creating a Worker Group in a
customer-managed deployment.
value:
id: goatOnPremIanWg
name: goatonpremianwg
description: Worker group in customer-managed deployment
workerRemoteAccess: true
type: stream
onPrem: true
CreateGroupExamplesCloneWg:
summary: Clone an on-prem Worker Group
description: Example request body for cloning an existing Worker Group into a
new Worker Group.
value:
id: goatOnPremDollyWg
name: goatonpremdollywg
description: Worker Group cloned from goatOnPremIanWg with identical configuration
workerRemoteAccess: true
type: stream
onPrem: true
sourceGroupId: goatOnPremIanWg
CreateGroupExamplesEdgeFleet:
summary: Create an Edge Fleet
description: Example request body for creating an Edge Fleet in a
customer-managed deployment.
value:
id: goatIanEdgeFleet
name: goatianedgefleet
description: Edge Fleet for customer-managed deployments
workerRemoteAccess: true
type: edge
onPrem: true
UpdateGroupExamplesScaleCloudWorkerGroup:
summary: Scale a Cribl.Cloud Worker Group by updating estimated ingest rate
description: Example request body for scaling a Cribl.Cloud Worker Group to
handle higher throughput.
The request body must include a
complete representation of the Group or Fleet that you want to update.
This endpoint does not support partial updates.
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
type: stream
onPrem: false
estimatedIngestRate: 4096
provisioned: true
configVersion: abc1234
workerCount: 3
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
UpdateGroupExamplesUpdateOnPremWorkerGroup:
summary: Update a customer-managed Worker Group
description: Example request body for updating a customer-managed Worker
Group.
The request body must include a complete representation
of the Group or Fleet that you want to update. This endpoint does not
support partial updates.
value:
id: goatOnPremIanWg
name: goatonpremianwg
description: Updated customer-managed Worker Group with remote access enabled
workerRemoteAccess: true
type: stream
onPrem: true
configVersion: abc1234
workerCount: 5
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
GroupConfigVersionResponseExamplesConfigVersion:
summary: Get a configuration version
description: Example response for getting the configuration version for the
specified Worker Group.
value:
count: 1
items:
- abc1234
GroupCreateResponseExamplesWorkerGroup:
summary: Create a Worker Group
description: Example response for creating a Worker Group.
value:
count: 1
items:
- id: goatCloudIanWg
name: goatcloudianwg
cloud:
provider: aws
region: us-west-2
workerRemoteAccess: true
type: stream
onPrem: false
estimatedIngestRate: 2048
provisioned: true
configVersion: abc1234
workerCount: 3
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
GroupDeleteResponseExamplesWorkerGroup:
summary: Delete a Worker Group
description: Example response for deleting the specified Worker Group.
value:
count: 1
items:
- id: goatCloudIanWg
name: goatcloudianwg
cloud:
provider: aws
region: us-west-2
workerRemoteAccess: true
type: stream
onPrem: false
estimatedIngestRate: 2048
provisioned: true
configVersion: abc1234
workerCount: 3
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
GroupDeployResponseExamplesWorkerGroup:
summary: Deploy commits to a Worker Group
description: Example response for deploying commits to the specified Worker Group.
value:
count: 1
items:
- id: goatCloudIanWg
name: goatcloudianwg
cloud:
provider: aws
region: us-west-2
workerRemoteAccess: true
type: stream
onPrem: false
estimatedIngestRate: 2048
provisioned: true
configVersion: abc1234
workerCount: 3
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments:
- context: cribl
lookups:
- file: customers.csv
deployedVersion: lookup123
DeployGroupExamplesDeployWorkerGroup:
summary: Deploy commits to a Worker Group
description: Example request body for deploying a committed configuration
version to a Worker Group.
value:
version: abc1234
lookups:
- context: cribl
lookups:
- file: customers.csv
version: lookup123
GroupGetResponseExamplesWorkerGroup:
summary: Get a Worker Group
description: Example response for getting the specified Worker Group.
value:
count: 1
items:
- id: goatCloudIanWg
name: goatcloudianwg
cloud:
provider: aws
region: us-west-2
workerRemoteAccess: true
type: stream
onPrem: false
estimatedIngestRate: 2048
provisioned: true
configVersion: abc1234
workerCount: 3
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
GroupListResponseExamplesWorkerGroups:
summary: List Worker Groups
description: Example response for listing Worker Groups for a Cribl product.
value:
count: 2
items:
- id: goatCloudIanWg
name: goatcloudianwg
cloud:
provider: aws
region: us-west-2
workerRemoteAccess: true
type: stream
onPrem: false
estimatedIngestRate: 2048
provisioned: true
configVersion: abc1234
workerCount: 3
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
- id: goatOnPremIanWg
name: goatonpremianwg
description: Worker group in customer-managed deployment
workerRemoteAccess: true
type: stream
onPrem: true
configVersion: def5678
workerCount: 5
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
offset: 0
limit: 20
GroupUpdateResponseExamplesWorkerGroup:
summary: Update a Worker Group
description: Example response for updating the specified Worker Group.
value:
count: 1
items:
- id: goatCloudIanWg
name: goatcloudianwg
cloud:
provider: aws
region: us-west-2
workerRemoteAccess: true
type: stream
onPrem: false
estimatedIngestRate: 4096
provisioned: true
configVersion: abc1234
workerCount: 3
incompatibleWorkerCount: 0
deployingWorkerCount: 0
lookupDeployments: []
LakeDatasetCreateExamplesJsonDataset:
summary: Create a Lake Dataset in JSON format
description: Example request body for creating a Lake Dataset in JSON format
with a 90-day retention period.
value:
id: web_access_logs
description: Web server access logs
storageLocationId: my-storage-location
format: json
retentionPeriodInDays: 90
acceleratedFields:
- host
- status
LakeDatasetCreateExamplesParquetDataset:
summary: Create a Lake Dataset in Parquet format
description: Example request body for creating a Lake Dataset in Parquet format
with a 365-day retention period and search configuration.
value:
id: security_events
description: Security event data in Parquet format
storageLocationId: my-storage-location
format: parquet
retentionPeriodInDays: 365
searchConfig:
datatypes:
- palo_alto_firewall
- crowdstrike_fdr
LakeDatasetCreateExamplesMinimalDataset:
summary: Create a minimal Lake Dataset
description: Example request body for creating a Lake Dataset with only the
required body parameters.
value:
id: app_logs
LakeDatasetUpdateExamplesUpdateRetention:
summary: Update the retention period for a Lake Dataset
description: Example request body for updating the retention period for an
existing Lake Dataset.
value:
retentionPeriodInDays: 180
LakeDatasetUpdateExamplesUpdateDescription:
summary: Update description and accelerated fields for a Lake Dataset
description: Example request body for updating the description and accelerated
fields for an existing Lake Dataset.
value:
description: Web server access logs with accelerated fields.
acceleratedFields:
- host
- status
- source
CaptureExamplesSimpleExpression:
summary: Capture events by sourcetype
description: Example request body for capturing events by sourcetype.
value:
filter: sourcetype==="pan:traffic"
maxEvents: 100
duration: 5
level: 0
CaptureExamplesCompoundAndExpression:
summary: Capture events using the AND operator to specify multiple conditions
description: Example request body for capturing events using the AND operator to
specify multiple conditions.
value:
filter: sourcetype==="pan:traffic" && src_zone==="trusted"
maxEvents: 100
duration: 5
level: 0
CaptureExamplesNestedFieldAccess:
summary: Capture events using dot notation to specify nested fields
description: Example request body for capturing events using dot notation to
specify nested fields.
value:
filter: sourcetype==="pan:traffic" && dest_geoip.country.iso_code === "US"
maxEvents: 100
duration: 5
level: 0
CaptureExamplesComplexFilter:
summary: Capture with a complex filter that uses JavaScript methods
description: Example request body for capturing with a complex filter that uses
JavaScript methods.
value:
filter: __inputId.startsWith("http:") && status >= 400 && status < 500
maxEvents: 500
duration: 15
level: 1
ProductWorkersCountResponseExamplesCountedWorkerNodes:
summary: Get a Worker Node count
description: Example response that contains the Worker Node count for Cribl Stream.
value:
count: 1
items:
- 42
GetProductWorkerByIdResponseExamplesOneWorker:
summary: Get detailed metadata for a Worker, Edge, or Outpost Node
description: Example response for getting detailed metadata for a single Worker,
Edge, or Outpost Node by its id.
value:
count: 1
items:
- id: 11111111-1111-1111-1111-111111111111
group: default
workerProcesses: 4
status: healthy
lastMsgTime: 1710000060000
firstMsgTime: 1700000000000
info:
hostname: worker-1
platform: linux
architecture: x64
release: 6.8.0-1013-oem
cpus: 8
totalmem: 17179869184
node: v22.17.1
env:
TZ: UTC
LANG: en_US.UTF-8
cribl:
startTime: 1700000000000
guid: 11111111-1111-1111-1111-111111111111
config:
version: 1.0.0
distMode: worker
group: default
version: 4.19.0
WorkersListResponseExamplesWorkerNode:
summary: List Worker Nodes
description: Example response for listing Worker Nodes for Cribl Stream.
value:
count: 1
items:
- id: worker-guid-01
group: default
firstMsgTime: 1717200000000
lastMsgTime: 1717200060000
workerProcesses: 4
status: healthy
info:
hostname: worker-01
platform: linux
architecture: x64
release: 6.8.0
cpus: 8
totalmem: 34359738368
node: v22.17.1
env: {}
cribl:
config: {}
distMode: worker
group: default
guid: worker-guid-01
startTime: 1717200000000
offset: 0
limit: 20
RestartProductWorkersResponseExamplesRestartingWorkers:
summary: Restart Worker, Edge, or Outpost Nodes for a Cribl product
description: Example response for restarting Worker, Edge, or Outpost Nodes when
all requested Nodes accept the restart. The response returns one entry
per requested Node with its restart status.
value:
count: 2
items:
- id: guid-12345678-abcd-1234-abcd-123456789abc
status: Restarting
- id: guid-87654321-dcba-4321-dcba-cba987654321
status: Restarting
RestartProductWorkersResponseExamplesRestartingWorkersWithError:
summary: Restart Worker, Edge, or Outpost Nodes for a Cribl product with a
partial failure
description: Example response for restarting Worker, Edge, or Outpost Nodes when
one of the requested Nodes fails to restart. Failed Nodes report
status Error and include a
message.
value:
count: 2
items:
- id: guid-12345678-abcd-1234-abcd-123456789abc
status: Restarting
- id: guid-87654321-dcba-4321-dcba-cba987654321
status: Error
message: Node is not connected to the Leader.
RestartWorkersExamplesRestartWorkers:
summary: Restart Worker, Edge, or Outpost Nodes
description: Example request body for restarting multiple Worker, Edge, or
Outpost Nodes by providing an array of id values.
value:
guids:
- guid-12345678-abcd-1234-abcd-123456789abc
- guid-87654321-dcba-4321-dcba-cba987654321
- guid-11111111-2222-3333-4444-555555555555
ProductSummaryResponseExamplesStreamDeploymentSummary:
summary: Get a Cribl Stream deployment summary
description: Example response for getting a deployment summary for Cribl Stream.
value:
count: 1
items:
- groups:
count: 1
routes: 3
pipelines: 2
sources: 4
destinations: 2
quickConnects: 1
packs: 1
workers:
count: 2
disconnectedCount: 0
groups: 1
alive: 2
unhealthy: 0
softwareVersions: 1
confVersions: 1
offset: 0
limit: 20
HealthExamplesHealthyPrimary:
summary: Healthy (primary)
description: Example response for a healthy server that is acting as primary.
value:
status: healthy
startTime: 1700000000000
role: primary
overlay:
state: inactive
Health420ExamplesShuttingDown:
summary: Shutting down (primary)
description: Example response for a server that is acting as primary and is in
the process of shutting down.
value:
status: shutting down
startTime: 1700000000000
role: primary
overlay:
state: inactive
Health420ExamplesStandby:
summary: Standby
description: Example response for a server that is in standby mode.
value:
status: standby
startTime: 1700000000000
role: standby
overlay:
state: inactive
PackInstallResponseExamplesInstalledFromURL:
summary: Pack installed from URL response
description: Example response for a Pack successfully installed from a URL.
value:
items:
- id: cribl-palo-alto-networks
displayName: Palo Alto Networks
version: 1.1.4
author: Cribl
description: Packs for processing Palo Alto Networks firewall logs.
source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl
exports:
- pipelines
- inputs
warnings: []
count: 1
PackInstallExamplesPackDispensary:
summary: Install a Pack from the Pack Dispensary
description: Example request body for installing a Pack directly from the Cribl
Pack Dispensary using a download URL.
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 a new empty Pack
description: Example request body for creating a new empty Pack with metadata
but no configuration.
value:
version: 0.0.1
tags:
streamtags: []
exports: []
displayName: testPackFoo
id: testPackFoo
PackInstallExamplesUploadedFile:
summary: Install a Pack from an uploaded file
description: Example request body for installing a Pack from a previously
uploaded file. Use the source value returned by PUT
/packs.
value:
source: cribl-search-missing-logs-1.0.1.Do7DH5I.crbl
id: cribl-search-missing-logs
allowCustomFunctions: false
PackInstallExamplesURL:
summary: Install a Pack from a URL
description: Example request body for installing a Pack by providing a direct
URL to a .crbl file.
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 a Pack from a Git repository
description: Example request body for installing a Pack by importing directly
from a Git repository using a git+ URL.
value:
source: git+https://github.com/criblio/cribl_ocsf_postprocessing
allowCustomFunctions: false
PackDeleteResponseExamplesUninstalled:
summary: Pack uninstalled response
description: Example response after successfully uninstalling a Pack.
value:
items:
- id: cribl-palo-alto-networks
source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl
count: 1
PackGetResponseExamplesInstalledPack:
summary: Installed Pack response
description: Example response for getting a Pack installed from a Git repository.
value:
items:
- id: cribl-palo-alto-networks
displayName: Palo Alto Networks
version: 1.1.4
author: Cribl
description: Packs for processing Palo Alto Networks firewall logs.
source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl
exports:
- pipelines
- inputs
count: 1
PackGetResponseExamplesEmptyPack:
summary: Empty Pack response
description: Example response for getting an empty Pack.
value:
items:
- id: testPackFoo
displayName: testPackFoo
version: 0.0.1
author: ""
description: ""
source: ""
exports: []
count: 1
PackListResponseExamplesPackList:
summary: List all Packs response
description: Example response for listing all installed Packs.
value:
items:
- id: cribl-palo-alto-networks
displayName: Palo Alto Networks
version: 1.1.4
author: Cribl
description: Packs for processing Palo Alto Networks firewall logs.
source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl
exports:
- pipelines
- inputs
- id: testPackFoo
displayName: testPackFoo
version: 0.0.1
author: ""
description: ""
source: ""
exports: []
count: 2
offset: 0
limit: 20
PackUpgradeResponseExamplesUpgraded:
summary: Pack upgraded response
description: Example response for upgrading a Pack to a newer version.
value:
items:
- id: cribl-palo-alto-networks
displayName: Palo Alto Networks
version: 1.1.5
author: Cribl
description: Packs for processing Palo Alto Networks firewall logs.
source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.5/cribl-palo-alto-networks-a3e5a19d-1.1.5.crbl
exports:
- pipelines
- inputs
count: 1
PackUpgradeExamplesUpgradeFromURL:
summary: Upgrade a Pack from a URL
description: Example request body for upgrading an installed Pack to a newer
version by providing the URL of the updated .crbl file.
value:
source: https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl
PackUploadResponseExamplesUploadedPack:
summary: Pack file uploaded response
description: Example response after successfully uploading a Pack file. Use the
returned source value in a subsequent POST
/packs request to install the Pack.
value:
source: cribl-palo-alto-networks-1.1.4.AbCdEfGh.crbl
GetSystemSettingsConfExamplesDefault:
summary: Get system settings
description: Example response for getting the current Cribl system settings.
value:
items:
- api:
host: 0.0.0.0
port: 9000
disabled: false
ssl:
disabled: false
privKeyPath: /opt/cribl/local/cribl/auth/cribl.key
certPath: /opt/cribl/local/cribl/auth/cribl.crt
passphrase: ""
system:
upgrade: api
intercom: true
workers:
count: 0
minimum: 1
memory: 0
tls:
minVersion: TLSv1.2
maxVersion: TLSv1.3
defaultCipherList: DEFAULT
defaultEcdhCurve: auto
rejectUnauthorized: true
proxy:
useEnvVars: false
shutdown:
drainTimeout: 10000
sni: {}
pii: {}
upgradeSettings: {}
upgradeGroupSettings: {}
backups: {}
rollback: {}
apps:
enabled: true
count: 1
UpdateSystemSettingsResponseExamplesUpdateApiSettings:
summary: Update system settings
description: Example response for updating the Cribl API server network and TLS
settings.
value:
items:
- api:
host: 0.0.0.0
port: 9000
disabled: false
ssl:
disabled: false
privKeyPath: /opt/cribl/local/cribl/auth/cribl.key
certPath: /opt/cribl/local/cribl/auth/cribl.crt
passphrase: ""
system:
upgrade: api
intercom: true
workers:
count: 0
minimum: 1
memory: 0
tls:
minVersion: TLSv1.2
maxVersion: TLSv1.3
defaultCipherList: DEFAULT
defaultEcdhCurve: auto
rejectUnauthorized: true
proxy:
useEnvVars: false
shutdown:
drainTimeout: 10000
sni: {}
pii: {}
upgradeSettings: {}
upgradeGroupSettings: {}
backups: {}
rollback: {}
apps:
enabled: true
count: 1
UpdateSystemSettingsExamplesUpdateApiSettings:
summary: Update API server settings
description: Example request body for updating the Cribl API server network and
TLS settings.
value:
api:
host: 0.0.0.0
port: 9000
disabled: false
ssl:
disabled: false
privKeyPath: /opt/cribl/local/cribl/auth/cribl.key
certPath: /opt/cribl/local/cribl/auth/cribl.crt
passphrase: ""
system:
upgrade: api
intercom: true
shutdown:
drainTimeout: 10000
sni:
disableSNIRouting: false
pii:
enablePiiDetection: false
workers:
count: 0
minimum: 1
memory: 0
proxy:
useEnvVars: false
tls:
minVersion: TLSv1.2
maxVersion: TLSv1.3
defaultCipherList: DEFAULT
defaultEcdhCurve: auto
rejectUnauthorized: true
upgradeSettings: {}
upgradeGroupSettings:
quantity: 100
isRolling: true
retryDelay: 1000
retryCount: 5
backups:
backupsDirectory: $CRIBL_STATE_DIR/backups
backupPersistence: 24h
rollback:
rollbackEnabled: true
RestartSystemExamplesDefault:
summary: Initiate restart
description: Example response for a successful server restart request. The
server will restart shortly after this response is returned.
value:
items:
- restart: true
count: 1
VersionBranchResponseExamplesListBranches:
summary: List all branches
description: Example response for listing all branches in the Cribl
configuration Git repository.
value:
count: 2
items:
- id: main
- id: feature/new-pipeline
VersionCommitResponseExamplesCommitCreated:
summary: Commit created
description: Example response for creating a new commit for pending
configuration changes.
value:
count: 1
items:
- author:
email: admin@example.com
name: Admin User
branch: main
commit: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
files:
modified:
- groups/default/local/cribl/pipelines/http_input/conf.yml
summary:
changes: 1
insertions: 5
deletions: 2
VersionCommitBadRequestExamplesEffectiveWithoutGroup:
summary: Effective without group context
description: Error returned when effective is set to true without a group context.
value:
status: error
message: '"effective" param must be used with "group"'
VersionCommitExamplesCommitAll:
summary: Commit all pending changes
description: Example request body for committing all pending changes to the
Cribl configuration.
value:
message: Updated pipeline configuration for syslog parsing
VersionCommitExamplesCommitSpecificFiles:
summary: Commit changes in specific files
description: Example request body for committing a subset of configuration
changes to specific files.
value:
message: Update Route and Pipeline for HTTP Sources
effective: true
files:
- groups/default/local/cribl/pipelines/http_input/conf.yml
- groups/default/local/cribl/routes.yml
VersionCountResponseExamplesFileCount:
summary: Count of changed files
description: Example response for getting a count of files that changed since a
commit.
value:
count: 1
items:
- count: 3
VersionCurrentBranchResponseExamplesCurrentBranch:
summary: Current branch name
description: Example response for getting the current Git branch name.
value:
branch: main
VersionDiffResponseExamplesDiffResult:
summary: Diff for a commit
description: Example response for getting the diff of changes in a commit.
value:
count: 1
items:
- diffJson:
- oldName: groups/default/local/cribl/pipelines/http_input/conf.yml
newName: groups/default/local/cribl/pipelines/http_input/conf.yml
addedLines: 5
deletedLines: 2
isCombined: false
isGitDiff: true
language: yml
blocks: []
VersionFilesResponseExamplesChangedFiles:
summary: Files changed since a commit
description: Example response for getting the names and statuses of files
changed since a commit.
value:
count: 1
items:
- count: 2
items:
- name: groups/default/local/cribl/pipelines/http_input/conf.yml
state: M
- name: groups/default/local/cribl/routes.yml
state: A
commitMessage: Updated pipeline configuration
VersionInfoResponseExamplesGitInfo:
summary: Git integration info
description: Example response for getting the configuration and status of the
Git integration.
value:
count: 1
items:
- versioning: true
remote: https://github.com/example/cribl-config.git
VersionListResponseExamplesListCommitHistory:
summary: List commit history
description: Example response for listing the commit history of the Cribl
configuration repository.
value:
count: 2
items:
- hash: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
date: 2024-01-15 10:30:00 +0000
message: Updated syslog pipeline configuration
refs: HEAD -> main
body: ""
author_name: Admin User
author_email: admin@example.com
- hash: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3
date: 2024-01-14 09:15:00 +0000
message: Added new HTTP Source
refs: ""
body: ""
author_name: Admin User
author_email: admin@example.com
offset: 0
limit: 20
VersionPushResponseExamplesPushResult:
summary: Push result
description: Example response for pushing local commits to the remote repository.
value:
count: 1
items:
- |-
To https://github.com/example/cribl-config.git
a1b2c3d..b2c3d4e main -> main
VersionRevertResponseExamplesRevertResult:
summary: Revert result
description: Example response for reverting a commit in the local repository.
value:
count: 1
items:
- audit:
id: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
files:
modified:
- groups/default/local/cribl/pipelines/http_input/conf.yml
reverted: true
VersionRevertExamplesRevertCommit:
summary: Revert a specific commit
description: Example request body for reverting a specific commit.
value:
commit: a1b2c3d4e5f6
VersionRevertExamplesForceRevertWithMessage:
summary: Force revert a commit with a custom message
description: Example request body for force reverting a specific commit with a
custom revert message.
value:
commit: a1b2c3d4e5f6
message: Revert commit due to misconfiguration in Pipeline settings
force: true
VersionShowResponseExamplesShowCommit:
summary: Diff and log message for a commit
description: Example response for getting the diff and log message for a commit.
value:
count: 1
items:
- commitMessage: Updated syslog pipeline configuration
diffJson:
- oldName: groups/default/local/cribl/pipelines/syslog/conf.yml
newName: groups/default/local/cribl/pipelines/syslog/conf.yml
addedLines: 3
deletedLines: 1
isCombined: false
isGitDiff: true
language: yml
blocks: []
VersionStatusResponseExamplesWorkingTreeStatus:
summary: Working tree status
description: Example response for getting the status of the current working tree.
value:
count: 1
items:
- not_added: []
conflicted: []
created: []
deleted: []
modified:
- groups/default/local/cribl/pipelines/http_input/conf.yml
renamed: []
staged: []
files:
- path: groups/default/local/cribl/pipelines/http_input/conf.yml
index: M
working_dir: " "
ahead: 0
behind: 0
current: main
VersionUndoResponseExamplesUndoResult:
summary: Undo result
description: Example response for discarding uncommitted changes.
value:
count: 1
items:
- true
security:
- bearerAuth: []
- clientOauth: []
tags:
- 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.
x-cribl-availability: both
- name: collectors
description: Actions related to Collectors
x-cribl-availability: both
- name: databaseConnections
description: Actions related to DatabaseConnections
x-cribl-availability: both
- name: destinations
description: Actions related to Destinations
x-cribl-availability: both
- name: distributed
description: Actions related to Distributed
x-cribl-availability: both
- name: functions
description: Actions related to functions
x-cribl-availability: both
- name: groups
description: Actions related to Groups
x-cribl-availability: both
- name: health
description: Actions related to REST server health
x-cribl-availability: both
- name: lake
description: Actions related to Lake
x-cribl-availability: cloud
- name: packs
description: Actions related to Packs
x-cribl-availability: both
- name: pipelines
description: Actions related to Pipelines
x-cribl-availability: both
- name: preview
description: Actions related to data preview
x-cribl-availability: both
- name: routes
description: Actions related to Routes
x-cribl-availability: both
- name: sources
description: Actions related to Sources
x-cribl-availability: both
- name: system
description: Actions related to system settings
x-cribl-availability: both
- name: teams
description: Actions related to Teams
x-cribl-availability: both
- name: versioning
description: Actions related to Versioning
x-cribl-availability: both
- name: workers
description: Actions related to Workers
x-cribl-availability: both
paths:
/auth/login:
post:
operationId: createAuthLogin
tags:
- auth
x-speakeasy-group: auth.tokens
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
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.
security: []
responses:
"200":
description: Authentication token
content:
application/json:
schema:
$ref: "#/components/schemas/AuthToken"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"429":
description: Rate limit exceeded (check Retry-After header).
headers:
retry-after:
description: Number of seconds the client should wait before retrying the
request
schema:
type: integer
example: 60
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: LoginInfo object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LoginInfo"
/functions:
get:
operationId: getFunctions
tags:
- functions
x-speakeasy-group: functions
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Functions
description: Get a list of all Functions.
responses:
"200":
description: List of Function objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedFunctionResponse"
examples:
FunctionListResponseExamplesFunctionList:
$ref: "#/components/examples/FunctionListResponseExamplesFunctionList"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: showHidden
in: query
required: false
schema:
type: boolean
description: If true, include hidden Functions in the response.
Otherwise, hidden Functions are excluded.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/functions/{id}:
get:
operationId: getFunctionsById
tags:
- functions
x-speakeasy-group: functions
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Function
description: Get the specified Function.
responses:
"200":
description: The requested Function object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedFunctionResponse"
examples:
FunctionResponseExamplesEvalFunction:
$ref: "#/components/examples/FunctionResponseExamplesEvalFunction"
FunctionResponseExamplesDropFunction:
$ref: "#/components/examples/FunctionResponseExamplesDropFunction"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Function to get.
/health:
get:
operationId: getHealth
tags:
- health
x-speakeasy-group: health
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the health status of the server
description: Get the current health status of the server (Leader or Worker
Node). In Distributed deployments, requests routed to a Worker or Edge
node using the [host
context](https://docs.cribl.io/cribl-as-code/api#base-url-group-fleet-host)
require a Bearer token for
[authentication](https://docs.cribl.io/cribl-as-code/api-auth/).
security:
- {}
- bearerAuth: []
- clientOauth: []
responses:
"200":
description: Healthy status
content:
application/json:
schema:
$ref: "#/components/schemas/HealthServerStatus"
examples:
HealthExamplesHealthyPrimary:
$ref: "#/components/examples/HealthExamplesHealthyPrimary"
"420":
description: Server is shutting down or in standby mode
content:
application/json:
schema:
$ref: "#/components/schemas/HealthServerStatus"
examples:
Health420ExamplesShuttingDown:
$ref: "#/components/examples/Health420ExamplesShuttingDown"
Health420ExamplesStandby:
$ref: "#/components/examples/Health420ExamplesStandby"
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/lib/database-connections:
get:
operationId: getDatabaseConnectionConfig
tags:
- databaseConnections
x-speakeasy-group: databaseConnections
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Database Connections
description: Get a list of all Database Connections.
responses:
"200":
description: Database Connections returned in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseConnectionResponseEnvelope"
examples:
DatabaseConnectionListResponseExamplesDatabaseConnectionList:
$ref: "#/components/examples/DatabaseConnectionListResponseExamplesDatabaseConn\
ectionList"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: databaseType
in: query
required: false
schema:
$ref: "#/components/schemas/DatabaseConnectionType"
description: Filter results by database engine type. Use this parameter to
return only Database Connections for the specified engine.
- name: limit
in: query
required: false
schema:
type: integer
description: Maximum number of Database Connections to return in the response
for this request. Use with offset 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 limit to paginate the response into manageable
batches.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createDatabaseConnectionConfig
tags:
- databaseConnections
x-speakeasy-group: databaseConnections
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Create a Database Connection
description: Create a new Database Connection.
responses:
"200":
description: The created Database Connection in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseConnectionResponseEnvelope"
examples:
DatabaseConnectionResponseExamplesMySQLDatabaseConnection:
$ref: "#/components/examples/DatabaseConnectionResponseExamplesMySQLDatabaseCon\
nection"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
content:
application/json:
schema:
$ref: "#/components/schemas/RestApiJsonError"
examples:
DatabaseConnectionBadRequestResponseExamplesInvalidDatabaseConnectionRequest:
$ref: "#/components/examples/DatabaseConnectionBadRequestResponseExamplesInvali\
dDatabaseConnectionRequest"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: DatabaseConnectionConfig object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseConnectionConfig"
examples:
DatabaseConnectionExamplesMySQLWithConnectionString:
$ref: "#/components/examples/DatabaseConnectionExamplesMySQLWithConnectionStrin\
g"
DatabaseConnectionExamplesMySQLWithSecret:
$ref: "#/components/examples/DatabaseConnectionExamplesMySQLWithSecret"
DatabaseConnectionExamplesPostgreSQLWithConnectionString:
$ref: "#/components/examples/DatabaseConnectionExamplesPostgreSQLWithConnection\
String"
DatabaseConnectionExamplesPostgreSQLWithSecret:
$ref: "#/components/examples/DatabaseConnectionExamplesPostgreSQLWithSecret"
DatabaseConnectionExamplesSQLServerWithConnectionString:
$ref: "#/components/examples/DatabaseConnectionExamplesSQLServerWithConnectionS\
tring"
DatabaseConnectionExamplesSQLServerWithSecret:
$ref: "#/components/examples/DatabaseConnectionExamplesSQLServerWithSecret"
DatabaseConnectionExamplesSQLServerWithConfigObject:
$ref: "#/components/examples/DatabaseConnectionExamplesSQLServerWithConfigObjec\
t"
DatabaseConnectionExamplesOracleWithConnectionString:
$ref: "#/components/examples/DatabaseConnectionExamplesOracleWithConnectionStri\
ng"
DatabaseConnectionExamplesOracleWithSecret:
$ref: "#/components/examples/DatabaseConnectionExamplesOracleWithSecret"
DatabaseConnectionExamplesOracleWithCredentialsSecrets:
$ref: "#/components/examples/DatabaseConnectionExamplesOracleWithCredentialsSec\
rets"
DatabaseConnectionExamplesOracleWithMutualTLS:
$ref: "#/components/examples/DatabaseConnectionExamplesOracleWithMutualTLS"
/lib/database-connections/{id}:
get:
operationId: getDatabaseConnectionConfigById
tags:
- databaseConnections
x-speakeasy-group: databaseConnections
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Database Connection
description: Get the specified Database Connection.
responses:
"200":
description: The requested Database Connection in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseConnectionResponseEnvelope"
examples:
DatabaseConnectionResponseExamplesMySQLDatabaseConnection:
$ref: "#/components/examples/DatabaseConnectionResponseExamplesMySQLDatabaseCon\
nection"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist — Database Connection not
found.
content:
application/json:
schema:
$ref: "#/components/schemas/RestApiJsonError"
examples:
DatabaseConnectionNotFoundResponseExamplesDatabaseConnectionNotFound:
$ref: "#/components/examples/DatabaseConnectionNotFoundResponseExamplesDatabase\
ConnectionNotFound"
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Database Connection to get.
patch:
operationId: updateDatabaseConnectionConfigById
tags:
- databaseConnections
x-speakeasy-group: databaseConnections
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update a Database Connection
description: Update the specified Database Connection.
Provide a
complete representation of the Database Connection that you want to
update in the request body. This endpoint does not support partial
updates. Cribl removes any omitted fields when updating the Database
Connection.
Confirm that the configuration in your request body
is correct before sending the request. If the configuration is
incorrect, the updated Database Connection might not function as
expected.
responses:
"200":
description: The updated Database Connection in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseConnectionResponseEnvelope"
examples:
DatabaseConnectionResponseExamplesMySQLDatabaseConnection:
$ref: "#/components/examples/DatabaseConnectionResponseExamplesMySQLDatabaseCon\
nection"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
content:
application/json:
schema:
$ref: "#/components/schemas/RestApiJsonError"
examples:
DatabaseConnectionBadRequestResponseExamplesInvalidDatabaseConnectionRequest:
$ref: "#/components/examples/DatabaseConnectionBadRequestResponseExamplesInvali\
dDatabaseConnectionRequest"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Database Connection not found.
content:
application/json:
schema:
$ref: "#/components/schemas/RestApiJsonError"
examples:
DatabaseConnectionNotFoundResponseExamplesDatabaseConnectionNotFound:
$ref: "#/components/examples/DatabaseConnectionNotFoundResponseExamplesDatabase\
ConnectionNotFound"
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: DatabaseConnectionConfig object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseConnectionConfig"
examples:
UpdateDatabaseConnectionExamplesUpdateMySQLDatabaseConnectionWithConnectionString:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateMySQLDatabas\
eConnectionWithConnectionString"
UpdateDatabaseConnectionExamplesUpdateMySQLDatabaseConnectionWithSecret:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateMySQLDatabas\
eConnectionWithSecret"
UpdateDatabaseConnectionExamplesUpdatePostgreSQLDatabaseConnectionWithConnectionString:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdatePostgreSQLDa\
tabaseConnectionWithConnectionString"
UpdateDatabaseConnectionExamplesUpdatePostgreSQLDatabaseConnectionWithSecret:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdatePostgreSQLDa\
tabaseConnectionWithSecret"
UpdateDatabaseConnectionExamplesUpdateSQLServerDatabaseConnectionWithConnectionString:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateSQLServerDat\
abaseConnectionWithConnectionString"
UpdateDatabaseConnectionExamplesUpdateSQLServerDatabaseConnectionWithSecret:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateSQLServerDat\
abaseConnectionWithSecret"
UpdateDatabaseConnectionExamplesUpdateSQLServerDatabaseConnectionWithConfigObject:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateSQLServerDat\
abaseConnectionWithConfigObject"
UpdateDatabaseConnectionExamplesUpdateOracleDatabaseConnectionWithConnectionString:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateOracleDataba\
seConnectionWithConnectionString"
UpdateDatabaseConnectionExamplesUpdateOracleDatabaseConnectionWithSecret:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateOracleDataba\
seConnectionWithSecret"
UpdateDatabaseConnectionExamplesUpdateOracleDatabaseConnectionWithCredentialsSecrets:
$ref: "#/components/examples/UpdateDatabaseConnectionExamplesUpdateOracleDataba\
seConnectionWithCredentialsSecrets"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Database Connection to update.
delete:
operationId: deleteDatabaseConnectionConfigById
tags:
- databaseConnections
x-speakeasy-group: databaseConnections
x-speakeasy-name-override: delete
x-cribl-internal: false
x-cribl-availability: both
summary: Delete a Database Connection
description: Delete the specified Database Connection.
responses:
"200":
description: The deleted Database Connection in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseConnectionResponseEnvelope"
examples:
DatabaseConnectionResponseExamplesMySQLDatabaseConnection:
$ref: "#/components/examples/DatabaseConnectionResponseExamplesMySQLDatabaseCon\
nection"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Database Connection not found.
content:
application/json:
schema:
$ref: "#/components/schemas/RestApiJsonError"
examples:
DatabaseConnectionNotFoundResponseExamplesDatabaseConnectionNotFound:
$ref: "#/components/examples/DatabaseConnectionNotFoundResponseExamplesDatabase\
ConnectionNotFound"
"409":
description: Request conflicts with current resource state — Database Connection
is referenced by another entity.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Database Connection to delete.
/lib/jobs:
get:
operationId: getSavedJob
tags:
- collectors
x-speakeasy-group: collectors
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Collectors
description: Get a list of all Collectors.
responses:
"200":
description: The list of Collectors in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedSavedJobResponse"
examples:
CollectorListResponseExamplesListed:
$ref: "#/components/examples/CollectorListResponseExamplesListed"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: collectorType
in: query
required: false
schema:
$ref: "#/components/schemas/CollectorType"
description: Filter by collector type.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createSavedJob
tags:
- collectors
x-speakeasy-group: collectors
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Create a Collector
description: Create a new Collector.
responses:
"200":
description: The created Collector in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedSavedJobResponse"
examples:
CollectorResponseExamplesRestCollector:
$ref: "#/components/examples/CollectorResponseExamplesRestCollector"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: SavedJob object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SavedJob"
examples:
CollectorExamplesRest:
$ref: "#/components/examples/CollectorExamplesRest"
CollectorExamplesS3:
$ref: "#/components/examples/CollectorExamplesS3"
CollectorExamplesFilesystem:
$ref: "#/components/examples/CollectorExamplesFilesystem"
CollectorExamplesAzureBlob:
$ref: "#/components/examples/CollectorExamplesAzureBlob"
CollectorExamplesGoogleCloudStorage:
$ref: "#/components/examples/CollectorExamplesGoogleCloudStorage"
CollectorExamplesDatabase:
$ref: "#/components/examples/CollectorExamplesDatabase"
CollectorExamplesSplunk:
$ref: "#/components/examples/CollectorExamplesSplunk"
CollectorExamplesScript:
$ref: "#/components/examples/CollectorExamplesScript"
CollectorExamplesCriblLake:
$ref: "#/components/examples/CollectorExamplesCriblLake"
/lib/jobs/{id}:
get:
operationId: getSavedJobById
tags:
- collectors
x-speakeasy-group: collectors
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Collector
description: Get the specified Collector.
responses:
"200":
description: The requested Collector in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedSavedJobResponse"
examples:
CollectorResponseExamplesRestCollector:
$ref: "#/components/examples/CollectorResponseExamplesRestCollector"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Collector to get.
patch:
operationId: updateSavedJobById
tags:
- collectors
x-speakeasy-group: collectors
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update a Collector
description: Update the specified Collector.
Provide a complete
representation of the Collector that you want to update in the request
body. This endpoint does not support partial updates. Cribl removes any
omitted fields when updating the Collector.
Confirm that the
configuration in your request body is correct before sending the
request. If the configuration is incorrect, the updated Collector might
not function as expected.
responses:
"200":
description: The updated Collector in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedSavedJobResponse"
examples:
CollectorResponseExamplesRestCollector:
$ref: "#/components/examples/CollectorResponseExamplesRestCollector"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: SavedJob object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SavedJob"
examples:
UpdateCollectorExamplesRest:
$ref: "#/components/examples/UpdateCollectorExamplesRest"
UpdateCollectorExamplesS3:
$ref: "#/components/examples/UpdateCollectorExamplesS3"
UpdateCollectorExamplesFilesystem:
$ref: "#/components/examples/UpdateCollectorExamplesFilesystem"
UpdateCollectorExamplesAzureBlob:
$ref: "#/components/examples/UpdateCollectorExamplesAzureBlob"
UpdateCollectorExamplesGoogleCloudStorage:
$ref: "#/components/examples/UpdateCollectorExamplesGoogleCloudStorage"
UpdateCollectorExamplesDatabase:
$ref: "#/components/examples/UpdateCollectorExamplesDatabase"
UpdateCollectorExamplesSplunk:
$ref: "#/components/examples/UpdateCollectorExamplesSplunk"
UpdateCollectorExamplesScript:
$ref: "#/components/examples/UpdateCollectorExamplesScript"
UpdateCollectorExamplesCriblLake:
$ref: "#/components/examples/UpdateCollectorExamplesCriblLake"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Collector to update.
delete:
operationId: deleteSavedJobById
tags:
- collectors
x-speakeasy-group: collectors
x-speakeasy-name-override: delete
x-cribl-internal: false
x-cribl-availability: both
summary: Delete a Collector
description: Delete the specified Collector.
responses:
"200":
description: The deleted Collector in a response envelope with
count and items.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedSavedJobResponse"
examples:
CollectorResponseExamplesRestCollector:
$ref: "#/components/examples/CollectorResponseExamplesRestCollector"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Collector to delete.
/p/{pack}/pipelines:
get:
operationId: getPipelinesByPack
tags:
- pipelines
x-speakeasy-group: packs.pipelines
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Pipelines within a Pack
description: Get a list of all Pipelines within the specified Pack.
responses:
"200":
description: List of Pipeline objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createPipelinesByPack
tags:
- pipelines
x-speakeasy-group: packs.pipelines
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Create a Pipeline within a Pack
description: Create a new Pipeline within the specified Pack.
responses:
"200":
description: The created Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: Pipeline object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Pipeline"
examples:
PipelineExamplesEmpty:
$ref: "#/components/examples/PipelineExamplesEmpty"
PipelineExamplesAggregations:
$ref: "#/components/examples/PipelineExamplesAggregations"
PipelineExamplesAggregateMetrics:
$ref: "#/components/examples/PipelineExamplesAggregateMetrics"
PipelineExamplesAutoTimestamp:
$ref: "#/components/examples/PipelineExamplesAutoTimestamp"
PipelineExamplesCEFSerializer:
$ref: "#/components/examples/PipelineExamplesCEFSerializer"
PipelineExamplesChain:
$ref: "#/components/examples/PipelineExamplesChain"
PipelineExamplesClone:
$ref: "#/components/examples/PipelineExamplesClone"
PipelineExamplesComment:
$ref: "#/components/examples/PipelineExamplesComment"
PipelineExamplesDNSLookup:
$ref: "#/components/examples/PipelineExamplesDNSLookup"
PipelineExamplesDrop:
$ref: "#/components/examples/PipelineExamplesDrop"
PipelineExamplesDropDimensions:
$ref: "#/components/examples/PipelineExamplesDropDimensions"
PipelineExamplesDynamicSampling:
$ref: "#/components/examples/PipelineExamplesDynamicSampling"
PipelineExamplesEval:
$ref: "#/components/examples/PipelineExamplesEval"
PipelineExamplesEventBreaker:
$ref: "#/components/examples/PipelineExamplesEventBreaker"
PipelineExamplesFlatten:
$ref: "#/components/examples/PipelineExamplesFlatten"
PipelineExamplesFoldKeys:
$ref: "#/components/examples/PipelineExamplesFoldKeys"
PipelineExamplesGeoIP:
$ref: "#/components/examples/PipelineExamplesGeoIP"
PipelineExamplesGrok:
$ref: "#/components/examples/PipelineExamplesGrok"
PipelineExamplesGuard:
$ref: "#/components/examples/PipelineExamplesGuard"
PipelineExamplesJSONUnroll:
$ref: "#/components/examples/PipelineExamplesJSONUnroll"
PipelineExamplesLookup:
$ref: "#/components/examples/PipelineExamplesLookup"
PipelineExamplesMask:
$ref: "#/components/examples/PipelineExamplesMask"
PipelineExamplesNumerify:
$ref: "#/components/examples/PipelineExamplesNumerify"
PipelineExamplesOTLPLogs:
$ref: "#/components/examples/PipelineExamplesOTLPLogs"
PipelineExamplesOTLPMetrics:
$ref: "#/components/examples/PipelineExamplesOTLPMetrics"
PipelineExamplesOTLPTraces:
$ref: "#/components/examples/PipelineExamplesOTLPTraces"
PipelineExamplesParser:
$ref: "#/components/examples/PipelineExamplesParser"
PipelineExamplesPublishMetrics:
$ref: "#/components/examples/PipelineExamplesPublishMetrics"
PipelineExamplesRedis:
$ref: "#/components/examples/PipelineExamplesRedis"
PipelineExamplesRegexExtract:
$ref: "#/components/examples/PipelineExamplesRegexExtract"
PipelineExamplesRegexFilter:
$ref: "#/components/examples/PipelineExamplesRegexFilter"
PipelineExamplesRename:
$ref: "#/components/examples/PipelineExamplesRename"
PipelineExamplesRollupMetrics:
$ref: "#/components/examples/PipelineExamplesRollupMetrics"
PipelineExamplesSampling:
$ref: "#/components/examples/PipelineExamplesSampling"
PipelineExamplesSerialize:
$ref: "#/components/examples/PipelineExamplesSerialize"
PipelineExamplesSNMPTrapSerialize:
$ref: "#/components/examples/PipelineExamplesSNMPTrapSerialize"
PipelineExamplesSuppress:
$ref: "#/components/examples/PipelineExamplesSuppress"
PipelineExamplesTee:
$ref: "#/components/examples/PipelineExamplesTee"
PipelineExamplesUnroll:
$ref: "#/components/examples/PipelineExamplesUnroll"
PipelineExamplesXMLUnroll:
$ref: "#/components/examples/PipelineExamplesXMLUnroll"
parameters:
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/pipelines/{id}:
get:
operationId: getPipelinesByPackAndId
tags:
- pipelines
x-speakeasy-group: packs.pipelines
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Pipeline within a Pack
description: Get the specified Pipeline within the specified Pack.
responses:
"200":
description: The requested Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pipeline to get.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
patch:
operationId: updatePipelinesByPackAndId
tags:
- pipelines
x-speakeasy-group: packs.pipelines
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update a Pipeline within a Pack
description: Update the specified Pipeline within the specified
Pack.
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.
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.
responses:
"200":
description: The updated Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: Pipeline object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Pipeline"
examples:
UpdatePipelineExamplesEmpty:
$ref: "#/components/examples/UpdatePipelineExamplesEmpty"
UpdatePipelineExamplesAggregations:
$ref: "#/components/examples/UpdatePipelineExamplesAggregations"
UpdatePipelineExamplesAggregateMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesAggregateMetrics"
UpdatePipelineExamplesAutoTimestamp:
$ref: "#/components/examples/UpdatePipelineExamplesAutoTimestamp"
UpdatePipelineExamplesCEFSerializer:
$ref: "#/components/examples/UpdatePipelineExamplesCEFSerializer"
UpdatePipelineExamplesChain:
$ref: "#/components/examples/UpdatePipelineExamplesChain"
UpdatePipelineExamplesClone:
$ref: "#/components/examples/UpdatePipelineExamplesClone"
UpdatePipelineExamplesComment:
$ref: "#/components/examples/UpdatePipelineExamplesComment"
UpdatePipelineExamplesDNSLookup:
$ref: "#/components/examples/UpdatePipelineExamplesDNSLookup"
UpdatePipelineExamplesDrop:
$ref: "#/components/examples/UpdatePipelineExamplesDrop"
UpdatePipelineExamplesDropDimensions:
$ref: "#/components/examples/UpdatePipelineExamplesDropDimensions"
UpdatePipelineExamplesDynamicSampling:
$ref: "#/components/examples/UpdatePipelineExamplesDynamicSampling"
UpdatePipelineExamplesEval:
$ref: "#/components/examples/UpdatePipelineExamplesEval"
UpdatePipelineExamplesEventBreaker:
$ref: "#/components/examples/UpdatePipelineExamplesEventBreaker"
UpdatePipelineExamplesFlatten:
$ref: "#/components/examples/UpdatePipelineExamplesFlatten"
UpdatePipelineExamplesFoldKeys:
$ref: "#/components/examples/UpdatePipelineExamplesFoldKeys"
UpdatePipelineExamplesGeoIP:
$ref: "#/components/examples/UpdatePipelineExamplesGeoIP"
UpdatePipelineExamplesGrok:
$ref: "#/components/examples/UpdatePipelineExamplesGrok"
UpdatePipelineExamplesGuard:
$ref: "#/components/examples/UpdatePipelineExamplesGuard"
UpdatePipelineExamplesJSONUnroll:
$ref: "#/components/examples/UpdatePipelineExamplesJSONUnroll"
UpdatePipelineExamplesLookup:
$ref: "#/components/examples/UpdatePipelineExamplesLookup"
UpdatePipelineExamplesMask:
$ref: "#/components/examples/UpdatePipelineExamplesMask"
UpdatePipelineExamplesNumerify:
$ref: "#/components/examples/UpdatePipelineExamplesNumerify"
UpdatePipelineExamplesOTLPLogs:
$ref: "#/components/examples/UpdatePipelineExamplesOTLPLogs"
UpdatePipelineExamplesOTLPMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesOTLPMetrics"
UpdatePipelineExamplesOTLPTraces:
$ref: "#/components/examples/UpdatePipelineExamplesOTLPTraces"
UpdatePipelineExamplesParser:
$ref: "#/components/examples/UpdatePipelineExamplesParser"
UpdatePipelineExamplesPublishMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesPublishMetrics"
UpdatePipelineExamplesRedis:
$ref: "#/components/examples/UpdatePipelineExamplesRedis"
UpdatePipelineExamplesRegexExtract:
$ref: "#/components/examples/UpdatePipelineExamplesRegexExtract"
UpdatePipelineExamplesRegexFilter:
$ref: "#/components/examples/UpdatePipelineExamplesRegexFilter"
UpdatePipelineExamplesRename:
$ref: "#/components/examples/UpdatePipelineExamplesRename"
UpdatePipelineExamplesRollupMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesRollupMetrics"
UpdatePipelineExamplesSampling:
$ref: "#/components/examples/UpdatePipelineExamplesSampling"
UpdatePipelineExamplesSerialize:
$ref: "#/components/examples/UpdatePipelineExamplesSerialize"
UpdatePipelineExamplesSNMPTrapSerialize:
$ref: "#/components/examples/UpdatePipelineExamplesSNMPTrapSerialize"
UpdatePipelineExamplesSuppress:
$ref: "#/components/examples/UpdatePipelineExamplesSuppress"
UpdatePipelineExamplesTee:
$ref: "#/components/examples/UpdatePipelineExamplesTee"
UpdatePipelineExamplesUnroll:
$ref: "#/components/examples/UpdatePipelineExamplesUnroll"
UpdatePipelineExamplesXMLUnroll:
$ref: "#/components/examples/UpdatePipelineExamplesXMLUnroll"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pipeline to update.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
delete:
operationId: deletePipelinesByPackAndId
tags:
- pipelines
x-speakeasy-group: packs.pipelines
x-speakeasy-name-override: delete
x-cribl-internal: false
x-cribl-availability: both
summary: Delete a Pipeline within a Pack
description: Delete the specified Pipeline within the specified Pack.
responses:
"200":
description: The deleted Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pipeline to delete.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/routes:
get:
operationId: getRoutesByPack
tags:
- routes
x-speakeasy-group: packs.routes
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Routes within a Pack
description: Get a list of all Routes within the specified Pack.
responses:
"200":
description: List of Routing table objects.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/routes/{id}:
get:
operationId: getRoutesByPackAndId
tags:
- routes
x-speakeasy-group: packs.routes
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Routing table within a Pack
description: Get the specified Routing table within the specified Pack.
responses:
"200":
description: The requested Routing table object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Routing table not found. The specified id does not
match any stored Routing table.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Routing table to get. The supported
value is default.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
patch:
operationId: updateRoutesByPackAndId
tags:
- routes
x-speakeasy-group: packs.routes
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update a Routing table within a Pack
description: Update the specified Routing table within the specified
Pack.
Provide a complete representation of the Routing table
that you want to update in the request body.
This endpoint does
not support partial updates. Cribl removes any omitted fields when
updating the Routing table.
Confirm that the configuration in
your request body is correct before sending the request. If the
configuration is incorrect, the updated Routing table might not function
as expected.
Cribl also removes any omitted Routes when
updating the Routing table.
responses:
"200":
description: The updated Routing table object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Routing table not found. The specified id does not
match any stored Routing table.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: RoutesInput object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RoutesInput"
examples:
RoutesUpdateExamplesBasicRoute:
$ref: "#/components/examples/RoutesUpdateExamplesBasicRoute"
RoutesUpdateExamplesMultipleRoutes:
$ref: "#/components/examples/RoutesUpdateExamplesMultipleRoutes"
RoutesUpdateExamplesRouteWithOutputExpression:
$ref: "#/components/examples/RoutesUpdateExamplesRouteWithOutputExpression"
RoutesUpdateExamplesRouteWithDefaults:
$ref: "#/components/examples/RoutesUpdateExamplesRouteWithDefaults"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Routing table to update. The supported
value is default.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/routes/{id}/append:
post:
operationId: createRoutesAppendByPackAndId
tags:
- routes
x-speakeasy-group: packs.routes
x-speakeasy-name-override: append
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The updated Routing table object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"400":
description: Failed validation or malformed input. The request body must be an
array of Route configurations.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Routing table not found. The specified id does not
match any stored Routing table.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: RouteDefinitions object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RouteDefinitions"
examples:
RoutesAppendExamplesSingleRoute:
$ref: "#/components/examples/RoutesAppendExamplesSingleRoute"
RoutesAppendExamplesMultipleRoutes:
$ref: "#/components/examples/RoutesAppendExamplesMultipleRoutes"
RoutesAppendExamplesRouteWithOutputExpression:
$ref: "#/components/examples/RoutesAppendExamplesRouteWithOutputExpression"
RoutesAppendExamplesRouteWithDefaults:
$ref: "#/components/examples/RoutesAppendExamplesRouteWithDefaults"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Routing table to add the Route to. The
supported value is default.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/inputs:
get:
operationId: getInputSystemByPack
x-speakeasy-group: packs.sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: list
tags:
- sources
summary: List all Sources within a Pack
description: Get a list of all Sources within the specified Pack.
responses:
"200":
description: List of Source objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: type
in: query
required: false
schema:
$ref: "#/components/schemas/SourceType"
description: Type of Source to include in the results. Each request can include
only one type parameter; multiple parameters per
request are not supported.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createInputSystemByPack
x-speakeasy-group: packs.sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: create
tags:
- sources
summary: Create a Source within a Pack
description: Create a new Source. The system-managed provenance field (JSON
criblSourceProvenance) must be omitted from the request
body within the specified Pack.
requestBody:
description: Input object.
required: true
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/Input"
- type: object
required:
- id
examples:
InputCreateExamplesAnthropicCompliance:
$ref: "#/components/examples/InputCreateExamplesAnthropicCompliance"
InputCreateExamplesAppleUnifiedLogs:
$ref: "#/components/examples/InputCreateExamplesAppleUnifiedLogs"
InputCreateExamplesAppscope:
$ref: "#/components/examples/InputCreateExamplesAppscope"
InputCreateExamplesAzureBlob:
$ref: "#/components/examples/InputCreateExamplesAzureBlob"
InputCreateExamplesCloudflareHec:
$ref: "#/components/examples/InputCreateExamplesCloudflareHec"
InputCreateExamplesConfluentCloud:
$ref: "#/components/examples/InputCreateExamplesConfluentCloud"
InputCreateExamplesCollection:
$ref: "#/components/examples/InputCreateExamplesCollection"
InputCreateExamplesCriblHttp:
$ref: "#/components/examples/InputCreateExamplesCriblHttp"
InputCreateExamplesCriblLakeHttp:
$ref: "#/components/examples/InputCreateExamplesCriblLakeHttp"
InputCreateExamplesCriblTcp:
$ref: "#/components/examples/InputCreateExamplesCriblTcp"
InputCreateExamplesCrowdstrike:
$ref: "#/components/examples/InputCreateExamplesCrowdstrike"
InputCreateExamplesDatadogAgent:
$ref: "#/components/examples/InputCreateExamplesDatadogAgent"
InputCreateExamplesDatagen:
$ref: "#/components/examples/InputCreateExamplesDatagen"
InputCreateExamplesEdgePrometheus:
$ref: "#/components/examples/InputCreateExamplesEdgePrometheus"
InputCreateExamplesElastic:
$ref: "#/components/examples/InputCreateExamplesElastic"
InputCreateExamplesEventhub:
$ref: "#/components/examples/InputCreateExamplesEventhub"
InputCreateExamplesEventhubAmqp:
$ref: "#/components/examples/InputCreateExamplesEventhubAmqp"
InputCreateExamplesExec:
$ref: "#/components/examples/InputCreateExamplesExec"
InputCreateExamplesFile:
$ref: "#/components/examples/InputCreateExamplesFile"
InputCreateExamplesFirehose:
$ref: "#/components/examples/InputCreateExamplesFirehose"
InputCreateExamplesGrafana:
$ref: "#/components/examples/InputCreateExamplesGrafana"
InputCreateExamplesGooglePubsub:
$ref: "#/components/examples/InputCreateExamplesGooglePubsub"
InputCreateExamplesHttp:
$ref: "#/components/examples/InputCreateExamplesHttp"
InputCreateExamplesHttpRaw:
$ref: "#/components/examples/InputCreateExamplesHttpRaw"
InputCreateExamplesJournalFiles:
$ref: "#/components/examples/InputCreateExamplesJournalFiles"
InputCreateExamplesKafka:
$ref: "#/components/examples/InputCreateExamplesKafka"
InputCreateExamplesKinesis:
$ref: "#/components/examples/InputCreateExamplesKinesis"
InputCreateExamplesKubeEvents:
$ref: "#/components/examples/InputCreateExamplesKubeEvents"
InputCreateExamplesKubeLogs:
$ref: "#/components/examples/InputCreateExamplesKubeLogs"
InputCreateExamplesKubeMetrics:
$ref: "#/components/examples/InputCreateExamplesKubeMetrics"
InputCreateExamplesLoki:
$ref: "#/components/examples/InputCreateExamplesLoki"
InputCreateExamplesMetrics:
$ref: "#/components/examples/InputCreateExamplesMetrics"
InputCreateExamplesModelDrivenTelemetry:
$ref: "#/components/examples/InputCreateExamplesModelDrivenTelemetry"
InputCreateExamplesMsk:
$ref: "#/components/examples/InputCreateExamplesMsk"
InputCreateExamplesNetflow:
$ref: "#/components/examples/InputCreateExamplesNetflow"
InputCreateExamplesOffice365Mgmt:
$ref: "#/components/examples/InputCreateExamplesOffice365Mgmt"
InputCreateExamplesMicrosoftGraph:
$ref: "#/components/examples/InputCreateExamplesMicrosoftGraph"
InputCreateExamplesOffice365MsgTrace:
$ref: "#/components/examples/InputCreateExamplesOffice365MsgTrace"
InputCreateExamplesOffice365Service:
$ref: "#/components/examples/InputCreateExamplesOffice365Service"
InputCreateExamplesOkta:
$ref: "#/components/examples/InputCreateExamplesOkta"
InputCreateExamplesOpenAI:
$ref: "#/components/examples/InputCreateExamplesOpenAI"
InputCreateExamplesOpenAIComplianceLogs:
$ref: "#/components/examples/InputCreateExamplesOpenAIComplianceLogs"
InputCreateExamplesOpenTelemetry:
$ref: "#/components/examples/InputCreateExamplesOpenTelemetry"
InputCreateExamplesPrometheus:
$ref: "#/components/examples/InputCreateExamplesPrometheus"
InputCreateExamplesPrometheusRw:
$ref: "#/components/examples/InputCreateExamplesPrometheusRw"
InputCreateExamplesRawUdp:
$ref: "#/components/examples/InputCreateExamplesRawUdp"
InputCreateExamplesBedrockS3:
$ref: "#/components/examples/InputCreateExamplesBedrockS3"
InputCreateExamplesS3:
$ref: "#/components/examples/InputCreateExamplesS3"
InputCreateExamplesS3Inventory:
$ref: "#/components/examples/InputCreateExamplesS3Inventory"
InputCreateExamplesSecurityLake:
$ref: "#/components/examples/InputCreateExamplesSecurityLake"
InputCreateExamplesServiceNowTable:
$ref: "#/components/examples/InputCreateExamplesServiceNowTable"
InputCreateExamplesSnmp:
$ref: "#/components/examples/InputCreateExamplesSnmp"
InputCreateExamplesSplunk:
$ref: "#/components/examples/InputCreateExamplesSplunk"
InputCreateExamplesSplunkHec:
$ref: "#/components/examples/InputCreateExamplesSplunkHec"
InputCreateExamplesSplunkSearch:
$ref: "#/components/examples/InputCreateExamplesSplunkSearch"
InputCreateExamplesSqs:
$ref: "#/components/examples/InputCreateExamplesSqs"
InputCreateExamplesSysdigHec:
$ref: "#/components/examples/InputCreateExamplesSysdigHec"
InputCreateExamplesSyslog:
$ref: "#/components/examples/InputCreateExamplesSyslog"
InputCreateExamplesSyslogWithPQ:
$ref: "#/components/examples/InputCreateExamplesSyslogWithPQ"
InputCreateExamplesSystemMetrics:
$ref: "#/components/examples/InputCreateExamplesSystemMetrics"
InputCreateExamplesSystemState:
$ref: "#/components/examples/InputCreateExamplesSystemState"
InputCreateExamplesTcp:
$ref: "#/components/examples/InputCreateExamplesTcp"
InputCreateExamplesTcpjson:
$ref: "#/components/examples/InputCreateExamplesTcpjson"
InputCreateExamplesUpwindHec:
$ref: "#/components/examples/InputCreateExamplesUpwindHec"
InputCreateExamplesWef:
$ref: "#/components/examples/InputCreateExamplesWef"
InputCreateExamplesWinEventLogs:
$ref: "#/components/examples/InputCreateExamplesWinEventLogs"
InputCreateExamplesWindowsMetrics:
$ref: "#/components/examples/InputCreateExamplesWindowsMetrics"
InputCreateExamplesWiz:
$ref: "#/components/examples/InputCreateExamplesWiz"
InputCreateExamplesWizWebhook:
$ref: "#/components/examples/InputCreateExamplesWizWebhook"
InputCreateExamplesZscalerHec:
$ref: "#/components/examples/InputCreateExamplesZscalerHec"
responses:
"200":
description: The created Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"409":
description: Request conflicts with current resource state — source with the
same ID already exists.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/inputs/{id}:
get:
operationId: getInputSystemByPackAndId
x-speakeasy-group: packs.sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: get
tags:
- sources
summary: Get a Source within a Pack
description: Get the specified Source within the specified Pack.
responses:
"200":
description: The requested Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist — Source not found.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to get.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
patch:
operationId: updateInputSystemByPackAndId
x-speakeasy-group: packs.sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: update
tags:
- sources
summary: Update a Source within a Pack
description: Update the specified Source.
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.
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.
Cribl preserves
criblSourceProvenance when you omit it from the request
body, and you cannot overwrite it through this endpoint within the
specified Pack.
requestBody:
description: Input object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Input"
examples:
UpdateInputExamplesAnthropicCompliance:
$ref: "#/components/examples/UpdateInputExamplesAnthropicCompliance"
UpdateInputExamplesAppleUnifiedLogs:
$ref: "#/components/examples/UpdateInputExamplesAppleUnifiedLogs"
UpdateInputExamplesAppscope:
$ref: "#/components/examples/UpdateInputExamplesAppscope"
UpdateInputExamplesAzureBlob:
$ref: "#/components/examples/UpdateInputExamplesAzureBlob"
UpdateInputExamplesCloudflareHec:
$ref: "#/components/examples/UpdateInputExamplesCloudflareHec"
UpdateInputExamplesConfluentCloud:
$ref: "#/components/examples/UpdateInputExamplesConfluentCloud"
UpdateInputExamplesCollection:
$ref: "#/components/examples/UpdateInputExamplesCollection"
UpdateInputExamplesCribl:
$ref: "#/components/examples/UpdateInputExamplesCribl"
UpdateInputExamplesCriblHttp:
$ref: "#/components/examples/UpdateInputExamplesCriblHttp"
UpdateInputExamplesCriblLakeHttp:
$ref: "#/components/examples/UpdateInputExamplesCriblLakeHttp"
UpdateInputExamplesCriblMetrics:
$ref: "#/components/examples/UpdateInputExamplesCriblMetrics"
UpdateInputExamplesCriblTcp:
$ref: "#/components/examples/UpdateInputExamplesCriblTcp"
UpdateInputExamplesCrowdstrike:
$ref: "#/components/examples/UpdateInputExamplesCrowdstrike"
UpdateInputExamplesDatadogAgent:
$ref: "#/components/examples/UpdateInputExamplesDatadogAgent"
UpdateInputExamplesDatagen:
$ref: "#/components/examples/UpdateInputExamplesDatagen"
UpdateInputExamplesEdgePrometheus:
$ref: "#/components/examples/UpdateInputExamplesEdgePrometheus"
UpdateInputExamplesElastic:
$ref: "#/components/examples/UpdateInputExamplesElastic"
UpdateInputExamplesEventhub:
$ref: "#/components/examples/UpdateInputExamplesEventhub"
UpdateInputExamplesEventhubAmqp:
$ref: "#/components/examples/UpdateInputExamplesEventhubAmqp"
UpdateInputExamplesExec:
$ref: "#/components/examples/UpdateInputExamplesExec"
UpdateInputExamplesFile:
$ref: "#/components/examples/UpdateInputExamplesFile"
UpdateInputExamplesFirehose:
$ref: "#/components/examples/UpdateInputExamplesFirehose"
UpdateInputExamplesGrafana:
$ref: "#/components/examples/UpdateInputExamplesGrafana"
UpdateInputExamplesGooglePubsub:
$ref: "#/components/examples/UpdateInputExamplesGooglePubsub"
UpdateInputExamplesHttp:
$ref: "#/components/examples/UpdateInputExamplesHttp"
UpdateInputExamplesHttpRaw:
$ref: "#/components/examples/UpdateInputExamplesHttpRaw"
UpdateInputExamplesJournalFiles:
$ref: "#/components/examples/UpdateInputExamplesJournalFiles"
UpdateInputExamplesKafka:
$ref: "#/components/examples/UpdateInputExamplesKafka"
UpdateInputExamplesKinesis:
$ref: "#/components/examples/UpdateInputExamplesKinesis"
UpdateInputExamplesKubeEvents:
$ref: "#/components/examples/UpdateInputExamplesKubeEvents"
UpdateInputExamplesKubeLogs:
$ref: "#/components/examples/UpdateInputExamplesKubeLogs"
UpdateInputExamplesKubeMetrics:
$ref: "#/components/examples/UpdateInputExamplesKubeMetrics"
UpdateInputExamplesLoki:
$ref: "#/components/examples/UpdateInputExamplesLoki"
UpdateInputExamplesMetrics:
$ref: "#/components/examples/UpdateInputExamplesMetrics"
UpdateInputExamplesModelDrivenTelemetry:
$ref: "#/components/examples/UpdateInputExamplesModelDrivenTelemetry"
UpdateInputExamplesMsk:
$ref: "#/components/examples/UpdateInputExamplesMsk"
UpdateInputExamplesNetflow:
$ref: "#/components/examples/UpdateInputExamplesNetflow"
UpdateInputExamplesOffice365Mgmt:
$ref: "#/components/examples/UpdateInputExamplesOffice365Mgmt"
UpdateInputExamplesMicrosoftGraph:
$ref: "#/components/examples/UpdateInputExamplesMicrosoftGraph"
UpdateInputExamplesOffice365MsgTrace:
$ref: "#/components/examples/UpdateInputExamplesOffice365MsgTrace"
UpdateInputExamplesOffice365Service:
$ref: "#/components/examples/UpdateInputExamplesOffice365Service"
UpdateInputExamplesOkta:
$ref: "#/components/examples/UpdateInputExamplesOkta"
UpdateInputExamplesOpenAI:
$ref: "#/components/examples/UpdateInputExamplesOpenAI"
UpdateInputExamplesOpenAIComplianceLogs:
$ref: "#/components/examples/UpdateInputExamplesOpenAIComplianceLogs"
UpdateInputExamplesOpenTelemetry:
$ref: "#/components/examples/UpdateInputExamplesOpenTelemetry"
UpdateInputExamplesPrometheus:
$ref: "#/components/examples/UpdateInputExamplesPrometheus"
UpdateInputExamplesPrometheusRw:
$ref: "#/components/examples/UpdateInputExamplesPrometheusRw"
UpdateInputExamplesRawUdp:
$ref: "#/components/examples/UpdateInputExamplesRawUdp"
UpdateInputExamplesBedrockS3:
$ref: "#/components/examples/UpdateInputExamplesBedrockS3"
UpdateInputExamplesS3:
$ref: "#/components/examples/UpdateInputExamplesS3"
UpdateInputExamplesS3Inventory:
$ref: "#/components/examples/UpdateInputExamplesS3Inventory"
UpdateInputExamplesSecurityLake:
$ref: "#/components/examples/UpdateInputExamplesSecurityLake"
UpdateInputExamplesServiceNowTable:
$ref: "#/components/examples/UpdateInputExamplesServiceNowTable"
UpdateInputExamplesSnmp:
$ref: "#/components/examples/UpdateInputExamplesSnmp"
UpdateInputExamplesSplunk:
$ref: "#/components/examples/UpdateInputExamplesSplunk"
UpdateInputExamplesSplunkHec:
$ref: "#/components/examples/UpdateInputExamplesSplunkHec"
UpdateInputExamplesSplunkSearch:
$ref: "#/components/examples/UpdateInputExamplesSplunkSearch"
UpdateInputExamplesSqs:
$ref: "#/components/examples/UpdateInputExamplesSqs"
UpdateInputExamplesSysdigHec:
$ref: "#/components/examples/UpdateInputExamplesSysdigHec"
UpdateInputExamplesSyslog:
$ref: "#/components/examples/UpdateInputExamplesSyslog"
UpdateInputExamplesSyslogWithPQ:
$ref: "#/components/examples/UpdateInputExamplesSyslogWithPQ"
UpdateInputExamplesSystemMetrics:
$ref: "#/components/examples/UpdateInputExamplesSystemMetrics"
UpdateInputExamplesSystemState:
$ref: "#/components/examples/UpdateInputExamplesSystemState"
UpdateInputExamplesTcp:
$ref: "#/components/examples/UpdateInputExamplesTcp"
UpdateInputExamplesTcpjson:
$ref: "#/components/examples/UpdateInputExamplesTcpjson"
UpdateInputExamplesUpwindHec:
$ref: "#/components/examples/UpdateInputExamplesUpwindHec"
UpdateInputExamplesWef:
$ref: "#/components/examples/UpdateInputExamplesWef"
UpdateInputExamplesWinEventLogs:
$ref: "#/components/examples/UpdateInputExamplesWinEventLogs"
UpdateInputExamplesWindowsMetrics:
$ref: "#/components/examples/UpdateInputExamplesWindowsMetrics"
UpdateInputExamplesWiz:
$ref: "#/components/examples/UpdateInputExamplesWiz"
UpdateInputExamplesWizWebhook:
$ref: "#/components/examples/UpdateInputExamplesWizWebhook"
UpdateInputExamplesZscalerHec:
$ref: "#/components/examples/UpdateInputExamplesZscalerHec"
responses:
"200":
description: The updated Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to update.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
delete:
operationId: deleteInputSystemByPackAndId
x-speakeasy-group: packs.sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: delete
tags:
- sources
summary: Delete a Source within a Pack
description: Delete the specified Source within the specified Pack.
responses:
"200":
description: The deleted Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to delete.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/inputs/{id}/hectoken:
post:
operationId: createInputSystemHecTokenByPackAndId
tags:
- sources
x-speakeasy-group: packs.sources.hecTokens
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Add an HEC token and optional metadata to a Splunk HEC Source within a
Pack
description: Add an HEC token and optional metadata to the specified Splunk HEC
Source within the specified Pack.
responses:
"200":
description: The updated Splunk HEC Source with the new HEC token.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputSplunkHec"
examples:
HecTokenResponseExamplesSplunkHecSource:
$ref: "#/components/examples/HecTokenResponseExamplesSplunkHecSource"
"400":
description: Failed validation or malformed input — Source not found, source
type is not splunk_hec, or request payload is invalid.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: AddHecTokenRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddHecTokenRequest"
examples:
HecTokenExamplesHecToken:
$ref: "#/components/examples/HecTokenExamplesHecToken"
HecTokenExamplesHecTokenWithIndexAccess:
$ref: "#/components/examples/HecTokenExamplesHecTokenWithIndexAccess"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Splunk HEC Source.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/inputs/{id}/hectoken/{token}:
patch:
operationId: updateInputSystemHecTokenByPackAndIdAndToken
tags:
- sources
x-speakeasy-group: packs.sources.hecTokens
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update metadata for an HEC token for a Splunk HEC Source within a Pack
description: Update the metadata for the specified HEC token for the specified
Splunk HEC Source within the specified Pack.
responses:
"200":
description: The updated Splunk HEC Source with the modified HEC token metadata.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputSplunkHec"
examples:
HecTokenResponseExamplesSplunkHecSource:
$ref: "#/components/examples/HecTokenResponseExamplesSplunkHecSource"
"400":
description: Failed validation or malformed input — Source not found, source
type is not splunk_hec, or request payload is invalid.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: UpdateHecTokenRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateHecTokenRequest"
examples:
HecTokenExamplesHecToken:
$ref: "#/components/examples/HecTokenExamplesHecToken"
HecTokenExamplesHecTokenWithIndexAccess:
$ref: "#/components/examples/HecTokenExamplesHecTokenWithIndexAccess"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Splunk HEC Source.
- name: token
in: path
required: true
schema:
type: string
description: The HEC token value whose metadata you want to update. Must match
an existing token on the Source.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/inputs/{id}/pq:
delete:
operationId: deleteInputSystemPqByPackAndId
tags:
- sources
x-speakeasy-group: packs.sources.pq
x-speakeasy-name-override: clear
x-cribl-internal: false
x-cribl-availability: both
summary: Clear the persistent queue for a Source within a Pack
description: Clear the persistent queue (PQ) for the specified Source within the
specified Pack.
responses:
"201":
description: A list of job ids for the background job that clears the persistent
queue
content:
application/json:
schema:
$ref: "#/components/schemas/CountedString"
examples:
ClearPQResponseExamplesClearPQJob:
$ref: "#/components/examples/ClearPQResponseExamplesClearPQJob"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to clear the PQ for.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
get:
operationId: getInputSystemPqByPackAndId
tags:
- sources
x-speakeasy-group: packs.sources.pq
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get information about the latest job to clear the persistent queue for
a Source within a Pack
description: Get information about the latest job to clear the persistent queue
(PQ) for the specified Source within the specified Pack.
responses:
"200":
description: The latest clear-PQ job information for the specified Source.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedJobInfo"
examples:
PQStatusResponseExamplesCompletedJob:
$ref: "#/components/examples/PQStatusResponseExamplesCompletedJob"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to get PQ job information for.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/outputs:
get:
operationId: getOutputSystemByPack
x-speakeasy-group: packs.destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: list
tags:
- destinations
summary: List all Destinations within a Pack
description: Get a list of all Destinations within the specified Pack.
responses:
"200":
description: List of Destination objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: type
in: query
required: false
schema:
$ref: "#/components/schemas/DestinationType"
description: Type of Destination to include in the results. Each request can
include only one type parameter; multiple parameters
per request are not supported.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createOutputSystemByPack
x-speakeasy-group: packs.destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: create
tags:
- destinations
summary: Create a Destination within a Pack
description: Create a new Destination within the specified Pack.
requestBody:
description: Output object.
required: true
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/Output"
- type: object
required:
- id
examples:
OutputCreateExamplesTcpjson:
$ref: "#/components/examples/OutputCreateExamplesTcpjson"
OutputCreateExamplesSplunk:
$ref: "#/components/examples/OutputCreateExamplesSplunk"
OutputCreateExamplesSplunkLb:
$ref: "#/components/examples/OutputCreateExamplesSplunkLb"
OutputCreateExamplesSplunkHec:
$ref: "#/components/examples/OutputCreateExamplesSplunkHec"
OutputCreateExamplesSyslog:
$ref: "#/components/examples/OutputCreateExamplesSyslog"
OutputCreateExamplesFilesystem:
$ref: "#/components/examples/OutputCreateExamplesFilesystem"
OutputCreateExamplesS3:
$ref: "#/components/examples/OutputCreateExamplesS3"
OutputCreateExamplesNutanixObjects:
$ref: "#/components/examples/OutputCreateExamplesNutanixObjects"
OutputCreateExamplesStorjS3:
$ref: "#/components/examples/OutputCreateExamplesStorjS3"
OutputCreateExamplesAlphasocS3:
$ref: "#/components/examples/OutputCreateExamplesAlphasocS3"
OutputCreateExamplesdellS3:
$ref: "#/components/examples/OutputCreateExamplesdellS3"
OutputCreateExamplescloudianS3:
$ref: "#/components/examples/OutputCreateExamplescloudianS3"
OutputCreateExamplesscalityS3:
$ref: "#/components/examples/OutputCreateExamplesscalityS3"
OutputCreateExamplesalibabaCloudS3:
$ref: "#/components/examples/OutputCreateExamplesalibabaCloudS3"
OutputCreateExamplesibmCloudS3:
$ref: "#/components/examples/OutputCreateExamplesibmCloudS3"
OutputCreateExamplesAzureBlob:
$ref: "#/components/examples/OutputCreateExamplesAzureBlob"
OutputCreateExamplesAzureDataExplorer:
$ref: "#/components/examples/OutputCreateExamplesAzureDataExplorer"
OutputCreateExamplesSentinel:
$ref: "#/components/examples/OutputCreateExamplesSentinel"
OutputCreateExamplesAzureLogs:
$ref: "#/components/examples/OutputCreateExamplesAzureLogs"
OutputCreateExamplesKafka:
$ref: "#/components/examples/OutputCreateExamplesKafka"
OutputCreateExamplesConfluentCloud:
$ref: "#/components/examples/OutputCreateExamplesConfluentCloud"
OutputCreateExamplesMsk:
$ref: "#/components/examples/OutputCreateExamplesMsk"
OutputCreateExamplesKinesis:
$ref: "#/components/examples/OutputCreateExamplesKinesis"
OutputCreateExamplesElastic:
$ref: "#/components/examples/OutputCreateExamplesElastic"
OutputCreateExamplesElasticCloud:
$ref: "#/components/examples/OutputCreateExamplesElasticCloud"
OutputCreateExamplesMicrosoftFabric:
$ref: "#/components/examples/OutputCreateExamplesMicrosoftFabric"
OutputCreateExamplesCloudflareR2:
$ref: "#/components/examples/OutputCreateExamplesCloudflareR2"
OutputCreateExamplesHoneycomb:
$ref: "#/components/examples/OutputCreateExamplesHoneycomb"
OutputCreateExamplesNewrelic:
$ref: "#/components/examples/OutputCreateExamplesNewrelic"
OutputCreateExamplesNewrelicEvents:
$ref: "#/components/examples/OutputCreateExamplesNewrelicEvents"
OutputCreateExamplesSnmp:
$ref: "#/components/examples/OutputCreateExamplesSnmp"
OutputCreateExamplesInfluxdb:
$ref: "#/components/examples/OutputCreateExamplesInfluxdb"
OutputCreateExamplesMinio:
$ref: "#/components/examples/OutputCreateExamplesMinio"
OutputCreateExamplesCloudwatch:
$ref: "#/components/examples/OutputCreateExamplesCloudwatch"
OutputCreateExamplesAzureEventhub:
$ref: "#/components/examples/OutputCreateExamplesAzureEventhub"
OutputCreateExamplesStatsd:
$ref: "#/components/examples/OutputCreateExamplesStatsd"
OutputCreateExamplesStatsdExt:
$ref: "#/components/examples/OutputCreateExamplesStatsdExt"
OutputCreateExamplesGraphite:
$ref: "#/components/examples/OutputCreateExamplesGraphite"
OutputCreateExamplesWavefront:
$ref: "#/components/examples/OutputCreateExamplesWavefront"
OutputCreateExamplesSignalfx:
$ref: "#/components/examples/OutputCreateExamplesSignalfx"
OutputCreateExamplesSqs:
$ref: "#/components/examples/OutputCreateExamplesSqs"
OutputCreateExamplesGoogleCloudStorage:
$ref: "#/components/examples/OutputCreateExamplesGoogleCloudStorage"
OutputCreateExamplesSumoLogic:
$ref: "#/components/examples/OutputCreateExamplesSumoLogic"
OutputCreateExamplesDatadog:
$ref: "#/components/examples/OutputCreateExamplesDatadog"
OutputCreateExamplesWebhook:
$ref: "#/components/examples/OutputCreateExamplesWebhook"
OutputCreateExamplesPrometheus:
$ref: "#/components/examples/OutputCreateExamplesPrometheus"
OutputCreateExamplesAmazonManagedPrometheus:
$ref: "#/components/examples/OutputCreateExamplesAmazonManagedPrometheus"
OutputCreateExamplesGooglePubsub:
$ref: "#/components/examples/OutputCreateExamplesGooglePubsub"
OutputCreateExamplesGoogleBigQuery:
$ref: "#/components/examples/OutputCreateExamplesGoogleBigQuery"
OutputCreateExamplesGoogleChronicle:
$ref: "#/components/examples/OutputCreateExamplesGoogleChronicle"
OutputCreateExamplesChronicle:
$ref: "#/components/examples/OutputCreateExamplesChronicle"
OutputCreateExamplesGrafanaCloud:
$ref: "#/components/examples/OutputCreateExamplesGrafanaCloud"
OutputCreateExamplesLoki:
$ref: "#/components/examples/OutputCreateExamplesLoki"
OutputCreateExamplesOpenTelemetry:
$ref: "#/components/examples/OutputCreateExamplesOpenTelemetry"
OutputCreateExamplesServiceNow:
$ref: "#/components/examples/OutputCreateExamplesServiceNow"
OutputCreateExamplesDynatraceOtlp:
$ref: "#/components/examples/OutputCreateExamplesDynatraceOtlp"
OutputCreateExamplesGoogleCloudObservability:
$ref: "#/components/examples/OutputCreateExamplesGoogleCloudObservability"
OutputCreateExamplesSentinelOneAiSiem:
$ref: "#/components/examples/OutputCreateExamplesSentinelOneAiSiem"
OutputCreateExamplesDataset:
$ref: "#/components/examples/OutputCreateExamplesDataset"
OutputCreateExamplesRing:
$ref: "#/components/examples/OutputCreateExamplesRing"
OutputCreateExamplesRouter:
$ref: "#/components/examples/OutputCreateExamplesRouter"
OutputCreateExamplesWizHec:
$ref: "#/components/examples/OutputCreateExamplesWizHec"
OutputCreateExamplesHumioHec:
$ref: "#/components/examples/OutputCreateExamplesHumioHec"
OutputCreateExamplesCrowdstrikeNextGenSiem:
$ref: "#/components/examples/OutputCreateExamplesCrowdstrikeNextGenSiem"
OutputCreateExamplesCriblHttp:
$ref: "#/components/examples/OutputCreateExamplesCriblHttp"
OutputCreateExamplesCriblTcp:
$ref: "#/components/examples/OutputCreateExamplesCriblTcp"
OutputCreateExamplesCriblSearchEngine:
$ref: "#/components/examples/OutputCreateExamplesCriblSearchEngine"
OutputCreateExamplesGoogleCloudLogging:
$ref: "#/components/examples/OutputCreateExamplesGoogleCloudLogging"
OutputCreateExamplesSns:
$ref: "#/components/examples/OutputCreateExamplesSns"
OutputCreateExamplesDlS3:
$ref: "#/components/examples/OutputCreateExamplesDlS3"
OutputCreateExamplesSecurityLake:
$ref: "#/components/examples/OutputCreateExamplesSecurityLake"
OutputCreateExamplesCriblLake:
$ref: "#/components/examples/OutputCreateExamplesCriblLake"
OutputCreateExamplesExabeam:
$ref: "#/components/examples/OutputCreateExamplesExabeam"
OutputCreateExamplesDiskSpool:
$ref: "#/components/examples/OutputCreateExamplesDiskSpool"
OutputCreateExamplesClickHouse:
$ref: "#/components/examples/OutputCreateExamplesClickHouse"
OutputCreateExamplesLocalSearchStorage:
$ref: "#/components/examples/OutputCreateExamplesLocalSearchStorage"
OutputCreateExamplesCustomerMetricsStorage:
$ref: "#/components/examples/OutputCreateExamplesCustomerMetricsStorage"
OutputCreateExamplesXsiam:
$ref: "#/components/examples/OutputCreateExamplesXsiam"
OutputCreateExamplesNetflow:
$ref: "#/components/examples/OutputCreateExamplesNetflow"
OutputCreateExamplesDynatraceHttp:
$ref: "#/components/examples/OutputCreateExamplesDynatraceHttp"
OutputCreateExamplesDatabricks:
$ref: "#/components/examples/OutputCreateExamplesDatabricks"
OutputCreateExamplesSnowflakeStreaming:
$ref: "#/components/examples/OutputCreateExamplesSnowflakeStreaming"
responses:
"200":
description: The created Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"409":
description: Request conflicts with current resource state — Destination with
the specified ID already exists.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/outputs/{id}:
get:
operationId: getOutputSystemByPackAndId
x-speakeasy-group: packs.destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: get
tags:
- destinations
summary: Get a Destination within a Pack
description: Get the specified Destination within the specified Pack.
responses:
"200":
description: The requested Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to get.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
patch:
operationId: updateOutputSystemByPackAndId
x-speakeasy-group: packs.destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: update
tags:
- destinations
summary: Update a Destination within a Pack
description: Update the specified Destination.
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.
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 within the specified Pack.
requestBody:
description: Output object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Output"
examples:
UpdateOutputExamplesDefault:
$ref: "#/components/examples/UpdateOutputExamplesDefault"
UpdateOutputExamplesTcpjson:
$ref: "#/components/examples/UpdateOutputExamplesTcpjson"
UpdateOutputExamplesSplunk:
$ref: "#/components/examples/UpdateOutputExamplesSplunk"
UpdateOutputExamplesSplunkLb:
$ref: "#/components/examples/UpdateOutputExamplesSplunkLb"
UpdateOutputExamplesSplunkHec:
$ref: "#/components/examples/UpdateOutputExamplesSplunkHec"
UpdateOutputExamplesSyslog:
$ref: "#/components/examples/UpdateOutputExamplesSyslog"
UpdateOutputExamplesFilesystem:
$ref: "#/components/examples/UpdateOutputExamplesFilesystem"
UpdateOutputExamplesS3:
$ref: "#/components/examples/UpdateOutputExamplesS3"
UpdateOutputExamplesNutanixObjects:
$ref: "#/components/examples/UpdateOutputExamplesNutanixObjects"
UpdateOutputExamplesStorjS3:
$ref: "#/components/examples/UpdateOutputExamplesStorjS3"
UpdateOutputExamplesAlphasocS3:
$ref: "#/components/examples/UpdateOutputExamplesAlphasocS3"
UpdateOutputExamplesdellS3:
$ref: "#/components/examples/UpdateOutputExamplesdellS3"
UpdateOutputExamplescloudianS3:
$ref: "#/components/examples/UpdateOutputExamplescloudianS3"
UpdateOutputExamplesscalityS3:
$ref: "#/components/examples/UpdateOutputExamplesscalityS3"
UpdateOutputExamplesalibabaCloudS3:
$ref: "#/components/examples/UpdateOutputExamplesalibabaCloudS3"
UpdateOutputExamplesibmCloudS3:
$ref: "#/components/examples/UpdateOutputExamplesibmCloudS3"
UpdateOutputExamplesAzureBlob:
$ref: "#/components/examples/UpdateOutputExamplesAzureBlob"
UpdateOutputExamplesAzureDataExplorer:
$ref: "#/components/examples/UpdateOutputExamplesAzureDataExplorer"
UpdateOutputExamplesSentinel:
$ref: "#/components/examples/UpdateOutputExamplesSentinel"
UpdateOutputExamplesAzureLogs:
$ref: "#/components/examples/UpdateOutputExamplesAzureLogs"
UpdateOutputExamplesKafka:
$ref: "#/components/examples/UpdateOutputExamplesKafka"
UpdateOutputExamplesConfluentCloud:
$ref: "#/components/examples/UpdateOutputExamplesConfluentCloud"
UpdateOutputExamplesMsk:
$ref: "#/components/examples/UpdateOutputExamplesMsk"
UpdateOutputExamplesKinesis:
$ref: "#/components/examples/UpdateOutputExamplesKinesis"
UpdateOutputExamplesElastic:
$ref: "#/components/examples/UpdateOutputExamplesElastic"
UpdateOutputExamplesElasticCloud:
$ref: "#/components/examples/UpdateOutputExamplesElasticCloud"
UpdateOutputExamplesMicrosoftFabric:
$ref: "#/components/examples/UpdateOutputExamplesMicrosoftFabric"
UpdateOutputExamplesCloudflareR2:
$ref: "#/components/examples/UpdateOutputExamplesCloudflareR2"
UpdateOutputExamplesHoneycomb:
$ref: "#/components/examples/UpdateOutputExamplesHoneycomb"
UpdateOutputExamplesNewrelic:
$ref: "#/components/examples/UpdateOutputExamplesNewrelic"
UpdateOutputExamplesNewrelicEvents:
$ref: "#/components/examples/UpdateOutputExamplesNewrelicEvents"
UpdateOutputExamplesSnmp:
$ref: "#/components/examples/UpdateOutputExamplesSnmp"
UpdateOutputExamplesInfluxdb:
$ref: "#/components/examples/UpdateOutputExamplesInfluxdb"
UpdateOutputExamplesMinio:
$ref: "#/components/examples/UpdateOutputExamplesMinio"
UpdateOutputExamplesCloudwatch:
$ref: "#/components/examples/UpdateOutputExamplesCloudwatch"
UpdateOutputExamplesAzureEventhub:
$ref: "#/components/examples/UpdateOutputExamplesAzureEventhub"
UpdateOutputExamplesStatsd:
$ref: "#/components/examples/UpdateOutputExamplesStatsd"
UpdateOutputExamplesStatsdExt:
$ref: "#/components/examples/UpdateOutputExamplesStatsdExt"
UpdateOutputExamplesGraphite:
$ref: "#/components/examples/UpdateOutputExamplesGraphite"
UpdateOutputExamplesWavefront:
$ref: "#/components/examples/UpdateOutputExamplesWavefront"
UpdateOutputExamplesSignalfx:
$ref: "#/components/examples/UpdateOutputExamplesSignalfx"
UpdateOutputExamplesSqs:
$ref: "#/components/examples/UpdateOutputExamplesSqs"
UpdateOutputExamplesGoogleCloudStorage:
$ref: "#/components/examples/UpdateOutputExamplesGoogleCloudStorage"
UpdateOutputExamplesSumoLogic:
$ref: "#/components/examples/UpdateOutputExamplesSumoLogic"
UpdateOutputExamplesDatadog:
$ref: "#/components/examples/UpdateOutputExamplesDatadog"
UpdateOutputExamplesWebhook:
$ref: "#/components/examples/UpdateOutputExamplesWebhook"
UpdateOutputExamplesPrometheus:
$ref: "#/components/examples/UpdateOutputExamplesPrometheus"
UpdateOutputExamplesAmazonManagedPrometheus:
$ref: "#/components/examples/UpdateOutputExamplesAmazonManagedPrometheus"
UpdateOutputExamplesGooglePubsub:
$ref: "#/components/examples/UpdateOutputExamplesGooglePubsub"
UpdateOutputExamplesGoogleBigQuery:
$ref: "#/components/examples/UpdateOutputExamplesGoogleBigQuery"
UpdateOutputExamplesGoogleChronicle:
$ref: "#/components/examples/UpdateOutputExamplesGoogleChronicle"
UpdateOutputExamplesChronicle:
$ref: "#/components/examples/UpdateOutputExamplesChronicle"
UpdateOutputExamplesGrafanaCloud:
$ref: "#/components/examples/UpdateOutputExamplesGrafanaCloud"
UpdateOutputExamplesLoki:
$ref: "#/components/examples/UpdateOutputExamplesLoki"
UpdateOutputExamplesOpenTelemetry:
$ref: "#/components/examples/UpdateOutputExamplesOpenTelemetry"
UpdateOutputExamplesServiceNow:
$ref: "#/components/examples/UpdateOutputExamplesServiceNow"
UpdateOutputExamplesDynatraceOtlp:
$ref: "#/components/examples/UpdateOutputExamplesDynatraceOtlp"
UpdateOutputExamplesGoogleCloudObservability:
$ref: "#/components/examples/UpdateOutputExamplesGoogleCloudObservability"
UpdateOutputExamplesSentinelOneAiSiem:
$ref: "#/components/examples/UpdateOutputExamplesSentinelOneAiSiem"
UpdateOutputExamplesDataset:
$ref: "#/components/examples/UpdateOutputExamplesDataset"
UpdateOutputExamplesRing:
$ref: "#/components/examples/UpdateOutputExamplesRing"
UpdateOutputExamplesRouter:
$ref: "#/components/examples/UpdateOutputExamplesRouter"
UpdateOutputExamplesWizHec:
$ref: "#/components/examples/UpdateOutputExamplesWizHec"
UpdateOutputExamplesHumioHec:
$ref: "#/components/examples/UpdateOutputExamplesHumioHec"
UpdateOutputExamplesCrowdstrikeNextGenSiem:
$ref: "#/components/examples/UpdateOutputExamplesCrowdstrikeNextGenSiem"
UpdateOutputExamplesCriblHttp:
$ref: "#/components/examples/UpdateOutputExamplesCriblHttp"
UpdateOutputExamplesCriblTcp:
$ref: "#/components/examples/UpdateOutputExamplesCriblTcp"
UpdateOutputExamplesCriblSearchEngine:
$ref: "#/components/examples/UpdateOutputExamplesCriblSearchEngine"
UpdateOutputExamplesGoogleCloudLogging:
$ref: "#/components/examples/UpdateOutputExamplesGoogleCloudLogging"
UpdateOutputExamplesSns:
$ref: "#/components/examples/UpdateOutputExamplesSns"
UpdateOutputExamplesDlS3:
$ref: "#/components/examples/UpdateOutputExamplesDlS3"
UpdateOutputExamplesSecurityLake:
$ref: "#/components/examples/UpdateOutputExamplesSecurityLake"
UpdateOutputExamplesCriblLake:
$ref: "#/components/examples/UpdateOutputExamplesCriblLake"
UpdateOutputExamplesExabeam:
$ref: "#/components/examples/UpdateOutputExamplesExabeam"
UpdateOutputExamplesDiskSpool:
$ref: "#/components/examples/UpdateOutputExamplesDiskSpool"
UpdateOutputExamplesClickHouse:
$ref: "#/components/examples/UpdateOutputExamplesClickHouse"
UpdateOutputExamplesLocalSearchStorage:
$ref: "#/components/examples/UpdateOutputExamplesLocalSearchStorage"
UpdateOutputExamplesCustomerMetricsStorage:
$ref: "#/components/examples/UpdateOutputExamplesCustomerMetricsStorage"
UpdateOutputExamplesXsiam:
$ref: "#/components/examples/UpdateOutputExamplesXsiam"
UpdateOutputExamplesNetflow:
$ref: "#/components/examples/UpdateOutputExamplesNetflow"
UpdateOutputExamplesDynatraceHttp:
$ref: "#/components/examples/UpdateOutputExamplesDynatraceHttp"
UpdateOutputExamplesDatabricks:
$ref: "#/components/examples/UpdateOutputExamplesDatabricks"
UpdateOutputExamplesSnowflakeStreaming:
$ref: "#/components/examples/UpdateOutputExamplesSnowflakeStreaming"
responses:
"200":
description: The updated Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist — Destination not found.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to update.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
delete:
operationId: deleteOutputSystemByPackAndId
x-speakeasy-group: packs.destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: delete
tags:
- destinations
summary: Delete a Destination within a Pack
description: Delete the specified Destination within the specified Pack.
responses:
"200":
description: The deleted Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist — Destination not found.
"409":
description: Request conflicts with current resource state — Destination is
referenced by another entity.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to delete.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/outputs/{id}/pq:
delete:
operationId: deleteOutputSystemPqByPackAndId
tags:
- destinations
x-speakeasy-group: packs.destinations.pq
x-speakeasy-name-override: clear
x-cribl-internal: false
x-cribl-availability: both
summary: Clear the persistent queue for a Destination within a Pack
description: Clear the persistent queue (PQ) for the specified Destination
within the specified Pack.
responses:
"201":
description: The job ID for the background job that clears the persistent queue.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedString"
examples:
OutputClearPQResponseExamplesClearPQJobId:
$ref: "#/components/examples/OutputClearPQResponseExamplesClearPQJobId"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to clear the PQ for.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
get:
operationId: getOutputSystemPqByPackAndId
tags:
- destinations
x-speakeasy-group: packs.destinations.pq
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get information about the latest job to clear the persistent queue for
a Destination within a Pack
description: Get information about the latest job to clear the persistent queue
(PQ) for the specified Destination within the specified Pack.
responses:
"200":
description: Information about the latest job to clear the PQ for the Destination.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedJobInfo"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to get PQ job information for.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/outputs/{id}/samples:
get:
operationId: getOutputSystemSamplesByPackAndId
tags:
- destinations
x-speakeasy-group: packs.destinations.samples
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get sample event data for a Destination within a Pack
description: Get sample event data for the specified Destination to validate the
configuration or test connectivity within the specified Pack.
responses:
"200":
description: Sample event data for the Destination.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputSamplesResponse"
examples:
OutputSamplesResponseExamplesSampleEvents:
$ref: "#/components/examples/OutputSamplesResponseExamplesSampleEvents"
"400":
description: Failed validation or malformed input — invalid request or
Destination error.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to get sample event data for.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/outputs/{id}/test:
post:
operationId: createOutputSystemTestByPackAndId
tags:
- destinations
x-speakeasy-group: packs.destinations.samples
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Send sample event data to a Destination within a Pack
description: Send sample event data to the specified Destination to validate the
configuration or test connectivity within the specified Pack.
responses:
"200":
description: Destination test result.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputTestResponse"
examples:
OutputTestResponseExamplesSuccessfulTest:
$ref: "#/components/examples/OutputTestResponseExamplesSuccessfulTest"
OutputTestResponseExamplesFailedTest:
$ref: "#/components/examples/OutputTestResponseExamplesFailedTest"
"400":
description: Failed validation or malformed input — missing or invalid events.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: OutputTestRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/OutputTestRequest"
examples:
OutputTestExamplesSingleEvent:
$ref: "#/components/examples/OutputTestExamplesSingleEvent"
OutputTestExamplesMultipleEvents:
$ref: "#/components/examples/OutputTestExamplesMultipleEvents"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to send sample event data to.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/status/inputs:
get:
operationId: getInputStatusSystemInputsByPack
tags:
- sources
x-speakeasy-group: packs.sources.statuses
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List the status of all Sources within a Pack
description: List status information and optional metrics for all configured
Sources in the Worker Group or Edge Fleet within the specified Pack.
responses:
"200":
description: List of Source status objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedInputStatus"
examples:
InputStatusResponseExamplesGreenSource:
$ref: "#/components/examples/InputStatusResponseExamplesGreenSource"
InputStatusResponseExamplesYellowSource:
$ref: "#/components/examples/InputStatusResponseExamplesYellowSource"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Source.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Source id with
the Source type. Otherwise, false (default).
- name: offset
in: query
required: false
schema:
type: integer
description: Starting point from which to retrieve results for this request. Use
with limit to paginate the response into manageable
batches.
- name: limit
in: query
required: false
schema:
type: integer
description: Maximum number of items to return in the response for this request.
Use with offset to paginate the response into
manageable batches.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/p/{pack}/system/status/inputs/{id}:
get:
operationId: getInputStatusSystemInputsByPackAndId
tags:
- sources
x-speakeasy-group: packs.sources.statuses
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the status of a Source within a Pack
description: Get the status and optional metrics for the specified Source within
the specified Pack.
responses:
"200":
description: The requested Source status object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputStatus"
examples:
InputStatusResponseExamplesGreenSource:
$ref: "#/components/examples/InputStatusResponseExamplesGreenSource"
InputStatusResponseExamplesYellowSource:
$ref: "#/components/examples/InputStatusResponseExamplesYellowSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to get the status for.
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Source.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Source id with
the Source type. Otherwise, false (default).
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/p/{pack}/system/status/outputs:
get:
operationId: getOutputStatusSystemOutputsByPack
tags:
- destinations
x-speakeasy-group: packs.destinations.statuses
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List the status of all Destinations within a Pack
description: List status information and optional metrics for all configured
Destinations in the Worker Group or Edge Fleet within the specified
Pack.
responses:
"200":
description: List of Destination status objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedOutputStatus"
examples:
OutputStatusResponseExamplesGreenDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesGreenDestination"
OutputStatusResponseExamplesYellowDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesYellowDestination"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Destination.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Destination id
with the Destination type. Otherwise, false (default).
- name: offset
in: query
required: false
schema:
type: integer
description: Starting point from which to retrieve results for this request. Use
with limit to paginate the response into manageable
batches.
- name: limit
in: query
required: false
schema:
type: integer
description: Maximum number of items to return in the response for this request.
Use with offset to paginate the response into
manageable batches.
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/p/{pack}/system/status/outputs/{id}:
get:
operationId: getOutputStatusSystemOutputsByPackAndId
tags:
- destinations
x-speakeasy-group: packs.destinations.statuses
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the status of a Destination within a Pack
description: Get the status and optional metrics for the specified Destination
within the specified Pack.
responses:
"200":
description: The requested Destination status object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputStatus"
examples:
OutputStatusResponseExamplesGreenDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesGreenDestination"
OutputStatusResponseExamplesYellowDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesYellowDestination"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to get the status for.
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Destination.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Destination id
with the Destination type. Otherwise, false (default).
- name: pack
in: path
required: true
schema:
type: string
description: The id of the Pack.
/packs:
post:
operationId: createPacks
tags:
- packs
x-speakeasy-group: packs
x-speakeasy-name-override: install
x-cribl-internal: false
x-cribl-availability: both
summary: Install a Pack
description: Install a Pack.
To install an uploaded Pack, provide the
source value from the PUT /packs response as
the source parameter in the request body.
To
install a Pack by importing from a URL, provide the direct URL location
of the .crbl file for the Pack as the source
parameter in the request body.
To install a Pack by importing
from a Git repository, provide git+<repo-url> as the
source parameter in the request body.
If you do
not include the source parameter in the request body, an
empty Pack is created.
responses:
"200":
description: The installed Pack object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPackInstallInfo"
examples:
PackInstallResponseExamplesInstalledFromURL:
$ref: "#/components/examples/PackInstallResponseExamplesInstalledFromURL"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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
x-cribl-internal: false
x-cribl-availability: both
summary: List all Packs
description: Get a list of all Packs.
responses:
"200":
description: List of Pack objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedPackInfo"
examples:
PackListResponseExamplesPackList:
$ref: "#/components/examples/PackListResponseExamplesPackList"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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 each specified
property in each Pack. Supported values: inputs,
outputs, collectors."
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
put:
operationId: updatePacks
tags:
- packs
x-speakeasy-group: packs
x-speakeasy-name-override: upload
x-cribl-internal: false
x-cribl-availability: both
summary: Upload a Pack file
description: Upload a Pack file. Returns the source ID needed to
install the Pack with POST /packs, which you must call
separately.
responses:
"200":
description: Pack file uploaded successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/UploadPackResponse"
examples:
PackUploadResponseExamplesUploadedPack:
$ref: "#/components/examples/PackUploadResponseExamplesUploadedPack"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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}:
get:
operationId: getPacksById
tags:
- packs
x-speakeasy-group: packs
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Pack
description: Get the specified Pack.
responses:
"200":
description: The requested Pack object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPackInfo"
examples:
PackGetResponseExamplesInstalledPack:
$ref: "#/components/examples/PackGetResponseExamplesInstalledPack"
PackGetResponseExamplesEmptyPack:
$ref: "#/components/examples/PackGetResponseExamplesEmptyPack"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pack to get. Use the id
field from the list response.
patch:
operationId: updatePacksById
tags:
- packs
x-speakeasy-group: packs
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Upgrade a Pack
description: Upgrade the specified Pack.
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 POST /packs to overwrite the
default versions in the Pack.
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.
responses:
"200":
description: The upgraded Pack object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPackInfo"
examples:
PackUpgradeResponseExamplesUpgraded:
$ref: "#/components/examples/PackUpgradeResponseExamplesUpgraded"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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 id of the Pack to upgrade. Use the id
field from the list response.
delete:
operationId: deletePacksById
tags:
- packs
x-speakeasy-group: packs
x-speakeasy-name-override: delete
x-cribl-internal: false
x-cribl-availability: both
summary: Uninstall a Pack
description: Uninstall the specified Pack.
responses:
"200":
description: The uninstalled Pack object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPackUninstallInfo"
examples:
PackDeleteResponseExamplesUninstalled:
$ref: "#/components/examples/PackDeleteResponseExamplesUninstalled"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pack to uninstall. Use the
id field from the list response.
/pipelines:
get:
operationId: getPipelines
tags:
- pipelines
x-speakeasy-group: pipelines
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Pipelines
description: Get a list of all Pipelines.
responses:
"200":
description: List of Pipeline objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createPipelines
tags:
- pipelines
x-speakeasy-group: pipelines
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Create a Pipeline
description: Create a new Pipeline.
responses:
"200":
description: The created Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: Pipeline object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Pipeline"
examples:
PipelineExamplesEmpty:
$ref: "#/components/examples/PipelineExamplesEmpty"
PipelineExamplesAggregations:
$ref: "#/components/examples/PipelineExamplesAggregations"
PipelineExamplesAggregateMetrics:
$ref: "#/components/examples/PipelineExamplesAggregateMetrics"
PipelineExamplesAutoTimestamp:
$ref: "#/components/examples/PipelineExamplesAutoTimestamp"
PipelineExamplesCEFSerializer:
$ref: "#/components/examples/PipelineExamplesCEFSerializer"
PipelineExamplesChain:
$ref: "#/components/examples/PipelineExamplesChain"
PipelineExamplesClone:
$ref: "#/components/examples/PipelineExamplesClone"
PipelineExamplesComment:
$ref: "#/components/examples/PipelineExamplesComment"
PipelineExamplesDNSLookup:
$ref: "#/components/examples/PipelineExamplesDNSLookup"
PipelineExamplesDrop:
$ref: "#/components/examples/PipelineExamplesDrop"
PipelineExamplesDropDimensions:
$ref: "#/components/examples/PipelineExamplesDropDimensions"
PipelineExamplesDynamicSampling:
$ref: "#/components/examples/PipelineExamplesDynamicSampling"
PipelineExamplesEval:
$ref: "#/components/examples/PipelineExamplesEval"
PipelineExamplesEventBreaker:
$ref: "#/components/examples/PipelineExamplesEventBreaker"
PipelineExamplesFlatten:
$ref: "#/components/examples/PipelineExamplesFlatten"
PipelineExamplesFoldKeys:
$ref: "#/components/examples/PipelineExamplesFoldKeys"
PipelineExamplesGeoIP:
$ref: "#/components/examples/PipelineExamplesGeoIP"
PipelineExamplesGrok:
$ref: "#/components/examples/PipelineExamplesGrok"
PipelineExamplesGuard:
$ref: "#/components/examples/PipelineExamplesGuard"
PipelineExamplesJSONUnroll:
$ref: "#/components/examples/PipelineExamplesJSONUnroll"
PipelineExamplesLookup:
$ref: "#/components/examples/PipelineExamplesLookup"
PipelineExamplesMask:
$ref: "#/components/examples/PipelineExamplesMask"
PipelineExamplesNumerify:
$ref: "#/components/examples/PipelineExamplesNumerify"
PipelineExamplesOTLPLogs:
$ref: "#/components/examples/PipelineExamplesOTLPLogs"
PipelineExamplesOTLPMetrics:
$ref: "#/components/examples/PipelineExamplesOTLPMetrics"
PipelineExamplesOTLPTraces:
$ref: "#/components/examples/PipelineExamplesOTLPTraces"
PipelineExamplesParser:
$ref: "#/components/examples/PipelineExamplesParser"
PipelineExamplesPublishMetrics:
$ref: "#/components/examples/PipelineExamplesPublishMetrics"
PipelineExamplesRedis:
$ref: "#/components/examples/PipelineExamplesRedis"
PipelineExamplesRegexExtract:
$ref: "#/components/examples/PipelineExamplesRegexExtract"
PipelineExamplesRegexFilter:
$ref: "#/components/examples/PipelineExamplesRegexFilter"
PipelineExamplesRename:
$ref: "#/components/examples/PipelineExamplesRename"
PipelineExamplesRollupMetrics:
$ref: "#/components/examples/PipelineExamplesRollupMetrics"
PipelineExamplesSampling:
$ref: "#/components/examples/PipelineExamplesSampling"
PipelineExamplesSerialize:
$ref: "#/components/examples/PipelineExamplesSerialize"
PipelineExamplesSNMPTrapSerialize:
$ref: "#/components/examples/PipelineExamplesSNMPTrapSerialize"
PipelineExamplesSuppress:
$ref: "#/components/examples/PipelineExamplesSuppress"
PipelineExamplesTee:
$ref: "#/components/examples/PipelineExamplesTee"
PipelineExamplesUnroll:
$ref: "#/components/examples/PipelineExamplesUnroll"
PipelineExamplesXMLUnroll:
$ref: "#/components/examples/PipelineExamplesXMLUnroll"
/pipelines/{id}:
delete:
operationId: deletePipelinesById
tags:
- pipelines
x-speakeasy-group: pipelines
x-speakeasy-name-override: delete
x-cribl-internal: false
x-cribl-availability: both
summary: Delete a Pipeline
description: Delete the specified Pipeline.
responses:
"200":
description: The deleted Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pipeline to delete.
get:
operationId: getPipelinesById
tags:
- pipelines
x-speakeasy-group: pipelines
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Pipeline
description: Get the specified Pipeline.
responses:
"200":
description: The requested Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pipeline to get.
patch:
operationId: updatePipelinesById
tags:
- pipelines
x-speakeasy-group: pipelines
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update a Pipeline
description: Update the specified Pipeline.
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.
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.
responses:
"200":
description: The updated Pipeline object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedPipeline"
examples:
PipelineResponseExamplesEmptyPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEmptyPipeline"
PipelineResponseExamplesEvalPipeline:
$ref: "#/components/examples/PipelineResponseExamplesEvalPipeline"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: Pipeline object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Pipeline"
examples:
UpdatePipelineExamplesEmpty:
$ref: "#/components/examples/UpdatePipelineExamplesEmpty"
UpdatePipelineExamplesAggregations:
$ref: "#/components/examples/UpdatePipelineExamplesAggregations"
UpdatePipelineExamplesAggregateMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesAggregateMetrics"
UpdatePipelineExamplesAutoTimestamp:
$ref: "#/components/examples/UpdatePipelineExamplesAutoTimestamp"
UpdatePipelineExamplesCEFSerializer:
$ref: "#/components/examples/UpdatePipelineExamplesCEFSerializer"
UpdatePipelineExamplesChain:
$ref: "#/components/examples/UpdatePipelineExamplesChain"
UpdatePipelineExamplesClone:
$ref: "#/components/examples/UpdatePipelineExamplesClone"
UpdatePipelineExamplesComment:
$ref: "#/components/examples/UpdatePipelineExamplesComment"
UpdatePipelineExamplesDNSLookup:
$ref: "#/components/examples/UpdatePipelineExamplesDNSLookup"
UpdatePipelineExamplesDrop:
$ref: "#/components/examples/UpdatePipelineExamplesDrop"
UpdatePipelineExamplesDropDimensions:
$ref: "#/components/examples/UpdatePipelineExamplesDropDimensions"
UpdatePipelineExamplesDynamicSampling:
$ref: "#/components/examples/UpdatePipelineExamplesDynamicSampling"
UpdatePipelineExamplesEval:
$ref: "#/components/examples/UpdatePipelineExamplesEval"
UpdatePipelineExamplesEventBreaker:
$ref: "#/components/examples/UpdatePipelineExamplesEventBreaker"
UpdatePipelineExamplesFlatten:
$ref: "#/components/examples/UpdatePipelineExamplesFlatten"
UpdatePipelineExamplesFoldKeys:
$ref: "#/components/examples/UpdatePipelineExamplesFoldKeys"
UpdatePipelineExamplesGeoIP:
$ref: "#/components/examples/UpdatePipelineExamplesGeoIP"
UpdatePipelineExamplesGrok:
$ref: "#/components/examples/UpdatePipelineExamplesGrok"
UpdatePipelineExamplesGuard:
$ref: "#/components/examples/UpdatePipelineExamplesGuard"
UpdatePipelineExamplesJSONUnroll:
$ref: "#/components/examples/UpdatePipelineExamplesJSONUnroll"
UpdatePipelineExamplesLookup:
$ref: "#/components/examples/UpdatePipelineExamplesLookup"
UpdatePipelineExamplesMask:
$ref: "#/components/examples/UpdatePipelineExamplesMask"
UpdatePipelineExamplesNumerify:
$ref: "#/components/examples/UpdatePipelineExamplesNumerify"
UpdatePipelineExamplesOTLPLogs:
$ref: "#/components/examples/UpdatePipelineExamplesOTLPLogs"
UpdatePipelineExamplesOTLPMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesOTLPMetrics"
UpdatePipelineExamplesOTLPTraces:
$ref: "#/components/examples/UpdatePipelineExamplesOTLPTraces"
UpdatePipelineExamplesParser:
$ref: "#/components/examples/UpdatePipelineExamplesParser"
UpdatePipelineExamplesPublishMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesPublishMetrics"
UpdatePipelineExamplesRedis:
$ref: "#/components/examples/UpdatePipelineExamplesRedis"
UpdatePipelineExamplesRegexExtract:
$ref: "#/components/examples/UpdatePipelineExamplesRegexExtract"
UpdatePipelineExamplesRegexFilter:
$ref: "#/components/examples/UpdatePipelineExamplesRegexFilter"
UpdatePipelineExamplesRename:
$ref: "#/components/examples/UpdatePipelineExamplesRename"
UpdatePipelineExamplesRollupMetrics:
$ref: "#/components/examples/UpdatePipelineExamplesRollupMetrics"
UpdatePipelineExamplesSampling:
$ref: "#/components/examples/UpdatePipelineExamplesSampling"
UpdatePipelineExamplesSerialize:
$ref: "#/components/examples/UpdatePipelineExamplesSerialize"
UpdatePipelineExamplesSNMPTrapSerialize:
$ref: "#/components/examples/UpdatePipelineExamplesSNMPTrapSerialize"
UpdatePipelineExamplesSuppress:
$ref: "#/components/examples/UpdatePipelineExamplesSuppress"
UpdatePipelineExamplesTee:
$ref: "#/components/examples/UpdatePipelineExamplesTee"
UpdatePipelineExamplesUnroll:
$ref: "#/components/examples/UpdatePipelineExamplesUnroll"
UpdatePipelineExamplesXMLUnroll:
$ref: "#/components/examples/UpdatePipelineExamplesXMLUnroll"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Pipeline to update.
/products/{product}/groups:
get:
operationId: getProductsGroupsByProduct
tags:
- groups
x-speakeasy-group: groups
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Worker Groups, Outpost Groups, or Edge Fleets
description: Get a list of all Worker Groups, Outpost Groups, or Edge Fleets for
the specified Cribl product.
responses:
"200":
description: List of ConfigGroup objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedConfigGroup"
examples:
GroupListResponseExamplesWorkerGroups:
$ref: "#/components/examples/GroupListResponseExamplesWorkerGroups"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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, Outpost Groups,
or Edge Fleets for.
- name: fields
in: query
required: false
schema:
type: string
description: Comma-separated list of additional properties to include in the
response. Available values are git.commit,
git.localChanges, and git.log.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createProductsGroupsByProduct
tags:
- groups
x-speakeasy-group: groups
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Create a Worker Group, Outpost Group, or Edge Fleet
description: Create a new Worker Group, Outpost Group, or Edge Fleet for the
specified Cribl product.
responses:
"200":
description: The created ConfigGroup object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedConfigGroup"
examples:
GroupCreateResponseExamplesWorkerGroup:
$ref: "#/components/examples/GroupCreateResponseExamplesWorkerGroup"
"400":
description: Failed validation or malformed input — Invalid group payload or
invalid cloud/on-prem configuration.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"409":
description: Request conflicts with current resource state — duplicate group ID
or duplicate group name.
"500":
description: Unexpected server 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"
parameters:
- name: product
in: path
required: true
schema:
$ref: "#/components/schemas/ProductsCore"
description: Name of the Cribl product to add the Worker Group, Outpost Group,
or Edge Fleet to.
/products/{product}/groups/{id}:
get:
operationId: getProductsGroupsByProductAndId
tags:
- groups
x-speakeasy-group: groups
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Worker Group, Outpost Group, or Edge Fleet
description: Get the specified Worker Group, Outpost Group, or Edge Fleet.
responses:
"200":
description: The requested ConfigGroup object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedConfigGroup"
examples:
GroupGetResponseExamplesWorkerGroup:
$ref: "#/components/examples/GroupGetResponseExamplesWorkerGroup"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Worker Group, Outpost Group, or Edge Fleet not found.
"500":
description: Unexpected server 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, Outpost Groups,
or Edge Fleets for.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Worker Group, Outpost 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 git.commit,
git.localChanges, and git.log.
patch:
operationId: updateProductsGroupsByProductAndId
tags:
- groups
x-speakeasy-group: groups
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update a Worker Group, Outpost Group, or Edge Fleet
description: "Update the specified Worker Group, Outpost Group, or Edge
Fleet.
Provide a complete representation of the Group or Fleet
that you want to update in the request body. This endpoint does not
support partial updates. Cribl removes any omitted fields when updating
the Group or Fleet.
Confirm that the configuration in your
request body is correct before sending the request. If the configuration
is incorrect, the updated Group or Fleet might not function as
expected.
**Warning**: Do not change the values for the
following parameters in the body of PATCH requests. The request body
must include the values as they appear in the GET
/products/{product}/groups/{id} response.
-
configVersion
- deployingWorkerCount
- incompatibleWorkerCount
-
workerCount
- lookupDeployments."
responses:
"200":
description: The updated ConfigGroup object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedConfigGroup"
examples:
GroupUpdateResponseExamplesWorkerGroup:
$ref: "#/components/examples/GroupUpdateResponseExamplesWorkerGroup"
"400":
description: Failed validation or malformed input — Invalid update payload,
including read-only field mutations or invalid cloud/on-prem
configuration.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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"
UpdateGroupExamplesUpdateOnPremWorkerGroup:
$ref: "#/components/examples/UpdateGroupExamplesUpdateOnPremWorkerGroup"
parameters:
- name: product
in: path
required: true
schema:
$ref: "#/components/schemas/ProductsCore"
description: Name of the Cribl product to get the Worker Groups, Outpost Groups,
or Edge Fleets for.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Worker Group, Outpost Group, or Edge
Fleet to update.
delete:
operationId: deleteProductsGroupsByProductAndId
tags:
- groups
x-speakeasy-group: groups
x-speakeasy-name-override: delete
x-cribl-internal: false
x-cribl-availability: both
summary: Delete a Worker Group, Outpost Group, or Edge Fleet
description: Delete the specified Worker Group, Outpost Group, or Edge Fleet.
responses:
"200":
description: The deleted ConfigGroup object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedConfigGroup"
examples:
GroupDeleteResponseExamplesWorkerGroup:
$ref: "#/components/examples/GroupDeleteResponseExamplesWorkerGroup"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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, Outpost Groups,
or Edge Fleets for.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Worker Group, Outpost Group, or Edge
Fleet to delete.
/products/{product}/groups/{id}/acl:
get:
operationId: getProductsGroupsAclByProductAndId
tags:
- groups
x-speakeasy-group: groups.acl
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the Access Control List for a Worker Group, Outpost Group, or Edge
Fleet
description: Get the Access Control List (ACL) for the specified Worker Group,
Outpost Group, or Edge Fleet.
responses:
"200":
description: The requested UserAccessControlList object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedUserAccessControlList"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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 id of the Worker Group, Outpost 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/{id}/acl/teams:
get:
operationId: getProductsGroupsAclTeamsByProductAndId
tags:
- teams
x-speakeasy-group: groups.acl.teams
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the Access Control List for teams with permissions on a Worker
Group, Outpost 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, Outpost Group, or Edge Fleet for the specified Cribl
product.
responses:
"200":
description: The requested TeamAccessControlList object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedTeamAccessControlList"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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, Outpost
Group, or Edge Fleet.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Worker Group, Outpost 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}/configVersion:
get:
operationId: getProductsGroupsConfigVersionByProductAndId
tags:
- groups
x-speakeasy-group: groups.configs.versions
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the configuration version for a Worker Group, Outpost Group, or
Edge Fleet
description: Get the configuration version for the specified Worker Group,
Outpost Group, or Edge Fleet.
responses:
"200":
description: The requested string object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedString"
examples:
GroupConfigVersionResponseExamplesConfigVersion:
$ref: "#/components/examples/GroupConfigVersionResponseExamplesConfigVersion"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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, Outpost Groups,
or Edge Fleets for.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Worker Group, Outpost Group, or Edge
Fleet to get the configuration version for.
/products/{product}/groups/{id}/deploy:
patch:
operationId: updateProductsGroupsDeployByProductAndId
tags:
- groups
x-speakeasy-group: groups
x-speakeasy-name-override: deploy
x-cribl-internal: false
x-cribl-availability: both
summary: Deploy commits to a Worker Group, Outpost Group, or Edge Fleet
description: Deploy commits to the specified Worker Group, Outpost Group, or
Edge Fleet.
responses:
"200":
description: The updated ConfigGroup object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedConfigGroup"
examples:
GroupDeployResponseExamplesWorkerGroup:
$ref: "#/components/examples/GroupDeployResponseExamplesWorkerGroup"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: DeployRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeployRequest"
examples:
DeployGroupExamplesDeployWorkerGroup:
$ref: "#/components/examples/DeployGroupExamplesDeployWorkerGroup"
parameters:
- name: product
in: path
required: true
schema:
$ref: "#/components/schemas/ProductsCore"
description: Name of the Cribl product that contains the Worker Group, Outpost
Group, or Edge Fleet.
- name: id
in: path
required: true
schema:
type: string
description: The id of the target Worker Group, Outpost Group, or
Edge Fleet for commit deployment.
/products/{product}/summary:
get:
operationId: getProductsSummaryByProduct
tags:
- distributed
x-speakeasy-group: nodes.summaries
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a summary of the deployment for a Cribl product
description: Get a summary of the deployment for the specified Cribl product
(Stream or Edge).
The summary includes a count of Worker Groups
or Edge Fleets and resources such as Pipelines, Routes, Sources, and
Destinations. For Distributed deployments, the summary also includes a
count and statistics for Worker or Edge Nodes.
responses:
"200":
description: List of DistributedSummary objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedDistributedSummary"
examples:
ProductSummaryResponseExamplesStreamDeploymentSummary:
$ref: "#/components/examples/ProductSummaryResponseExamplesStreamDeploymentSumm\
ary"
"400":
description: Failed validation or malformed input if the product is not "stream"
or "edge"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"403":
description: Not authorized or licensed to perform this action.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: product
in: path
required: true
schema:
$ref: "#/components/schemas/ProductsBase"
description: Name of the Cribl product to get the summary for.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/products/{product}/summary/workers:
get:
operationId: getProductsSummaryWorkersByProduct
tags:
- workers
x-speakeasy-group: nodes
x-speakeasy-name-override: count
x-cribl-internal: false
x-cribl-availability: both
summary: Get a count of Worker, Edge, or Outpost Nodes
description: Get a count of all Worker, Edge, or Outpost Nodes for the specified
Cribl product.
responses:
"200":
description: The requested number object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedNumber"
examples:
ProductWorkersCountResponseExamplesCountedWorkerNodes:
$ref: "#/components/examples/ProductWorkersCountResponseExamplesCountedWorkerNo\
des"
"400":
description: Failed validation or malformed input if the product is not
"stream", "edge", or "outpost"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"403":
description: Not authorized or licensed to perform this action.
"500":
description: Unexpected server 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 count of Worker, Edge, or
Outpost Nodes for.
- name: filterExp
in: query
required: false
schema:
$ref: "#/components/schemas/WorkerFilterExpression"
description: Filter expression to evaluate against Nodes for inclusion in the
response.
/products/{product}/workers:
get:
operationId: getProductsWorkersByProduct
tags:
- workers
x-speakeasy-group: nodes
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: Get detailed metadata for Worker, Edge, or Outpost Nodes
description: Get detailed metadata for Worker, Edge, or Outpost Nodes for the
specified Cribl product.
responses:
"200":
description: List of MasterWorkerEntry objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedMasterWorkerEntry"
examples:
WorkersListResponseExamplesWorkerNode:
$ref: "#/components/examples/WorkersListResponseExamplesWorkerNode"
"400":
description: Failed validation or malformed input if the product is not
"stream", "edge", or "outpost"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"403":
description: Not authorized or licensed to perform this action.
"500":
description: Unexpected server 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 Worker, Edge, or Outpost Nodes for.
- name: filterExp
in: query
required: false
schema:
$ref: "#/components/schemas/WorkerFilterExpression"
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:
$ref: "#/components/schemas/WorkerFilterJson"
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 offset 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 limit to paginate the response into manageable
batches.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/products/{product}/workers/{id}:
get:
operationId: getProductsWorkersByProductAndId
tags:
- workers
x-speakeasy-group: nodes
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get detailed metadata for a Worker, Edge, or Outpost Node
description: Get detailed metadata for the specified Worker, Edge, or Outpost
Node for the specified Cribl product.
responses:
"200":
description: The requested MasterWorkerEntry object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedMasterWorkerEntry"
examples:
GetProductWorkerByIdResponseExamplesOneWorker:
$ref: "#/components/examples/GetProductWorkerByIdResponseExamplesOneWorker"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"403":
description: Not authorized or licensed to perform this action.
"500":
description: Unexpected server 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 Node.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Node to get the metadata for.
/products/{product}/workers/restart:
patch:
operationId: updateProductsWorkersRestartByProduct
tags:
- workers
x-speakeasy-group: nodes
x-speakeasy-name-override: restart
x-cribl-internal: false
x-cribl-availability: both
summary: Restart Worker, Edge, or Outpost Nodes
description: Restart all Worker, Edge, or Outpost Nodes for the specified Cribl
product.
responses:
"200":
description: The updated RestartResponse object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRestartResponse"
examples:
RestartProductWorkersResponseExamplesRestartingWorkers:
$ref: "#/components/examples/RestartProductWorkersResponseExamplesRestartingWor\
kers"
RestartProductWorkersResponseExamplesRestartingWorkersWithError:
$ref: "#/components/examples/RestartProductWorkersResponseExamplesRestartingWor\
kersWithError"
"400":
description: Failed validation or malformed input if the product is not
"stream", "edge", or "outpost"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"403":
description: Not authorized or licensed to perform this action.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: RestartRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RestartRequest"
examples:
RestartWorkersExamplesRestartWorkers:
$ref: "#/components/examples/RestartWorkersExamplesRestartWorkers"
parameters:
- name: product
in: path
required: true
schema:
$ref: "#/components/schemas/ProductsCore"
description: Name of the Cribl product whose Worker, Edge, or Outpost Nodes you
want to restart.
/products/lake/lakes/{lakeId}/datasets:
get:
operationId: getCriblLakeDatasetByLakeId
tags:
- lake
x-speakeasy-group: lakes.datasets
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: cloud
summary: List all Lake Datasets (Cribl.Cloud only)
description: Get a list of all Lake Datasets in the specified Lake (Cribl.Cloud only).
responses:
"200":
description: List of CriblLakeDataset objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedCriblLakeDataset"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: lakeId
in: path
required: true
schema:
type: string
description: The id 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 default
for default storage location.
- name: format
in: query
required: false
schema:
type: string
enum:
- ddss
x-speakeasy-unknown-values: allow
description: Filter datasets by format. Set to ddss to return only
DDSS datasets.
- name: excludeDDSS
in: query
required: false
schema:
type: boolean
description: Exclude DDSS format datasets from the response.
- name: excludeNetskope
in: query
required: false
schema:
type: boolean
description: Exclude Netskope 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
cribl_) from the response.
- name: excludeBYOS
in: query
required: false
schema:
type: boolean
description: Exclude BYOS (Bring Your Own Storage) datasets from the response.
- name: includeMetrics
in: query
required: false
schema:
type: boolean
description: Set to true to include storage metrics for each Lake
Dataset. Otherwise, false (default). Requires a Cribl
Lake metrics license.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createCriblLakeDatasetByLakeId
tags:
- lake
x-speakeasy-group: lakes.datasets
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: cloud
summary: Create a Lake Dataset (Cribl.Cloud only)
description: Create a new Lake Dataset in the specified Lake (Cribl.Cloud only).
responses:
"200":
description: The created CriblLakeDataset object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedCriblLakeDataset"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: CriblLakeDataset object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CriblLakeDataset"
examples:
LakeDatasetCreateExamplesJsonDataset:
$ref: "#/components/examples/LakeDatasetCreateExamplesJsonDataset"
LakeDatasetCreateExamplesParquetDataset:
$ref: "#/components/examples/LakeDatasetCreateExamplesParquetDataset"
LakeDatasetCreateExamplesMinimalDataset:
$ref: "#/components/examples/LakeDatasetCreateExamplesMinimalDataset"
parameters:
- name: lakeId
in: path
required: true
schema:
type: string
description: The id of the Lake to create the Lake Dataset in.
/products/lake/lakes/{lakeId}/datasets/{id}:
get:
operationId: getCriblLakeDatasetByLakeIdAndId
tags:
- lake
x-speakeasy-group: lakes.datasets
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: cloud
summary: Get a Lake Dataset (Cribl.Cloud only)
description: Get the specified Lake Dataset in the specified Lake (Cribl.Cloud only).
responses:
"200":
description: The requested CriblLakeDataset object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedCriblLakeDataset"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: lakeId
in: path
required: true
schema:
type: string
description: The id of the Lake that contains the Lake Dataset to
get.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Lake Dataset to get.
- name: includeMetrics
in: query
required: false
schema:
type: boolean
description: Set to true to include storage metrics for each Lake
Dataset. Otherwise, false (default). Requires a Cribl
Lake metrics license.
patch:
operationId: updateCriblLakeDatasetByLakeIdAndId
tags:
- lake
x-speakeasy-group: lakes.datasets
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: cloud
summary: Update a Lake Dataset (Cribl.Cloud only)
description: Update the specified Lake Dataset in the specified Lake
(Cribl.Cloud only).
responses:
"200":
description: The updated CriblLakeDataset object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedCriblLakeDataset"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: CriblLakeDatasetUpdate object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CriblLakeDatasetUpdate"
examples:
LakeDatasetUpdateExamplesUpdateRetention:
$ref: "#/components/examples/LakeDatasetUpdateExamplesUpdateRetention"
LakeDatasetUpdateExamplesUpdateDescription:
$ref: "#/components/examples/LakeDatasetUpdateExamplesUpdateDescription"
parameters:
- name: lakeId
in: path
required: true
schema:
type: string
description: The id of the Lake that contains the Lake Dataset to
update.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Lake Dataset to update.
delete:
operationId: deleteCriblLakeDatasetByLakeIdAndId
tags:
- lake
x-speakeasy-group: lakes.datasets
x-speakeasy-name-override: delete
x-cribl-internal: false
x-cribl-availability: cloud
summary: Delete a Lake Dataset (Cribl.Cloud only)
description: Delete the specified Lake Dataset in the specified Lake
(Cribl.Cloud only).
responses:
"200":
description: The deleted CriblLakeDataset object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedCriblLakeDataset"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: lakeId
in: path
required: true
schema:
type: string
description: The id of the Lake that contains the Lake Dataset to
delete.
- name: id
in: path
required: true
schema:
type: string
description: The id of the Lake Dataset to delete.
/routes:
get:
operationId: getRoutes
tags:
- routes
x-speakeasy-group: routes
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List all Routes
description: Get a list of all Routes.
responses:
"200":
description: List of Routing table objects.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/routes/{id}:
get:
operationId: getRoutesById
tags:
- routes
x-speakeasy-group: routes
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get a Routing table
description: Get the specified Routing table.
responses:
"200":
description: The requested Routing table object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Routing table not found. The specified id does not
match any stored Routing table.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Routing table to get. The supported
value is default.
patch:
operationId: updateRoutesById
tags:
- routes
x-speakeasy-group: routes
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update a Routing table
description: Update the specified Routing table.
Provide a complete
representation of the Routing table that you want to update in the
request body.
This endpoint does not support partial updates.
Cribl removes any omitted fields when updating the Routing
table.
Confirm that the configuration in your request body is
correct before sending the request. If the configuration is incorrect,
the updated Routing table might not function as expected.
Cribl
also removes any omitted Routes when updating the Routing table.
responses:
"200":
description: The updated Routing table object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Routing table not found. The specified id does not
match any stored Routing table.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: RoutesInput object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RoutesInput"
examples:
RoutesUpdateExamplesBasicRoute:
$ref: "#/components/examples/RoutesUpdateExamplesBasicRoute"
RoutesUpdateExamplesMultipleRoutes:
$ref: "#/components/examples/RoutesUpdateExamplesMultipleRoutes"
RoutesUpdateExamplesRouteWithOutputExpression:
$ref: "#/components/examples/RoutesUpdateExamplesRouteWithOutputExpression"
RoutesUpdateExamplesRouteWithDefaults:
$ref: "#/components/examples/RoutesUpdateExamplesRouteWithDefaults"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Routing table to update. The supported
value is default.
/routes/{id}/append:
post:
operationId: createRoutesAppendById
tags:
- routes
x-speakeasy-group: routes
x-speakeasy-name-override: append
x-cribl-internal: false
x-cribl-availability: both
summary: Add a Route to the end of the Routing table
description: Add a Route to the end of the specified Routing table.
responses:
"200":
description: The updated Routing table object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedRoutes"
examples:
RoutesResponseExamplesDefaultRoutingTable:
$ref: "#/components/examples/RoutesResponseExamplesDefaultRoutingTable"
RoutesResponseExamplesMultiRouteTable:
$ref: "#/components/examples/RoutesResponseExamplesMultiRouteTable"
"400":
description: Failed validation or malformed input. The request body must be an
array of Route configurations.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: Routing table not found. The specified id does not
match any stored Routing table.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: RouteDefinitions object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RouteDefinitions"
examples:
RoutesAppendExamplesSingleRoute:
$ref: "#/components/examples/RoutesAppendExamplesSingleRoute"
RoutesAppendExamplesMultipleRoutes:
$ref: "#/components/examples/RoutesAppendExamplesMultipleRoutes"
RoutesAppendExamplesRouteWithOutputExpression:
$ref: "#/components/examples/RoutesAppendExamplesRouteWithOutputExpression"
RoutesAppendExamplesRouteWithDefaults:
$ref: "#/components/examples/RoutesAppendExamplesRouteWithDefaults"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Routing table to add the Route to. The
supported value is default.
/system/capture:
post:
operationId: createSystemCapture
tags:
- preview
x-speakeasy-group: system.captures
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
summary: Capture live data
description: Initiate a live data capture from Cribl Workers. Returns a stream
of captured events in NDJSON format that match the parameters specified
in the request body.
responses:
"200":
description: Stream of captured events.
content:
application/x-ndjson:
schema:
$ref: "#/components/schemas/CapturedEvent"
"400":
description: Failed validation or malformed input — No worker nodes are
connected to this worker group.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: CaptureParamsReq object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CaptureParamsReq"
examples:
CaptureExamplesSimpleExpression:
$ref: "#/components/examples/CaptureExamplesSimpleExpression"
CaptureExamplesCompoundAndExpression:
$ref: "#/components/examples/CaptureExamplesCompoundAndExpression"
CaptureExamplesNestedFieldAccess:
$ref: "#/components/examples/CaptureExamplesNestedFieldAccess"
CaptureExamplesComplexFilter:
$ref: "#/components/examples/CaptureExamplesComplexFilter"
/system/inputs:
get:
operationId: listInput
x-speakeasy-group: sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: list
tags:
- sources
summary: List all Sources
description: Get a list of all Sources.
responses:
"200":
description: List of Source objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: type
in: query
required: false
schema:
$ref: "#/components/schemas/SourceType"
description: Type of Source to include in the results. Each request can include
only one type parameter; multiple parameters per
request are not supported.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createInput
x-speakeasy-group: sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: create
tags:
- sources
summary: Create a Source
description: Create a new Source. The system-managed provenance field (JSON
criblSourceProvenance) must be omitted from the request
body.
requestBody:
description: Input object.
required: true
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/Input"
- type: object
required:
- id
examples:
InputCreateExamplesAnthropicCompliance:
$ref: "#/components/examples/InputCreateExamplesAnthropicCompliance"
InputCreateExamplesAppleUnifiedLogs:
$ref: "#/components/examples/InputCreateExamplesAppleUnifiedLogs"
InputCreateExamplesAppscope:
$ref: "#/components/examples/InputCreateExamplesAppscope"
InputCreateExamplesAzureBlob:
$ref: "#/components/examples/InputCreateExamplesAzureBlob"
InputCreateExamplesCloudflareHec:
$ref: "#/components/examples/InputCreateExamplesCloudflareHec"
InputCreateExamplesConfluentCloud:
$ref: "#/components/examples/InputCreateExamplesConfluentCloud"
InputCreateExamplesCollection:
$ref: "#/components/examples/InputCreateExamplesCollection"
InputCreateExamplesCriblHttp:
$ref: "#/components/examples/InputCreateExamplesCriblHttp"
InputCreateExamplesCriblLakeHttp:
$ref: "#/components/examples/InputCreateExamplesCriblLakeHttp"
InputCreateExamplesCriblTcp:
$ref: "#/components/examples/InputCreateExamplesCriblTcp"
InputCreateExamplesCrowdstrike:
$ref: "#/components/examples/InputCreateExamplesCrowdstrike"
InputCreateExamplesDatadogAgent:
$ref: "#/components/examples/InputCreateExamplesDatadogAgent"
InputCreateExamplesDatagen:
$ref: "#/components/examples/InputCreateExamplesDatagen"
InputCreateExamplesEdgePrometheus:
$ref: "#/components/examples/InputCreateExamplesEdgePrometheus"
InputCreateExamplesElastic:
$ref: "#/components/examples/InputCreateExamplesElastic"
InputCreateExamplesEventhub:
$ref: "#/components/examples/InputCreateExamplesEventhub"
InputCreateExamplesEventhubAmqp:
$ref: "#/components/examples/InputCreateExamplesEventhubAmqp"
InputCreateExamplesExec:
$ref: "#/components/examples/InputCreateExamplesExec"
InputCreateExamplesFile:
$ref: "#/components/examples/InputCreateExamplesFile"
InputCreateExamplesFirehose:
$ref: "#/components/examples/InputCreateExamplesFirehose"
InputCreateExamplesGrafana:
$ref: "#/components/examples/InputCreateExamplesGrafana"
InputCreateExamplesGooglePubsub:
$ref: "#/components/examples/InputCreateExamplesGooglePubsub"
InputCreateExamplesHttp:
$ref: "#/components/examples/InputCreateExamplesHttp"
InputCreateExamplesHttpRaw:
$ref: "#/components/examples/InputCreateExamplesHttpRaw"
InputCreateExamplesJournalFiles:
$ref: "#/components/examples/InputCreateExamplesJournalFiles"
InputCreateExamplesKafka:
$ref: "#/components/examples/InputCreateExamplesKafka"
InputCreateExamplesKinesis:
$ref: "#/components/examples/InputCreateExamplesKinesis"
InputCreateExamplesKubeEvents:
$ref: "#/components/examples/InputCreateExamplesKubeEvents"
InputCreateExamplesKubeLogs:
$ref: "#/components/examples/InputCreateExamplesKubeLogs"
InputCreateExamplesKubeMetrics:
$ref: "#/components/examples/InputCreateExamplesKubeMetrics"
InputCreateExamplesLoki:
$ref: "#/components/examples/InputCreateExamplesLoki"
InputCreateExamplesMetrics:
$ref: "#/components/examples/InputCreateExamplesMetrics"
InputCreateExamplesModelDrivenTelemetry:
$ref: "#/components/examples/InputCreateExamplesModelDrivenTelemetry"
InputCreateExamplesMsk:
$ref: "#/components/examples/InputCreateExamplesMsk"
InputCreateExamplesNetflow:
$ref: "#/components/examples/InputCreateExamplesNetflow"
InputCreateExamplesOffice365Mgmt:
$ref: "#/components/examples/InputCreateExamplesOffice365Mgmt"
InputCreateExamplesMicrosoftGraph:
$ref: "#/components/examples/InputCreateExamplesMicrosoftGraph"
InputCreateExamplesOffice365MsgTrace:
$ref: "#/components/examples/InputCreateExamplesOffice365MsgTrace"
InputCreateExamplesOffice365Service:
$ref: "#/components/examples/InputCreateExamplesOffice365Service"
InputCreateExamplesOkta:
$ref: "#/components/examples/InputCreateExamplesOkta"
InputCreateExamplesOpenAI:
$ref: "#/components/examples/InputCreateExamplesOpenAI"
InputCreateExamplesOpenAIComplianceLogs:
$ref: "#/components/examples/InputCreateExamplesOpenAIComplianceLogs"
InputCreateExamplesOpenTelemetry:
$ref: "#/components/examples/InputCreateExamplesOpenTelemetry"
InputCreateExamplesPrometheus:
$ref: "#/components/examples/InputCreateExamplesPrometheus"
InputCreateExamplesPrometheusRw:
$ref: "#/components/examples/InputCreateExamplesPrometheusRw"
InputCreateExamplesRawUdp:
$ref: "#/components/examples/InputCreateExamplesRawUdp"
InputCreateExamplesBedrockS3:
$ref: "#/components/examples/InputCreateExamplesBedrockS3"
InputCreateExamplesS3:
$ref: "#/components/examples/InputCreateExamplesS3"
InputCreateExamplesS3Inventory:
$ref: "#/components/examples/InputCreateExamplesS3Inventory"
InputCreateExamplesSecurityLake:
$ref: "#/components/examples/InputCreateExamplesSecurityLake"
InputCreateExamplesServiceNowTable:
$ref: "#/components/examples/InputCreateExamplesServiceNowTable"
InputCreateExamplesSnmp:
$ref: "#/components/examples/InputCreateExamplesSnmp"
InputCreateExamplesSplunk:
$ref: "#/components/examples/InputCreateExamplesSplunk"
InputCreateExamplesSplunkHec:
$ref: "#/components/examples/InputCreateExamplesSplunkHec"
InputCreateExamplesSplunkSearch:
$ref: "#/components/examples/InputCreateExamplesSplunkSearch"
InputCreateExamplesSqs:
$ref: "#/components/examples/InputCreateExamplesSqs"
InputCreateExamplesSysdigHec:
$ref: "#/components/examples/InputCreateExamplesSysdigHec"
InputCreateExamplesSyslog:
$ref: "#/components/examples/InputCreateExamplesSyslog"
InputCreateExamplesSyslogWithPQ:
$ref: "#/components/examples/InputCreateExamplesSyslogWithPQ"
InputCreateExamplesSystemMetrics:
$ref: "#/components/examples/InputCreateExamplesSystemMetrics"
InputCreateExamplesSystemState:
$ref: "#/components/examples/InputCreateExamplesSystemState"
InputCreateExamplesTcp:
$ref: "#/components/examples/InputCreateExamplesTcp"
InputCreateExamplesTcpjson:
$ref: "#/components/examples/InputCreateExamplesTcpjson"
InputCreateExamplesUpwindHec:
$ref: "#/components/examples/InputCreateExamplesUpwindHec"
InputCreateExamplesWef:
$ref: "#/components/examples/InputCreateExamplesWef"
InputCreateExamplesWinEventLogs:
$ref: "#/components/examples/InputCreateExamplesWinEventLogs"
InputCreateExamplesWindowsMetrics:
$ref: "#/components/examples/InputCreateExamplesWindowsMetrics"
InputCreateExamplesWiz:
$ref: "#/components/examples/InputCreateExamplesWiz"
InputCreateExamplesWizWebhook:
$ref: "#/components/examples/InputCreateExamplesWizWebhook"
InputCreateExamplesZscalerHec:
$ref: "#/components/examples/InputCreateExamplesZscalerHec"
responses:
"200":
description: The created Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"409":
description: Request conflicts with current resource state — source with the
same ID already exists.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/system/inputs/{id}:
get:
operationId: getInputById
x-speakeasy-group: sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: get
tags:
- sources
summary: Get a Source
description: Get the specified Source.
responses:
"200":
description: The requested Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist — Source not found.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to get.
patch:
operationId: updateInputById
x-speakeasy-group: sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: update
tags:
- sources
summary: Update a Source
description: Update the specified Source.
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.
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.
Cribl preserves
criblSourceProvenance when you omit it from the request
body, and you cannot overwrite it through this endpoint.
requestBody:
description: Input object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Input"
examples:
UpdateInputExamplesAnthropicCompliance:
$ref: "#/components/examples/UpdateInputExamplesAnthropicCompliance"
UpdateInputExamplesAppleUnifiedLogs:
$ref: "#/components/examples/UpdateInputExamplesAppleUnifiedLogs"
UpdateInputExamplesAppscope:
$ref: "#/components/examples/UpdateInputExamplesAppscope"
UpdateInputExamplesAzureBlob:
$ref: "#/components/examples/UpdateInputExamplesAzureBlob"
UpdateInputExamplesCloudflareHec:
$ref: "#/components/examples/UpdateInputExamplesCloudflareHec"
UpdateInputExamplesConfluentCloud:
$ref: "#/components/examples/UpdateInputExamplesConfluentCloud"
UpdateInputExamplesCollection:
$ref: "#/components/examples/UpdateInputExamplesCollection"
UpdateInputExamplesCribl:
$ref: "#/components/examples/UpdateInputExamplesCribl"
UpdateInputExamplesCriblHttp:
$ref: "#/components/examples/UpdateInputExamplesCriblHttp"
UpdateInputExamplesCriblLakeHttp:
$ref: "#/components/examples/UpdateInputExamplesCriblLakeHttp"
UpdateInputExamplesCriblMetrics:
$ref: "#/components/examples/UpdateInputExamplesCriblMetrics"
UpdateInputExamplesCriblTcp:
$ref: "#/components/examples/UpdateInputExamplesCriblTcp"
UpdateInputExamplesCrowdstrike:
$ref: "#/components/examples/UpdateInputExamplesCrowdstrike"
UpdateInputExamplesDatadogAgent:
$ref: "#/components/examples/UpdateInputExamplesDatadogAgent"
UpdateInputExamplesDatagen:
$ref: "#/components/examples/UpdateInputExamplesDatagen"
UpdateInputExamplesEdgePrometheus:
$ref: "#/components/examples/UpdateInputExamplesEdgePrometheus"
UpdateInputExamplesElastic:
$ref: "#/components/examples/UpdateInputExamplesElastic"
UpdateInputExamplesEventhub:
$ref: "#/components/examples/UpdateInputExamplesEventhub"
UpdateInputExamplesEventhubAmqp:
$ref: "#/components/examples/UpdateInputExamplesEventhubAmqp"
UpdateInputExamplesExec:
$ref: "#/components/examples/UpdateInputExamplesExec"
UpdateInputExamplesFile:
$ref: "#/components/examples/UpdateInputExamplesFile"
UpdateInputExamplesFirehose:
$ref: "#/components/examples/UpdateInputExamplesFirehose"
UpdateInputExamplesGrafana:
$ref: "#/components/examples/UpdateInputExamplesGrafana"
UpdateInputExamplesGooglePubsub:
$ref: "#/components/examples/UpdateInputExamplesGooglePubsub"
UpdateInputExamplesHttp:
$ref: "#/components/examples/UpdateInputExamplesHttp"
UpdateInputExamplesHttpRaw:
$ref: "#/components/examples/UpdateInputExamplesHttpRaw"
UpdateInputExamplesJournalFiles:
$ref: "#/components/examples/UpdateInputExamplesJournalFiles"
UpdateInputExamplesKafka:
$ref: "#/components/examples/UpdateInputExamplesKafka"
UpdateInputExamplesKinesis:
$ref: "#/components/examples/UpdateInputExamplesKinesis"
UpdateInputExamplesKubeEvents:
$ref: "#/components/examples/UpdateInputExamplesKubeEvents"
UpdateInputExamplesKubeLogs:
$ref: "#/components/examples/UpdateInputExamplesKubeLogs"
UpdateInputExamplesKubeMetrics:
$ref: "#/components/examples/UpdateInputExamplesKubeMetrics"
UpdateInputExamplesLoki:
$ref: "#/components/examples/UpdateInputExamplesLoki"
UpdateInputExamplesMetrics:
$ref: "#/components/examples/UpdateInputExamplesMetrics"
UpdateInputExamplesModelDrivenTelemetry:
$ref: "#/components/examples/UpdateInputExamplesModelDrivenTelemetry"
UpdateInputExamplesMsk:
$ref: "#/components/examples/UpdateInputExamplesMsk"
UpdateInputExamplesNetflow:
$ref: "#/components/examples/UpdateInputExamplesNetflow"
UpdateInputExamplesOffice365Mgmt:
$ref: "#/components/examples/UpdateInputExamplesOffice365Mgmt"
UpdateInputExamplesMicrosoftGraph:
$ref: "#/components/examples/UpdateInputExamplesMicrosoftGraph"
UpdateInputExamplesOffice365MsgTrace:
$ref: "#/components/examples/UpdateInputExamplesOffice365MsgTrace"
UpdateInputExamplesOffice365Service:
$ref: "#/components/examples/UpdateInputExamplesOffice365Service"
UpdateInputExamplesOkta:
$ref: "#/components/examples/UpdateInputExamplesOkta"
UpdateInputExamplesOpenAI:
$ref: "#/components/examples/UpdateInputExamplesOpenAI"
UpdateInputExamplesOpenAIComplianceLogs:
$ref: "#/components/examples/UpdateInputExamplesOpenAIComplianceLogs"
UpdateInputExamplesOpenTelemetry:
$ref: "#/components/examples/UpdateInputExamplesOpenTelemetry"
UpdateInputExamplesPrometheus:
$ref: "#/components/examples/UpdateInputExamplesPrometheus"
UpdateInputExamplesPrometheusRw:
$ref: "#/components/examples/UpdateInputExamplesPrometheusRw"
UpdateInputExamplesRawUdp:
$ref: "#/components/examples/UpdateInputExamplesRawUdp"
UpdateInputExamplesBedrockS3:
$ref: "#/components/examples/UpdateInputExamplesBedrockS3"
UpdateInputExamplesS3:
$ref: "#/components/examples/UpdateInputExamplesS3"
UpdateInputExamplesS3Inventory:
$ref: "#/components/examples/UpdateInputExamplesS3Inventory"
UpdateInputExamplesSecurityLake:
$ref: "#/components/examples/UpdateInputExamplesSecurityLake"
UpdateInputExamplesServiceNowTable:
$ref: "#/components/examples/UpdateInputExamplesServiceNowTable"
UpdateInputExamplesSnmp:
$ref: "#/components/examples/UpdateInputExamplesSnmp"
UpdateInputExamplesSplunk:
$ref: "#/components/examples/UpdateInputExamplesSplunk"
UpdateInputExamplesSplunkHec:
$ref: "#/components/examples/UpdateInputExamplesSplunkHec"
UpdateInputExamplesSplunkSearch:
$ref: "#/components/examples/UpdateInputExamplesSplunkSearch"
UpdateInputExamplesSqs:
$ref: "#/components/examples/UpdateInputExamplesSqs"
UpdateInputExamplesSysdigHec:
$ref: "#/components/examples/UpdateInputExamplesSysdigHec"
UpdateInputExamplesSyslog:
$ref: "#/components/examples/UpdateInputExamplesSyslog"
UpdateInputExamplesSyslogWithPQ:
$ref: "#/components/examples/UpdateInputExamplesSyslogWithPQ"
UpdateInputExamplesSystemMetrics:
$ref: "#/components/examples/UpdateInputExamplesSystemMetrics"
UpdateInputExamplesSystemState:
$ref: "#/components/examples/UpdateInputExamplesSystemState"
UpdateInputExamplesTcp:
$ref: "#/components/examples/UpdateInputExamplesTcp"
UpdateInputExamplesTcpjson:
$ref: "#/components/examples/UpdateInputExamplesTcpjson"
UpdateInputExamplesUpwindHec:
$ref: "#/components/examples/UpdateInputExamplesUpwindHec"
UpdateInputExamplesWef:
$ref: "#/components/examples/UpdateInputExamplesWef"
UpdateInputExamplesWinEventLogs:
$ref: "#/components/examples/UpdateInputExamplesWinEventLogs"
UpdateInputExamplesWindowsMetrics:
$ref: "#/components/examples/UpdateInputExamplesWindowsMetrics"
UpdateInputExamplesWiz:
$ref: "#/components/examples/UpdateInputExamplesWiz"
UpdateInputExamplesWizWebhook:
$ref: "#/components/examples/UpdateInputExamplesWizWebhook"
UpdateInputExamplesZscalerHec:
$ref: "#/components/examples/UpdateInputExamplesZscalerHec"
responses:
"200":
description: The updated Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to update.
delete:
operationId: deleteInputById
x-speakeasy-group: sources
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: delete
tags:
- sources
summary: Delete a Source
description: Delete the specified Source.
responses:
"200":
description: The deleted Source object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputResponse"
examples:
InputResponseExamplesSyslogSource:
$ref: "#/components/examples/InputResponseExamplesSyslogSource"
InputResponseExamplesSyslogWithPQSource:
$ref: "#/components/examples/InputResponseExamplesSyslogWithPQSource"
InputResponseExamplesSplunkHecSource:
$ref: "#/components/examples/InputResponseExamplesSplunkHecSource"
InputResponseExamplesHttpSource:
$ref: "#/components/examples/InputResponseExamplesHttpSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to delete.
/system/inputs/{id}/hectoken:
post:
operationId: createInputHecTokenById
tags:
- sources
x-speakeasy-group: sources.hecTokens
x-speakeasy-name-override: create
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The updated Splunk HEC Source with the new HEC token.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputSplunkHec"
examples:
HecTokenResponseExamplesSplunkHecSource:
$ref: "#/components/examples/HecTokenResponseExamplesSplunkHecSource"
"400":
description: Failed validation or malformed input — Source not found, source
type is not splunk_hec, or request payload is invalid.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: AddHecTokenRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddHecTokenRequest"
examples:
HecTokenExamplesHecToken:
$ref: "#/components/examples/HecTokenExamplesHecToken"
HecTokenExamplesHecTokenWithIndexAccess:
$ref: "#/components/examples/HecTokenExamplesHecTokenWithIndexAccess"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Splunk HEC Source.
/system/inputs/{id}/hectoken/{token}:
patch:
operationId: updateInputHecTokenByIdAndToken
tags:
- sources
x-speakeasy-group: sources.hecTokens
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The updated Splunk HEC Source with the modified HEC token metadata.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputSplunkHec"
examples:
HecTokenResponseExamplesSplunkHecSource:
$ref: "#/components/examples/HecTokenResponseExamplesSplunkHecSource"
"400":
description: Failed validation or malformed input — Source not found, source
type is not splunk_hec, or request payload is invalid.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: UpdateHecTokenRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateHecTokenRequest"
examples:
HecTokenExamplesHecToken:
$ref: "#/components/examples/HecTokenExamplesHecToken"
HecTokenExamplesHecTokenWithIndexAccess:
$ref: "#/components/examples/HecTokenExamplesHecTokenWithIndexAccess"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Splunk HEC Source.
- name: token
in: path
required: true
schema:
type: string
description: The HEC token value whose metadata you want to update. Must match
an existing token on the Source.
/system/inputs/{id}/pq:
get:
operationId: getInputPqById
tags:
- sources
x-speakeasy-group: sources.pq
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The latest clear-PQ job information for the specified Source.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedJobInfo"
examples:
PQStatusResponseExamplesCompletedJob:
$ref: "#/components/examples/PQStatusResponseExamplesCompletedJob"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to get PQ job information for.
delete:
operationId: deleteInputPqById
tags:
- sources
x-speakeasy-group: sources.pq
x-speakeasy-name-override: clear
x-cribl-internal: false
x-cribl-availability: both
summary: Clear the persistent queue for a Source
description: Clear the persistent queue (PQ) for the specified Source.
responses:
"201":
description: A list of job ids for the background job that clears the persistent
queue
content:
application/json:
schema:
$ref: "#/components/schemas/CountedString"
examples:
ClearPQResponseExamplesClearPQJob:
$ref: "#/components/examples/ClearPQResponseExamplesClearPQJob"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to clear the PQ for.
/system/outputs:
get:
operationId: listOutput
x-speakeasy-group: destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: list
tags:
- destinations
summary: List all Destinations
description: Get a list of all Destinations.
responses:
"200":
description: List of Destination objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: type
in: query
required: false
schema:
$ref: "#/components/schemas/DestinationType"
description: Type of Destination to include in the results. Each request can
include only one type parameter; multiple parameters
per request are not supported.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
post:
operationId: createOutput
x-speakeasy-group: destinations
x-cribl-internal: false
x-cribl-availability: both
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
examples:
OutputCreateExamplesTcpjson:
$ref: "#/components/examples/OutputCreateExamplesTcpjson"
OutputCreateExamplesSplunk:
$ref: "#/components/examples/OutputCreateExamplesSplunk"
OutputCreateExamplesSplunkLb:
$ref: "#/components/examples/OutputCreateExamplesSplunkLb"
OutputCreateExamplesSplunkHec:
$ref: "#/components/examples/OutputCreateExamplesSplunkHec"
OutputCreateExamplesSyslog:
$ref: "#/components/examples/OutputCreateExamplesSyslog"
OutputCreateExamplesFilesystem:
$ref: "#/components/examples/OutputCreateExamplesFilesystem"
OutputCreateExamplesS3:
$ref: "#/components/examples/OutputCreateExamplesS3"
OutputCreateExamplesNutanixObjects:
$ref: "#/components/examples/OutputCreateExamplesNutanixObjects"
OutputCreateExamplesStorjS3:
$ref: "#/components/examples/OutputCreateExamplesStorjS3"
OutputCreateExamplesAlphasocS3:
$ref: "#/components/examples/OutputCreateExamplesAlphasocS3"
OutputCreateExamplesdellS3:
$ref: "#/components/examples/OutputCreateExamplesdellS3"
OutputCreateExamplescloudianS3:
$ref: "#/components/examples/OutputCreateExamplescloudianS3"
OutputCreateExamplesscalityS3:
$ref: "#/components/examples/OutputCreateExamplesscalityS3"
OutputCreateExamplesalibabaCloudS3:
$ref: "#/components/examples/OutputCreateExamplesalibabaCloudS3"
OutputCreateExamplesibmCloudS3:
$ref: "#/components/examples/OutputCreateExamplesibmCloudS3"
OutputCreateExamplesAzureBlob:
$ref: "#/components/examples/OutputCreateExamplesAzureBlob"
OutputCreateExamplesAzureDataExplorer:
$ref: "#/components/examples/OutputCreateExamplesAzureDataExplorer"
OutputCreateExamplesSentinel:
$ref: "#/components/examples/OutputCreateExamplesSentinel"
OutputCreateExamplesAzureLogs:
$ref: "#/components/examples/OutputCreateExamplesAzureLogs"
OutputCreateExamplesKafka:
$ref: "#/components/examples/OutputCreateExamplesKafka"
OutputCreateExamplesConfluentCloud:
$ref: "#/components/examples/OutputCreateExamplesConfluentCloud"
OutputCreateExamplesMsk:
$ref: "#/components/examples/OutputCreateExamplesMsk"
OutputCreateExamplesKinesis:
$ref: "#/components/examples/OutputCreateExamplesKinesis"
OutputCreateExamplesElastic:
$ref: "#/components/examples/OutputCreateExamplesElastic"
OutputCreateExamplesElasticCloud:
$ref: "#/components/examples/OutputCreateExamplesElasticCloud"
OutputCreateExamplesMicrosoftFabric:
$ref: "#/components/examples/OutputCreateExamplesMicrosoftFabric"
OutputCreateExamplesCloudflareR2:
$ref: "#/components/examples/OutputCreateExamplesCloudflareR2"
OutputCreateExamplesHoneycomb:
$ref: "#/components/examples/OutputCreateExamplesHoneycomb"
OutputCreateExamplesNewrelic:
$ref: "#/components/examples/OutputCreateExamplesNewrelic"
OutputCreateExamplesNewrelicEvents:
$ref: "#/components/examples/OutputCreateExamplesNewrelicEvents"
OutputCreateExamplesSnmp:
$ref: "#/components/examples/OutputCreateExamplesSnmp"
OutputCreateExamplesInfluxdb:
$ref: "#/components/examples/OutputCreateExamplesInfluxdb"
OutputCreateExamplesMinio:
$ref: "#/components/examples/OutputCreateExamplesMinio"
OutputCreateExamplesCloudwatch:
$ref: "#/components/examples/OutputCreateExamplesCloudwatch"
OutputCreateExamplesAzureEventhub:
$ref: "#/components/examples/OutputCreateExamplesAzureEventhub"
OutputCreateExamplesStatsd:
$ref: "#/components/examples/OutputCreateExamplesStatsd"
OutputCreateExamplesStatsdExt:
$ref: "#/components/examples/OutputCreateExamplesStatsdExt"
OutputCreateExamplesGraphite:
$ref: "#/components/examples/OutputCreateExamplesGraphite"
OutputCreateExamplesWavefront:
$ref: "#/components/examples/OutputCreateExamplesWavefront"
OutputCreateExamplesSignalfx:
$ref: "#/components/examples/OutputCreateExamplesSignalfx"
OutputCreateExamplesSqs:
$ref: "#/components/examples/OutputCreateExamplesSqs"
OutputCreateExamplesGoogleCloudStorage:
$ref: "#/components/examples/OutputCreateExamplesGoogleCloudStorage"
OutputCreateExamplesSumoLogic:
$ref: "#/components/examples/OutputCreateExamplesSumoLogic"
OutputCreateExamplesDatadog:
$ref: "#/components/examples/OutputCreateExamplesDatadog"
OutputCreateExamplesWebhook:
$ref: "#/components/examples/OutputCreateExamplesWebhook"
OutputCreateExamplesPrometheus:
$ref: "#/components/examples/OutputCreateExamplesPrometheus"
OutputCreateExamplesAmazonManagedPrometheus:
$ref: "#/components/examples/OutputCreateExamplesAmazonManagedPrometheus"
OutputCreateExamplesGooglePubsub:
$ref: "#/components/examples/OutputCreateExamplesGooglePubsub"
OutputCreateExamplesGoogleBigQuery:
$ref: "#/components/examples/OutputCreateExamplesGoogleBigQuery"
OutputCreateExamplesGoogleChronicle:
$ref: "#/components/examples/OutputCreateExamplesGoogleChronicle"
OutputCreateExamplesChronicle:
$ref: "#/components/examples/OutputCreateExamplesChronicle"
OutputCreateExamplesGrafanaCloud:
$ref: "#/components/examples/OutputCreateExamplesGrafanaCloud"
OutputCreateExamplesLoki:
$ref: "#/components/examples/OutputCreateExamplesLoki"
OutputCreateExamplesOpenTelemetry:
$ref: "#/components/examples/OutputCreateExamplesOpenTelemetry"
OutputCreateExamplesServiceNow:
$ref: "#/components/examples/OutputCreateExamplesServiceNow"
OutputCreateExamplesDynatraceOtlp:
$ref: "#/components/examples/OutputCreateExamplesDynatraceOtlp"
OutputCreateExamplesGoogleCloudObservability:
$ref: "#/components/examples/OutputCreateExamplesGoogleCloudObservability"
OutputCreateExamplesSentinelOneAiSiem:
$ref: "#/components/examples/OutputCreateExamplesSentinelOneAiSiem"
OutputCreateExamplesDataset:
$ref: "#/components/examples/OutputCreateExamplesDataset"
OutputCreateExamplesRing:
$ref: "#/components/examples/OutputCreateExamplesRing"
OutputCreateExamplesRouter:
$ref: "#/components/examples/OutputCreateExamplesRouter"
OutputCreateExamplesWizHec:
$ref: "#/components/examples/OutputCreateExamplesWizHec"
OutputCreateExamplesHumioHec:
$ref: "#/components/examples/OutputCreateExamplesHumioHec"
OutputCreateExamplesCrowdstrikeNextGenSiem:
$ref: "#/components/examples/OutputCreateExamplesCrowdstrikeNextGenSiem"
OutputCreateExamplesCriblHttp:
$ref: "#/components/examples/OutputCreateExamplesCriblHttp"
OutputCreateExamplesCriblTcp:
$ref: "#/components/examples/OutputCreateExamplesCriblTcp"
OutputCreateExamplesCriblSearchEngine:
$ref: "#/components/examples/OutputCreateExamplesCriblSearchEngine"
OutputCreateExamplesGoogleCloudLogging:
$ref: "#/components/examples/OutputCreateExamplesGoogleCloudLogging"
OutputCreateExamplesSns:
$ref: "#/components/examples/OutputCreateExamplesSns"
OutputCreateExamplesDlS3:
$ref: "#/components/examples/OutputCreateExamplesDlS3"
OutputCreateExamplesSecurityLake:
$ref: "#/components/examples/OutputCreateExamplesSecurityLake"
OutputCreateExamplesCriblLake:
$ref: "#/components/examples/OutputCreateExamplesCriblLake"
OutputCreateExamplesExabeam:
$ref: "#/components/examples/OutputCreateExamplesExabeam"
OutputCreateExamplesDiskSpool:
$ref: "#/components/examples/OutputCreateExamplesDiskSpool"
OutputCreateExamplesClickHouse:
$ref: "#/components/examples/OutputCreateExamplesClickHouse"
OutputCreateExamplesLocalSearchStorage:
$ref: "#/components/examples/OutputCreateExamplesLocalSearchStorage"
OutputCreateExamplesCustomerMetricsStorage:
$ref: "#/components/examples/OutputCreateExamplesCustomerMetricsStorage"
OutputCreateExamplesXsiam:
$ref: "#/components/examples/OutputCreateExamplesXsiam"
OutputCreateExamplesNetflow:
$ref: "#/components/examples/OutputCreateExamplesNetflow"
OutputCreateExamplesDynatraceHttp:
$ref: "#/components/examples/OutputCreateExamplesDynatraceHttp"
OutputCreateExamplesDatabricks:
$ref: "#/components/examples/OutputCreateExamplesDatabricks"
OutputCreateExamplesSnowflakeStreaming:
$ref: "#/components/examples/OutputCreateExamplesSnowflakeStreaming"
responses:
"200":
description: The created Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"409":
description: Request conflicts with current resource state — Destination with
the specified ID already exists.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/system/outputs/{id}:
get:
operationId: getOutputById
x-speakeasy-group: destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: get
tags:
- destinations
summary: Get a Destination
description: Get the specified Destination.
responses:
"200":
description: The requested Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to get.
patch:
operationId: updateOutputById
x-speakeasy-group: destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: update
tags:
- destinations
summary: Update a Destination
description: Update the specified Destination.
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.
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.
requestBody:
description: Output object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Output"
examples:
UpdateOutputExamplesDefault:
$ref: "#/components/examples/UpdateOutputExamplesDefault"
UpdateOutputExamplesTcpjson:
$ref: "#/components/examples/UpdateOutputExamplesTcpjson"
UpdateOutputExamplesSplunk:
$ref: "#/components/examples/UpdateOutputExamplesSplunk"
UpdateOutputExamplesSplunkLb:
$ref: "#/components/examples/UpdateOutputExamplesSplunkLb"
UpdateOutputExamplesSplunkHec:
$ref: "#/components/examples/UpdateOutputExamplesSplunkHec"
UpdateOutputExamplesSyslog:
$ref: "#/components/examples/UpdateOutputExamplesSyslog"
UpdateOutputExamplesFilesystem:
$ref: "#/components/examples/UpdateOutputExamplesFilesystem"
UpdateOutputExamplesS3:
$ref: "#/components/examples/UpdateOutputExamplesS3"
UpdateOutputExamplesNutanixObjects:
$ref: "#/components/examples/UpdateOutputExamplesNutanixObjects"
UpdateOutputExamplesStorjS3:
$ref: "#/components/examples/UpdateOutputExamplesStorjS3"
UpdateOutputExamplesAlphasocS3:
$ref: "#/components/examples/UpdateOutputExamplesAlphasocS3"
UpdateOutputExamplesdellS3:
$ref: "#/components/examples/UpdateOutputExamplesdellS3"
UpdateOutputExamplescloudianS3:
$ref: "#/components/examples/UpdateOutputExamplescloudianS3"
UpdateOutputExamplesscalityS3:
$ref: "#/components/examples/UpdateOutputExamplesscalityS3"
UpdateOutputExamplesalibabaCloudS3:
$ref: "#/components/examples/UpdateOutputExamplesalibabaCloudS3"
UpdateOutputExamplesibmCloudS3:
$ref: "#/components/examples/UpdateOutputExamplesibmCloudS3"
UpdateOutputExamplesAzureBlob:
$ref: "#/components/examples/UpdateOutputExamplesAzureBlob"
UpdateOutputExamplesAzureDataExplorer:
$ref: "#/components/examples/UpdateOutputExamplesAzureDataExplorer"
UpdateOutputExamplesSentinel:
$ref: "#/components/examples/UpdateOutputExamplesSentinel"
UpdateOutputExamplesAzureLogs:
$ref: "#/components/examples/UpdateOutputExamplesAzureLogs"
UpdateOutputExamplesKafka:
$ref: "#/components/examples/UpdateOutputExamplesKafka"
UpdateOutputExamplesConfluentCloud:
$ref: "#/components/examples/UpdateOutputExamplesConfluentCloud"
UpdateOutputExamplesMsk:
$ref: "#/components/examples/UpdateOutputExamplesMsk"
UpdateOutputExamplesKinesis:
$ref: "#/components/examples/UpdateOutputExamplesKinesis"
UpdateOutputExamplesElastic:
$ref: "#/components/examples/UpdateOutputExamplesElastic"
UpdateOutputExamplesElasticCloud:
$ref: "#/components/examples/UpdateOutputExamplesElasticCloud"
UpdateOutputExamplesMicrosoftFabric:
$ref: "#/components/examples/UpdateOutputExamplesMicrosoftFabric"
UpdateOutputExamplesCloudflareR2:
$ref: "#/components/examples/UpdateOutputExamplesCloudflareR2"
UpdateOutputExamplesHoneycomb:
$ref: "#/components/examples/UpdateOutputExamplesHoneycomb"
UpdateOutputExamplesNewrelic:
$ref: "#/components/examples/UpdateOutputExamplesNewrelic"
UpdateOutputExamplesNewrelicEvents:
$ref: "#/components/examples/UpdateOutputExamplesNewrelicEvents"
UpdateOutputExamplesSnmp:
$ref: "#/components/examples/UpdateOutputExamplesSnmp"
UpdateOutputExamplesInfluxdb:
$ref: "#/components/examples/UpdateOutputExamplesInfluxdb"
UpdateOutputExamplesMinio:
$ref: "#/components/examples/UpdateOutputExamplesMinio"
UpdateOutputExamplesCloudwatch:
$ref: "#/components/examples/UpdateOutputExamplesCloudwatch"
UpdateOutputExamplesAzureEventhub:
$ref: "#/components/examples/UpdateOutputExamplesAzureEventhub"
UpdateOutputExamplesStatsd:
$ref: "#/components/examples/UpdateOutputExamplesStatsd"
UpdateOutputExamplesStatsdExt:
$ref: "#/components/examples/UpdateOutputExamplesStatsdExt"
UpdateOutputExamplesGraphite:
$ref: "#/components/examples/UpdateOutputExamplesGraphite"
UpdateOutputExamplesWavefront:
$ref: "#/components/examples/UpdateOutputExamplesWavefront"
UpdateOutputExamplesSignalfx:
$ref: "#/components/examples/UpdateOutputExamplesSignalfx"
UpdateOutputExamplesSqs:
$ref: "#/components/examples/UpdateOutputExamplesSqs"
UpdateOutputExamplesGoogleCloudStorage:
$ref: "#/components/examples/UpdateOutputExamplesGoogleCloudStorage"
UpdateOutputExamplesSumoLogic:
$ref: "#/components/examples/UpdateOutputExamplesSumoLogic"
UpdateOutputExamplesDatadog:
$ref: "#/components/examples/UpdateOutputExamplesDatadog"
UpdateOutputExamplesWebhook:
$ref: "#/components/examples/UpdateOutputExamplesWebhook"
UpdateOutputExamplesPrometheus:
$ref: "#/components/examples/UpdateOutputExamplesPrometheus"
UpdateOutputExamplesAmazonManagedPrometheus:
$ref: "#/components/examples/UpdateOutputExamplesAmazonManagedPrometheus"
UpdateOutputExamplesGooglePubsub:
$ref: "#/components/examples/UpdateOutputExamplesGooglePubsub"
UpdateOutputExamplesGoogleBigQuery:
$ref: "#/components/examples/UpdateOutputExamplesGoogleBigQuery"
UpdateOutputExamplesGoogleChronicle:
$ref: "#/components/examples/UpdateOutputExamplesGoogleChronicle"
UpdateOutputExamplesChronicle:
$ref: "#/components/examples/UpdateOutputExamplesChronicle"
UpdateOutputExamplesGrafanaCloud:
$ref: "#/components/examples/UpdateOutputExamplesGrafanaCloud"
UpdateOutputExamplesLoki:
$ref: "#/components/examples/UpdateOutputExamplesLoki"
UpdateOutputExamplesOpenTelemetry:
$ref: "#/components/examples/UpdateOutputExamplesOpenTelemetry"
UpdateOutputExamplesServiceNow:
$ref: "#/components/examples/UpdateOutputExamplesServiceNow"
UpdateOutputExamplesDynatraceOtlp:
$ref: "#/components/examples/UpdateOutputExamplesDynatraceOtlp"
UpdateOutputExamplesGoogleCloudObservability:
$ref: "#/components/examples/UpdateOutputExamplesGoogleCloudObservability"
UpdateOutputExamplesSentinelOneAiSiem:
$ref: "#/components/examples/UpdateOutputExamplesSentinelOneAiSiem"
UpdateOutputExamplesDataset:
$ref: "#/components/examples/UpdateOutputExamplesDataset"
UpdateOutputExamplesRing:
$ref: "#/components/examples/UpdateOutputExamplesRing"
UpdateOutputExamplesRouter:
$ref: "#/components/examples/UpdateOutputExamplesRouter"
UpdateOutputExamplesWizHec:
$ref: "#/components/examples/UpdateOutputExamplesWizHec"
UpdateOutputExamplesHumioHec:
$ref: "#/components/examples/UpdateOutputExamplesHumioHec"
UpdateOutputExamplesCrowdstrikeNextGenSiem:
$ref: "#/components/examples/UpdateOutputExamplesCrowdstrikeNextGenSiem"
UpdateOutputExamplesCriblHttp:
$ref: "#/components/examples/UpdateOutputExamplesCriblHttp"
UpdateOutputExamplesCriblTcp:
$ref: "#/components/examples/UpdateOutputExamplesCriblTcp"
UpdateOutputExamplesCriblSearchEngine:
$ref: "#/components/examples/UpdateOutputExamplesCriblSearchEngine"
UpdateOutputExamplesGoogleCloudLogging:
$ref: "#/components/examples/UpdateOutputExamplesGoogleCloudLogging"
UpdateOutputExamplesSns:
$ref: "#/components/examples/UpdateOutputExamplesSns"
UpdateOutputExamplesDlS3:
$ref: "#/components/examples/UpdateOutputExamplesDlS3"
UpdateOutputExamplesSecurityLake:
$ref: "#/components/examples/UpdateOutputExamplesSecurityLake"
UpdateOutputExamplesCriblLake:
$ref: "#/components/examples/UpdateOutputExamplesCriblLake"
UpdateOutputExamplesExabeam:
$ref: "#/components/examples/UpdateOutputExamplesExabeam"
UpdateOutputExamplesDiskSpool:
$ref: "#/components/examples/UpdateOutputExamplesDiskSpool"
UpdateOutputExamplesClickHouse:
$ref: "#/components/examples/UpdateOutputExamplesClickHouse"
UpdateOutputExamplesLocalSearchStorage:
$ref: "#/components/examples/UpdateOutputExamplesLocalSearchStorage"
UpdateOutputExamplesCustomerMetricsStorage:
$ref: "#/components/examples/UpdateOutputExamplesCustomerMetricsStorage"
UpdateOutputExamplesXsiam:
$ref: "#/components/examples/UpdateOutputExamplesXsiam"
UpdateOutputExamplesNetflow:
$ref: "#/components/examples/UpdateOutputExamplesNetflow"
UpdateOutputExamplesDynatraceHttp:
$ref: "#/components/examples/UpdateOutputExamplesDynatraceHttp"
UpdateOutputExamplesDatabricks:
$ref: "#/components/examples/UpdateOutputExamplesDatabricks"
UpdateOutputExamplesSnowflakeStreaming:
$ref: "#/components/examples/UpdateOutputExamplesSnowflakeStreaming"
responses:
"200":
description: The updated Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist — Destination not found.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to update.
delete:
operationId: deleteOutputById
x-speakeasy-group: destinations
x-cribl-internal: false
x-cribl-availability: both
x-speakeasy-name-override: delete
tags:
- destinations
summary: Delete a Destination
description: Delete the specified Destination.
responses:
"200":
description: The deleted Destination object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputResponse"
examples:
OutputResponseExamplesSplunkHecDestination:
$ref: "#/components/examples/OutputResponseExamplesSplunkHecDestination"
OutputResponseExamplesS3Destination:
$ref: "#/components/examples/OutputResponseExamplesS3Destination"
OutputResponseExamplesSyslogDestination:
$ref: "#/components/examples/OutputResponseExamplesSyslogDestination"
OutputResponseExamplesSnowflakeStreamingDestination:
$ref: "#/components/examples/OutputResponseExamplesSnowflakeStreamingDestinatio\
n"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"404":
description: The requested resource does not exist — Destination not found.
"409":
description: Request conflicts with current resource state — Destination is
referenced by another entity.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to delete.
/system/outputs/{id}/pq:
delete:
operationId: deleteOutputPqById
tags:
- destinations
x-speakeasy-group: destinations.pq
x-speakeasy-name-override: clear
x-cribl-internal: false
x-cribl-availability: both
summary: Clear the persistent queue for a Destination
description: Clear the persistent queue (PQ) for the specified Destination.
responses:
"201":
description: The job ID for the background job that clears the persistent queue.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedString"
examples:
OutputClearPQResponseExamplesClearPQJobId:
$ref: "#/components/examples/OutputClearPQResponseExamplesClearPQJobId"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to clear the PQ for.
get:
operationId: getOutputPqById
tags:
- destinations
x-speakeasy-group: destinations.pq
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: Information about the latest job to clear the PQ for the Destination.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedJobInfo"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id 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
x-cribl-internal: false
x-cribl-availability: both
summary: Get sample event data for a Destination
description: Get sample event data for the specified Destination to validate the
configuration or test connectivity.
responses:
"200":
description: Sample event data for the Destination.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputSamplesResponse"
examples:
OutputSamplesResponseExamplesSampleEvents:
$ref: "#/components/examples/OutputSamplesResponseExamplesSampleEvents"
"400":
description: Failed validation or malformed input — invalid request or
Destination error.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id 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
x-cribl-internal: false
x-cribl-availability: both
summary: Send sample event data to a Destination
description: Send sample event data to the specified Destination to validate the
configuration or test connectivity.
responses:
"200":
description: Destination test result.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputTestResponse"
examples:
OutputTestResponseExamplesSuccessfulTest:
$ref: "#/components/examples/OutputTestResponseExamplesSuccessfulTest"
OutputTestResponseExamplesFailedTest:
$ref: "#/components/examples/OutputTestResponseExamplesFailedTest"
"400":
description: Failed validation or malformed input — missing or invalid events.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: OutputTestRequest object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/OutputTestRequest"
examples:
OutputTestExamplesSingleEvent:
$ref: "#/components/examples/OutputTestExamplesSingleEvent"
OutputTestExamplesMultipleEvents:
$ref: "#/components/examples/OutputTestExamplesMultipleEvents"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to send sample event data to.
/system/settings/conf:
get:
operationId: getSystemSettingsConf
tags:
- system
x-speakeasy-group: system.settings.cribl
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: Get system settings
description: Get the current Cribl system settings.
responses:
"200":
description: The current system settings.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedSystemSettingsConf"
examples:
GetSystemSettingsConfExamplesDefault:
$ref: "#/components/examples/GetSystemSettingsConfExamplesDefault"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
patch:
operationId: updateSystemSettingsConf
tags:
- system
x-speakeasy-group: system.settings.cribl
x-speakeasy-name-override: update
x-cribl-internal: false
x-cribl-availability: both
summary: Update system settings
description: Update the specified Cribl system settings.
This endpoint
supports partial updates — provide only the top-level sections
(api, workers, tls,
proxy, etc.) that you want to change. Omitted top-level
sections are preserved unchanged.
Important: while
top-level sections are optional, nested objects within a section must be
complete. For example, if you include api, you must provide
its required fields (host and port).
responses:
"200":
description: The updated system settings.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedSystemSettingsConf"
examples:
UpdateSystemSettingsResponseExamplesUpdateApiSettings:
$ref: "#/components/examples/UpdateSystemSettingsResponseExamplesUpdateApiSetti\
ngs"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"403":
description: Not authorized to perform this action, or the requested change is
not permitted in this deployment.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: SystemSettingsConfUpdate object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SystemSettingsConfUpdate"
examples:
UpdateSystemSettingsExamplesUpdateApiSettings:
$ref: "#/components/examples/UpdateSystemSettingsExamplesUpdateApiSettings"
/system/settings/restart:
post:
operationId: createSystemSettingsRestart
tags:
- system
x-speakeasy-group: system.settings
x-speakeasy-name-override: restart
x-cribl-internal: false
x-cribl-availability: both
summary: Restart the Cribl server
description: Restart the Cribl server.
This operation requires
system.restart to be set to api in
cribl.yml. If this setting is not configured, the request
returns a 403 error.
Restarting the server causes
a brief period of downtime while the process stops and restarts. All
in-flight events are drained before the process exits. Use POST
/system/settings/reload to apply configuration changes without a
full restart.
responses:
"200":
description: Result of the restart operation.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedSystemRestartResponse"
examples:
RestartSystemExamplesDefault:
$ref: "#/components/examples/RestartSystemExamplesDefault"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"403":
description: Restart from the API is disabled. Set system.restart
to api in cribl.yml to enable it.
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/system/status/inputs:
get:
operationId: getInputStatus
tags:
- sources
x-speakeasy-group: sources.statuses
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List the status of all Sources
description: List status information and optional metrics for all configured
Sources in the Worker Group or Edge Fleet.
responses:
"200":
description: List of Source status objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedInputStatus"
examples:
InputStatusResponseExamplesGreenSource:
$ref: "#/components/examples/InputStatusResponseExamplesGreenSource"
InputStatusResponseExamplesYellowSource:
$ref: "#/components/examples/InputStatusResponseExamplesYellowSource"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Source.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Source id with
the Source type. Otherwise, false (default).
- name: offset
in: query
required: false
schema:
type: integer
description: Starting point from which to retrieve results for this request. Use
with limit to paginate the response into manageable
batches.
- name: limit
in: query
required: false
schema:
type: integer
description: Maximum number of items to return in the response for this request.
Use with offset to paginate the response into
manageable batches.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/system/status/inputs/{id}:
get:
operationId: getInputStatusById
tags:
- sources
x-speakeasy-group: sources.statuses
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the status of a Source
description: Get the status and optional metrics for the specified Source.
responses:
"200":
description: The requested Source status object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedInputStatus"
examples:
InputStatusResponseExamplesGreenSource:
$ref: "#/components/examples/InputStatusResponseExamplesGreenSource"
InputStatusResponseExamplesYellowSource:
$ref: "#/components/examples/InputStatusResponseExamplesYellowSource"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Source to get the status for.
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Source.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Source id with
the Source type. Otherwise, false (default).
/system/status/outputs:
get:
operationId: getOutputStatus
tags:
- destinations
x-speakeasy-group: destinations.statuses
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List the status of all Destinations
description: List status information and optional metrics for all configured
Destinations in the Worker Group or Edge Fleet.
responses:
"200":
description: List of Destination status objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedOutputStatus"
examples:
OutputStatusResponseExamplesGreenDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesGreenDestination"
OutputStatusResponseExamplesYellowDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesYellowDestination"
"400":
description: Failed validation or malformed input, such as missing or invalid
parameters.
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Destination.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Destination id
with the Destination type. Otherwise, false (default).
- name: offset
in: query
required: false
schema:
type: integer
description: Starting point from which to retrieve results for this request. Use
with limit to paginate the response into manageable
batches.
- name: limit
in: query
required: false
schema:
type: integer
description: Maximum number of items to return in the response for this request.
Use with offset to paginate the response into
manageable batches.
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/system/status/outputs/{id}:
get:
operationId: getOutputStatusById
tags:
- destinations
x-speakeasy-group: destinations.statuses
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
summary: Get the status of a Destination
description: Get the status and optional metrics for the specified Destination.
responses:
"200":
description: The requested Destination status object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedOutputStatus"
examples:
OutputStatusResponseExamplesGreenDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesGreenDestination"
OutputStatusResponseExamplesYellowDestination:
$ref: "#/components/examples/OutputStatusResponseExamplesYellowDestination"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The id of the Destination to get the status for.
- name: metrics
in: query
required: false
schema:
type: boolean
description: Set to true to include metrics for each Destination.
Otherwise, false (default).
- name: type
in: query
required: false
schema:
type: boolean
description: Set to true to prefix the Destination id
with the Destination type. Otherwise, false (default).
/version:
get:
operationId: getVersion
tags:
- versioning
x-speakeasy-group: versions.commits
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
summary: List the commit history
description: List the commit history.
Analogous to git log
for the Cribl configuration, allowing you to audit and review changes
over time.
responses:
"200":
description: List of GitLogResult objects.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedGitLogResult"
examples:
VersionListResponseExamplesListCommitHistory:
$ref: "#/components/examples/VersionListResponseExamplesListCommitHistory"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: count
in: query
required: false
schema:
type: integer
description: Maximum number of commits to read from the commit history. When
provided, offset and limit are applied to
that read set.
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Pagination offset
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
description: Maximum number of items to return
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: offset
in: parameters
type: offset
- name: limit
in: parameters
type: limit
outputs:
results: $.items
/version/branch:
get:
operationId: getVersionBranch
tags:
- versioning
x-speakeasy-group: versions.branches
x-speakeasy-name-override: list
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The requested BranchInfo object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedBranchInfo"
examples:
VersionBranchResponseExamplesListBranches:
$ref: "#/components/examples/VersionBranchResponseExamplesListBranches"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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
x-cribl-internal: false
x-cribl-availability: both
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.
To commit only a subset of configuration changes, specify
the files to include in the commit in the files array.
responses:
"200":
description: The created GitCommitSummary object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitCommitSummary"
examples:
VersionCommitResponseExamplesCommitCreated:
$ref: "#/components/examples/VersionCommitResponseExamplesCommitCreated"
"400":
description: "When effective: true is provided without a group
context."
content:
application/json:
schema:
$ref: "#/components/schemas/RestApiJsonError"
examples:
VersionCommitBadRequestExamplesEffectiveWithoutGroup:
$ref: "#/components/examples/VersionCommitBadRequestExamplesEffectiveWithoutGro\
up"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: GitCommitBody object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/GitCommitBody"
examples:
VersionCommitExamplesCommitAll:
$ref: "#/components/examples/VersionCommitExamplesCommitAll"
VersionCommitExamplesCommitSpecificFiles:
$ref: "#/components/examples/VersionCommitExamplesCommitSpecificFiles"
/version/count:
get:
operationId: getVersionCount
tags:
- versioning
x-speakeasy-group: versions.commits.files
x-speakeasy-name-override: count
x-cribl-internal: false
x-cribl-availability: both
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).
responses:
"200":
description: The requested GitCountResult object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitCountResult"
examples:
VersionCountResponseExamplesFileCount:
$ref: "#/components/examples/VersionCountResponseExamplesFileCount"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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 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
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The requested CurrentBranchResult object.
content:
application/json:
schema:
$ref: "#/components/schemas/CurrentBranchResult"
examples:
VersionCurrentBranchResponseExamplesCurrentBranch:
$ref: "#/components/examples/VersionCurrentBranchResponseExamplesCurrentBranch"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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
x-cribl-internal: false
x-cribl-availability: both
summary: Get the diff for a commit
description: Get the diff for a commit. Default is the latest commit (HEAD).
responses:
"200":
description: The requested GitDiffResult object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitDiffResult"
examples:
VersionDiffResponseExamplesDiffResult:
$ref: "#/components/examples/VersionDiffResponseExamplesDiffResult"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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: 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: integer
description: Number of lines of the diff to return. Default is 1000. Set to
0 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
x-cribl-internal: false
x-cribl-availability: both
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).
responses:
"200":
description: The requested GitFilesResponse object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitFilesResponse"
examples:
VersionFilesResponseExamplesChangedFiles:
$ref: "#/components/examples/VersionFilesResponseExamplesChangedFiles"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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 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
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The requested GitInfo object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitInfo"
examples:
VersionInfoResponseExamplesGitInfo:
$ref: "#/components/examples/VersionInfoResponseExamplesGitInfo"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/version/push:
post:
operationId: createVersionPush
tags:
- versioning
x-speakeasy-group: versions.commits
x-speakeasy-name-override: push
x-cribl-internal: false
x-cribl-availability: both
summary: Push local commits to the remote repository
description: Push all local commits from the local repository to the remote
repository.
Requires at least one local commit that has not
been pushed. Returns an error if the remote repository cannot be reached
or the push is rejected.
responses:
"200":
description: The created string object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedString"
examples:
VersionPushResponseExamplesPushResult:
$ref: "#/components/examples/VersionPushResponseExamplesPushResult"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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
x-cribl-internal: false
x-cribl-availability: both
summary: Revert a commit in the local repository
description: Revert a commit in the local repository by creating a new commit
that undoes the changes introduced by the specified commit.
Use
the force field to proceed even when the working directory
is not clean.
responses:
"200":
description: The created GitRevertResult object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitRevertResult"
examples:
VersionRevertResponseExamplesRevertResult:
$ref: "#/components/examples/VersionRevertResponseExamplesRevertResult"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
requestBody:
description: GitRevertParams object.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/GitRevertParams"
examples:
VersionRevertExamplesRevertCommit:
$ref: "#/components/examples/VersionRevertExamplesRevertCommit"
VersionRevertExamplesForceRevertWithMessage:
$ref: "#/components/examples/VersionRevertExamplesForceRevertWithMessage"
/version/show:
get:
operationId: getVersionShow
tags:
- versioning
x-speakeasy-group: versions.commits
x-speakeasy-name-override: get
x-cribl-internal: false
x-cribl-availability: both
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).
responses:
"200":
description: The requested GitShowResult object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitShowResult"
examples:
VersionShowResponseExamplesShowCommit:
$ref: "#/components/examples/VersionShowResponseExamplesShowCommit"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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: 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: integer
description: Number of lines of the diff to return. Default is 1000. Set to
0 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
x-cribl-internal: false
x-cribl-availability: both
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.
responses:
"200":
description: The requested GitStatusResult object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedGitStatusResult"
examples:
VersionStatusResponseExamplesWorkingTreeStatus:
$ref: "#/components/examples/VersionStatusResponseExamplesWorkingTreeStatus"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server 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
x-cribl-internal: false
x-cribl-availability: both
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.
When applied globally (no group), triggers a Cribl
restart to reload the reverted configuration. Returns false
if the working directory is already clean.
responses:
"200":
description: The created boolean object in a single-item list.
content:
application/json:
schema:
$ref: "#/components/schemas/CountedBoolean"
examples:
VersionUndoResponseExamplesUndoResult:
$ref: "#/components/examples/VersionUndoResponseExamplesUndoResult"
"401":
description: Authentication failed (missing or invalid credentials or Bearer
token).
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
status: error
message: Authentication failed (missing or invalid credentials or Bearer token).
"500":
description: Unexpected server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"