# info.description
Edge Delta API provides endpoints to manage your configs/integrations/rehydrations and more. Generate an API token to get started: https://app.edgedelta.com/admin/organization#api-tokens The API is URL-versioned (current version: v1); the deprecation policy is documented at https://edgedelta.com/developers#versioning-and-deprecation.

# paths./public/dashboards/{dashboard_hash}.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./public/dashboards/{dashboard_hash}.get.responses.404.description
Not found. The requested resource does not exist.

# paths./public/stats.get.description
Anonymized, platform-wide aggregate stats for the marketing site. No auth, no customer data.

# paths./public/stats.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./public/stats.get.responses.404.description
Not found. The requested resource does not exist.

# paths./public/stats.get.summary
Anonymized, platform-wide aggregate stats for the marketing site

# paths./v1/orgs/{org_id}/access.get.parameters[].description
If set to true response includes external state information from auth0

# paths./v1/orgs/{org_id}/access.get.parameters[].description
If set to true response includes only items with pending status (to be used in Membership Requests)

# paths./v1/orgs/{org_id}/access.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/access.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/access.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/access.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/access/{access_id}.put.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/access/{access_id}.put.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/access/{access_id}.delete.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/access/{access_id}.delete.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/clustering/stats.get.description
Returns top log patterns (signatures of log messages) and their stats; count, proportion, sentiment and delta.

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
Edge Delta Common Query Language expression

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
If summary true call returns up to 50 interesting clusters with 10 top anomaly, top/bottom delta, top/bottom count. Param size is ignored

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
Max number of clusters in response. For AI search, limit should be 20.

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
Lookback period in golang duration format. e.g. '1h'. Either provide from/to or provide lookback/to or just lookback

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
Valatility can be new, existing, gone, all. Default is all

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
Comma separated offsets for delta stat calculation. Each offset is in golang duration format and order of offsets determines order of offset_ fields in cluster stat response. Default value is lookback duration. e.g. '24h'.

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
Window for on demand anomaly calculation histogram series. e.g. '5m', '1h', '2d'. Combined values like '5m3s' are NOT supported.

# paths./v1/orgs/{org_id}/clustering/stats.get.parameters[].description
Negative param is used to get negative sentiments.

# paths./v1/orgs/{org_id}/clustering/stats.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/clustering/stats.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/clustering/stats.get.summary
Returns top log patterns (signatures of log messages) and their stats; count, proportion, sentiment and delta

# paths./v1/orgs/{org_id}/confs.get.description
Return org's agent configurations that user has read access to

# paths./v1/orgs/{org_id}/confs.get.parameters[].description
Should be set to 'true' if the contents won't be fetched

# paths./v1/orgs/{org_id}/confs.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/confs.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/confs.get.summary
Return org's agent configurations that user has read access to

# paths./v1/orgs/{org_id}/confs.post.description
Creates a new config from the yml content passed in body

# paths./v1/orgs/{org_id}/confs.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/confs.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/confs.post.summary
Creates a new config from the yml content passed in body

# paths./v1/orgs/{org_id}/confs/validate.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/confs/validate.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/confs/{conf_id}.get.parameters[].description
Should be set to 'true' if the content won't be fetched

# paths./v1/orgs/{org_id}/confs/{conf_id}.get.parameters[].description
Should be set to 'true' if the content would be fully resolved (i.e with children etc)

# paths./v1/orgs/{org_id}/confs/{conf_id}.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/confs/{conf_id}.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/confs/{conf_id}.put.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/confs/{conf_id}.put.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/confs/{conf_id}.delete.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/confs/{conf_id}.delete.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/dashboards.get.description
Returns all dashboards of users in the org.

# paths./v1/orgs/{org_id}/dashboards.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/dashboards.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/dashboards.get.summary
Returns all dashboards of users in the org

# paths./v1/orgs/{org_id}/dashboards/{dashboard_id}.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/dashboards/{dashboard_id}.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/events/search.get.description
Search query using Edge Delta events search syntax, for anomaly search query should include event.type:pattern_anomaly

# paths./v1/orgs/{org_id}/events/search.get.parameters[].description
Lookback period in golang duration format. e.g. '1h'. Either provide from/to or provide lookback/to or just lookback

# paths./v1/orgs/{org_id}/events/search.get.parameters[].description
Edge Delta Common Query Language expression

# paths./v1/orgs/{org_id}/events/search.get.parameters[].description
Limits the number of logs in the response. Default is 1000. It can be negative to move the cursor prev direction. Wraps to end if the cursor position is 0. For AI search, limit should be 20.

# paths./v1/orgs/{org_id}/events/search.get.parameters[].description
Cursor provided from previous response, pass it to next request so that we can move the cursor with given limit.

# paths./v1/orgs/{org_id}/events/search.get.parameters[].description
Order of the logs in the response, either 'ASC', 'asc', 'DESC' or 'desc'

# paths./v1/orgs/{org_id}/events/search.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/events/search.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/events/search.get.summary
Search query using Edge Delta events search syntax, for anomaly search query should include event

# paths./v1/orgs/{org_id}/group.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/group.post.description
Creates a new group from the json content passed in body

# paths./v1/orgs/{org_id}/group.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/group.post.summary
Creates a new group from the json content passed in body

# paths./v1/orgs/{org_id}/group/{group_id}.put.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group/{group_id}.put.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/group/{group_id}.delete.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group/{group_id}.delete.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/group/{group_id}/accesses.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group/{group_id}/accesses.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/group_member.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group_member.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/group_member.post.description
Creates a new user & group relationship from the json content passed in body

# paths./v1/orgs/{org_id}/group_member.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group_member.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/group_member.post.summary
Creates a new user & group relationship from the json content passed in body

# paths./v1/orgs/{org_id}/group_member/{group_member_id}.delete.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/group_member/{group_member_id}.delete.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/http_workflow_input/test.post.description
Tests an HTTP Workflow input by executing its configured steps

# paths./v1/orgs/{org_id}/http_workflow_input/test.post.requestBody.description
YAML config of the HTTP Workflow input to test

# paths./v1/orgs/{org_id}/http_workflow_input/test.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/http_workflow_input/test.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/http_workflow_input/test.post.summary
Tests an HTTP Workflow input by executing its configured steps

# paths./v1/orgs/{org_id}/integrations.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/integrations.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/integrations.post.description
Saves the new integration endpoints in org-settings.

# paths./v1/orgs/{org_id}/integrations.post.requestBody.description
Dictionary of changed integrations {id:value}

# paths./v1/orgs/{org_id}/integrations.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/integrations.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/integrations.post.summary
Saves the new integration endpoints in org-settings

# paths./v1/orgs/{org_id}/integrations.delete.description
Delete given integration endpoints in org-settings.

# paths./v1/orgs/{org_id}/integrations.delete.parameters[].description
Comma separated names of integration endpoints to delete

# paths./v1/orgs/{org_id}/integrations.delete.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/integrations.delete.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/integrations.delete.summary
Delete given integration endpoints in org-settings

# paths./v1/orgs/{org_id}/integrations_v2.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/integrations_v2.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/integrations_v2/test.post.description
Tests the connectivity of the given integration endpoints.

# paths./v1/orgs/{org_id}/integrations_v2/test.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/integrations_v2/test.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/integrations_v2/test.post.summary
Tests the connectivity of the given integration endpoints

# paths./v1/orgs/{org_id}/integrations_v2/test/supported.get.description
Lists of integrations that support testing connectivity.

# paths./v1/orgs/{org_id}/integrations_v2/test/supported.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/integrations_v2/test/supported.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/integrations_v2/test/supported.get.summary
Lists of integrations that support testing connectivity

# paths./v1/orgs/{org_id}/invite.post.description
send invite email to provided user and create necessary access.

# paths./v1/orgs/{org_id}/invite.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/invite.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/invite.post.summary
send invite email to provided user and create necessary access

# paths./v1/orgs/{org_id}/logs/log_search/query_explain.get.description
Returns EXPLAIN indexes=1 output for a SQL query to show query execution plan

# paths./v1/orgs/{org_id}/logs/log_search/query_explain.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/logs/log_search/query_explain.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/logs/log_search/query_explain.get.summary
Returns EXPLAIN indexes=1 output for a SQL query to show query execution plan

# paths./v1/orgs/{org_id}/logs/log_search/query_log.get.description
Returns ClickHouse query execution metrics for all queries in a log search session

# paths./v1/orgs/{org_id}/logs/log_search/query_log.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/logs/log_search/query_log.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/logs/log_search/query_log.get.summary
Returns ClickHouse query execution metrics for all queries in a log search session

# paths./v1/orgs/{org_id}/logs/log_search/search.get.description
Returns time series log data for given query

# paths./v1/orgs/{org_id}/logs/log_search/search.get.parameters[].description
Lookback period in golang duration format. e.g. '1h'. Either provide from/to or provide lookback/to or just lookback

# paths./v1/orgs/{org_id}/logs/log_search/search.get.parameters[].description
Edge Delta Common Query Language expression

# paths./v1/orgs/{org_id}/logs/log_search/search.get.parameters[].description
Limits the number of logs in the response. Default is 1000. It can be negative to move the cursor prev direction. Wraps to end if the cursor position is 0. For AI search, limit should be 20.

# paths./v1/orgs/{org_id}/logs/log_search/search.get.parameters[].description
Cursor provided from previous response, pass it to next request so that we can move the cursor with given limit.

# paths./v1/orgs/{org_id}/logs/log_search/search.get.parameters[].description
Comma separated list of custom columns to include in the recent search queries

# paths./v1/orgs/{org_id}/logs/log_search/search.get.parameters[].description
Order of the logs in the response, either 'ASC', 'asc', 'DESC' or 'desc'

# paths./v1/orgs/{org_id}/logs/log_search/search.get.parameters[].description
The boolean to decide whether to save the query in history

# paths./v1/orgs/{org_id}/logs/log_search/search.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/logs/log_search/search.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/logs/log_search/search.get.summary
Returns time series log data for given query

# paths./v1/orgs/{org_id}/logs/log_search/stream.get.description
Streams log search results with per-row progress updates

# paths./v1/orgs/{org_id}/logs/log_search/stream.get.parameters[].description
Lookback period in golang duration format. e.g. '1h'

# paths./v1/orgs/{org_id}/logs/log_search/stream.get.parameters[].description
Cursor from previous response for pagination

# paths./v1/orgs/{org_id}/logs/log_search/stream.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/logs/log_search/stream.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/logs/log_search/stream.get.summary
Streams log search results with per-row progress updates

# paths./v1/orgs/{org_id}/logs/log_search/table_schema.get.description
Returns SHOW CREATE TABLE output to show table schema

# paths./v1/orgs/{org_id}/logs/log_search/table_schema.get.parameters[].description
Table suffix (e.g., samp_100, samp_1000, agg_5m, agg_1h). Empty for base table.

# paths./v1/orgs/{org_id}/logs/log_search/table_schema.get.parameters[].description
Table scope: log or audit. Defaults to log.

# paths./v1/orgs/{org_id}/logs/log_search/table_schema.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/logs/log_search/table_schema.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/logs/log_search/table_schema.get.summary
Returns SHOW CREATE TABLE output to show table schema

# paths./v1/orgs/{org_id}/lookup_tables.post.description
Creates a Lookup Table metadata and stores its data for the given org and id.

# paths./v1/orgs/{org_id}/lookup_tables.post.parameters[].description
Whether or not this lookup table is being created for ED packs

# paths./v1/orgs/{org_id}/lookup_tables.post.parameters[].description
Time the lookup table was created. Only used by packs

# paths./v1/orgs/{org_id}/lookup_tables.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/lookup_tables.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/lookup_tables.post.summary
Creates a Lookup Table metadata and stores its data for the given org and id

# paths./v1/orgs/{org_id}/lookup_tables/metadata.get.description
Returns metadata of all of the Lookup Tables for the given org.

# paths./v1/orgs/{org_id}/lookup_tables/metadata.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/lookup_tables/metadata.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/lookup_tables/metadata.get.summary
Returns metadata of all of the Lookup Tables for the given org

# paths./v1/orgs/{org_id}/lookup_tables/{id}.get.description
Returns data for the specific Lookup Table.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.get.summary
Returns data for the specific Lookup Table

# paths./v1/orgs/{org_id}/lookup_tables/{id}.put.description
Updates data and/or metadata of a Lookup Table for the given org and id.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.put.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.put.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.put.summary
Updates data and/or metadata of a Lookup Table for the given org and id

# paths./v1/orgs/{org_id}/lookup_tables/{id}.delete.description
Deletes the Lookup Table for the given org and id.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.delete.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.delete.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/lookup_tables/{id}.delete.summary
Deletes the Lookup Table for the given org and id

# paths./v1/orgs/{org_id}/lookup_tables/{id}/metadata.get.description
Returns metadata of the Lookup Tables for the given org and id.

# paths./v1/orgs/{org_id}/lookup_tables/{id}/metadata.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/lookup_tables/{id}/metadata.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/lookup_tables/{id}/metadata.get.summary
Returns metadata of the Lookup Tables for the given org and id

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.description
Returns metrics with common time series response for the given query.

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.parameters[].description
Edge Delta Common Query Language expression

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.parameters[].description
Lookback period in golang duration format. e.g. '1h'. Either provide from/to or provide lookback/to or just lookback

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.parameters[].description
If order_by is specified then metrics are sorted by given field. If no sort is given default sort will be asc

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.parameters[].description
Default is no sorting. If sort is specified then metrics are sorted by their value. Possible values: asc, desc

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.parameters[].description
Limits the number of logs in the response. Default has no limit.

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.parameters[].description
Time range adjustment it can be noop, inclusive or exclusive

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.parameters[].description
The boolean to decide whether to save the query in history

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/metrics_v2/graph.get.summary
Returns metrics with common time series response for the given query

# paths./v1/orgs/{org_id}/pipelines/base.post.description
Creates a Pipeline with base configuration according to environment and fleet subtype

# paths./v1/orgs/{org_id}/pipelines/base.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/pipelines/base.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/pipelines/base.post.summary
Creates a Pipeline with base configuration according to environment and fleet subtype

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/add_source.post.description
Adds the given source node configuration to the pipeline and connect it to Edgedelta Destination. Saves the updated pipeline configuration without deploying changes.
Example request body for file_input node:
{
"node": {
"name": "my_file_input",
"type": "file_input",
"path": "path/to/my_logs/logs.txt",
"separate_source": true,
"description": "A user-defined description of the Node. Users may add any additional comments describing the function of their node.\nThis is useful to put some notes into the config file since YAML comment lines (\"#\") are not persisted due to automated marshal/unmarshal of YAML. It should be human readable and not too long."
}
}
Example request body for kubernetes_input node:
{
"node": {
"name": "my_k8s_input",
"type": "kubernetes_input",
"include": [
"k8s.pod.name=^apache.*$,k8s.namespace.name=.*web*"
],
"exclude": [
"k8s.namespace.name=^kube-nginx$",
"k8s.pod.name=.*nginx*,k8s.container.name=testing"
],
"auto_detect_line_pattern": true,
"boost_stacktrace_detection": true,
"enable_persisting_cursor": true,
"description": "A user-defined description of the Node. Users may add any additional comments describing the function of their node.\nThis is useful to put some notes into the config file since YAML comment lines (\"#\") are not persisted due to automated marshal/unmarshal of YAML. It should be human readable and not too long."
}
}
Example request body for demo_input node:
{
"node": {
"name": "my_demo_input",
"type": "demo_input",
"events_per_sec": 1,
"log_type": "apache_common",
"description": "A user-defined description of the Node. Users may add any additional comments describing the function of their node.\nThis is useful to put some notes into the config file since YAML comment lines (\"#\") are not persisted due to automated marshal/unmarshal of YAML. It should be human readable and not too long."
}
}

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/add_source.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/add_source.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/add_source.post.summary
Adds the given source node configuration to the pipeline and connect it to Edgedelta Destination

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/deploy/{version}.post.description
Deploys the pipeline configuration. Version is the timestamp of the Pipeline history. Pipeline history should be called to get the version.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/deploy/{version}.post.parameters[].description
Version use lastUpdated field from pipeline in milliseconds timestamp format. Example: 1752190141312. This is the timestamp field of the most recent element in the result of pipeline history. So, pipeline_history should be called before this tool to get the latest version of the pipeline.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/deploy/{version}.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/deploy/{version}.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/history.get.description
Returns the history of a Pipeline configuration. Timestamp of the Pipeline history is used as version when deploying the Pipeline.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/history.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/history.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/history.get.summary
Returns the history of a Pipeline configuration

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/save.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/pipelines/{conf_id}/save.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration.get.description
Returns list of rehydrations based on given filters

# paths./v1/orgs/{org_id}/rehydration.get.parameters[].description
If rehydration_id is given only matching item is returned in the response

# paths./v1/orgs/{org_id}/rehydration.get.parameters[].description
Lookback period in golang duration format. e.g. '1h'. Either provide from/to or provide lookback/to or just lookback

# paths./v1/orgs/{org_id}/rehydration.get.parameters[].description
Host filter. Not filtered by host if not provided

# paths./v1/orgs/{org_id}/rehydration.get.parameters[].description
Tag filter. Not filtered by tag if not provided

# paths./v1/orgs/{org_id}/rehydration.get.parameters[].description
Source type filter. e.g. 'File', 'Docker'. Not filtered by source type if not provided

# paths./v1/orgs/{org_id}/rehydration.get.parameters[].description
Cluster ID filter. Not filtered by cluster id if not provided

# paths./v1/orgs/{org_id}/rehydration.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration.get.summary
Returns list of rehydrations based on given filters

# paths./v1/orgs/{org_id}/rehydration.post.description
Creates a new rehydration item in dynamo and invokes async rehydration handler

# paths./v1/orgs/{org_id}/rehydration.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration.post.summary
Creates a new rehydration item in dynamo and invokes async rehydration handler

# paths./v1/orgs/{org_id}/rehydration/overlap.post.description
Returns existing rehydrations overlapping with given rehydration object

# paths./v1/orgs/{org_id}/rehydration/overlap.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration/overlap.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration/overlap.post.summary
Returns existing rehydrations overlapping with given rehydration object

# paths./v1/orgs/{org_id}/rehydration/rehydration_batch.post.description
Creates new rehydration items in dynamo and invokes async rehydration handler

# paths./v1/orgs/{org_id}/rehydration/rehydration_batch.post.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration/rehydration_batch.post.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration/rehydration_batch.post.summary
Creates new rehydration items in dynamo and invokes async rehydration handler

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.put.description
A rehydration object can only be updated to CANCELLED state, otherwise it's immutable

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.put.requestBody.description
Rehydration objects are immutable except the status can be changed to CANCELLED

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.put.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.put.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.put.summary
A rehydration object can only be updated to CANCELLED state, otherwise it's immutable

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.delete.description
First cancels the rehydration if it's running and marks for deletion

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.delete.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.delete.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration/{rehydration_id}.delete.summary
First cancels the rehydration if it's running and marks for deletion

# paths./v1/orgs/{org_id}/rehydration_v2.get.description
Returns list of rehydrations based on given filters

# paths./v1/orgs/{org_id}/rehydration_v2.get.parameters[].description
Lookback period in golang duration format. e.g. '1h'. Either provide from/to or provide lookback/to or just lookback

# paths./v1/orgs/{org_id}/rehydration_v2.get.parameters[].description
Cluster ID filter. Not filtered by cluster id if not provided

# paths./v1/orgs/{org_id}/rehydration_v2.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/rehydration_v2.get.responses.404.description
Not found. The requested resource does not exist.

# paths./v1/orgs/{org_id}/rehydration_v2.get.summary
Returns list of rehydrations based on given filters

# paths./v1/orgs/{org_id}/users.get.parameters[].description
If set to true response includes external state information from okta

# paths./v1/orgs/{org_id}/users.get.responses.401.description
Unauthorized. The API token is missing or invalid.

# paths./v1/orgs/{org_id}/users.get.responses.404.description
Not found. The requested resource does not exist.

# components.schemas.admin.PublicAIStats.properties.investigation_hours.description
InvestigationHours is the cumulative AI investigation time over every
issue currently tracked (the issues table keeps 180 days).

# components.schemas.admin.PublicEventStats.properties.per_second_avg.description
PerSecondAverage is Processed24H spread over 24h.

# components.schemas.admin.PublicEventStats.properties.processed_24h.description
Processed24H is the item count of the most recent COMPLETE UTC day.
Today's still-filling bucket is excluded so the value never collapses
near midnight or shrinks while the day accumulates.

# components.schemas.admin.PublicEventStats.properties.processed_30d.description
Processed30D sums the 30 most recent complete UTC days.

# components.schemas.configv3.AuthorizationClientCredentials.properties.client_secret.description
#nosec G117 -- OAuth2 client secret in config

# components.schemas.configv3.BodyMapping.properties.enabled.description
Enabled controls whether to send only the mapped path (true) or entire OTEL item (false) as body.

# components.schemas.configv3.BodyMapping.properties.path.description
Path is the OTTL expression to extract as body. Default: "body".

# components.schemas.configv3.Config.properties.last_updated.description
internal fields. these are not part of config yaml but internally populated and used

# components.schemas.configv3.DimGroup.properties.dimensions_as_attributes.description
DEPRECATED: It is always assumed as true, changing the value will result in no-op. Left for backwards compatibility reasons

# components.schemas.configv3.EDLogs.properties.secure_logging.description
If enabled, some of the sensitive information will be redacted (can affect performance of agent)

# components.schemas.configv3.FieldMapping.properties.enabled.description
Enabled controls whether this field mapping is active.

# components.schemas.configv3.FieldMapping.properties.keep_in_item.description
KeepInItem controls whether to keep the field in item data after extraction.

# components.schemas.configv3.FieldMapping.properties.path.description
Path is the OTTL expression to extract value from OTEL item.
Example: 'attributes["ed.gcl.name"]', 'resource["host.name"]', "severity_text"

# components.schemas.configv3.HTTPPaginationConfig.properties.error_strategy.description
ErrorStrategy defines how to handle failures: continue, stop

# components.schemas.configv3.HTTPPaginationConfig.properties.follow_link_header.description
FollowLinkHeader enables following URLs from Link header (RFC 5988)

# components.schemas.configv3.HTTPPaginationConfig.properties.inherit_auth.description
InheritAuth indicates whether to use same authentication for followed URLs

# components.schemas.configv3.HTTPPaginationConfig.properties.inherit_headers.description
NEW: Header inheritance configuration
InheritHeaders specifies which headers to inherit in pagination requests

# components.schemas.configv3.HTTPPaginationConfig.properties.inherit_headers_allowed_hosts.description
AllowedHosts lists additional hosts allowed for cross-origin header inheritance

# components.schemas.configv3.HTTPPaginationConfig.properties.inherit_headers_same_origin.description
SameOriginOnly enforces same-origin policy for header inheritance (default: true)

# components.schemas.configv3.HTTPPaginationConfig.properties.link_relation.description
LinkRelation specifies which link relation to follow (default: "next")

# components.schemas.configv3.HTTPPaginationConfig.properties.max_parallel.description
MaxParallel is the maximum number of concurrent URL fetches

# components.schemas.configv3.HTTPPaginationConfig.properties.response_format.description
ResponseFormat specifies how to parse followed URL responses: json, text, binary
This is distinct from HTTP Content-Type header and controls processing behavior

# components.schemas.configv3.HTTPPaginationConfig.properties.url_json_path.description
URLJSONPath is a JSONPath expression to extract URLs from JSON response body

# components.schemas.configv3.HTTPWorkflowIterator.properties.continue_on_error.description
ContinueOnError determines whether to continue if one iteration fails

# components.schemas.configv3.HTTPWorkflowIterator.properties.source.description
Source is the OTTL expression returning the collection to iterate over

# components.schemas.configv3.HTTPWorkflowIterator.properties.variable_name.description
VariableName is the name of the current item variable in each iteration

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.address.description
Redis connection settings
Address is the Redis server address (e.g., "localhost:6379" or "redis://localhost:6379")

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.ca_cert_path.description
CACertPath is the path to CA certificate for TLS

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.cert_path.description
CertPath is the path to client certificate for mTLS

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.check_before_request.description
CheckBeforeRequest indicates whether to check cache before making HTTP request

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.deployment_type.description
DeploymentType: Standalone, Cluster, or Sentinel

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.key_expression.description
Caching behavior settings
KeyExpression is the OTTL expression to compute the cache key

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.key_path.description
KeyPath is the path to client key for mTLS

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.populate_on_success.description
PopulateOnSuccess indicates whether to store response in cache after successful HTTP request

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.sentinel_master_name.description
SentinelMasterName is the master name when using Sentinel mode

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.skip_remaining_on_hit.description
SkipRemainingOnHit indicates whether to skip remaining steps on cache hit

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.username.description
Username for Redis ACL authentication (Redis 6.0+)

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.validate_certs.description
ValidateCerts enables TLS certificate validation

# components.schemas.configv3.HTTPWorkflowRedisCache.properties.value_expression.description
ValueExpression is an OTTL expression for the value to store in Redis.
If set, this value is stored instead of the HTTP response body.
For Redis-only SET steps (no endpoint), this is required.

# components.schemas.configv3.HTTPWorkflowStep.properties.endpoint_expression.description
EndpointExpression is an OTTL expression to dynamically compute the endpoint

# components.schemas.configv3.HTTPWorkflowStep.properties.header_expressions.description
HeaderExpressions are OTTL expressions for dynamic headers

# components.schemas.configv3.HTTPWorkflowStep.properties.headers.description
Headers are static headers to send with the request

# components.schemas.configv3.HTTPWorkflowStep.properties.is_last_step.description
IsLastStep marks this as a terminal step that can use pagination/iterator

# components.schemas.configv3.HTTPWorkflowStep.properties.iterator.description
Iterator enables fan-out execution over a collection

# components.schemas.configv3.HTTPWorkflowStep.properties.method.description
Method is the HTTP method (GET, POST, etc.)

# components.schemas.configv3.HTTPWorkflowStep.properties.pagination.description
Pagination enables automatic pagination through paginated API responses

# components.schemas.configv3.HTTPWorkflowStep.properties.parameter_expressions.description
ParameterExpressions are OTTL expressions for dynamic parameters

# components.schemas.configv3.HTTPWorkflowStep.properties.request_body_expression.description
RequestBodyExpression is an OTTL expression for dynamic request body

# components.schemas.configv3.HTTPWorkflowStep.properties.request_timeout.description
RequestTimeout is the timeout for this individual step

# components.schemas.configv3.HTTPWorkflowStep.properties.retry_http_code.description
RetryHTTPCode lists HTTP status codes that should trigger a retry

# components.schemas.configv3.HTTPWorkflowStep.properties.run_condition.description
RunCondition is an OTTL expression that must evaluate to true for this step to run

# components.schemas.configv3.HTTPWorkflowStep.properties.tls.description
TLSConfig defines TLS configuration for this step

# components.schemas.configv3.HTTPWorkflowWebhook.properties.allowed_methods.description
AllowedMethods lists HTTP methods this webhook accepts (default: POST)

# components.schemas.configv3.HTTPWorkflowWebhook.properties.api_key.description
APIKey is the key for API key authentication

# components.schemas.configv3.HTTPWorkflowWebhook.properties.api_key_header.description
APIKeyHeader is the header name for API key (default: X-API-Key)

# components.schemas.configv3.HTTPWorkflowWebhook.properties.auth_secret.description
Deprecated: use BearerToken or HMACSecret instead

# components.schemas.configv3.HTTPWorkflowWebhook.properties.auth_type.description
AuthType specifies the authentication method: none, bearer, api_key, hmac

# components.schemas.configv3.HTTPWorkflowWebhook.properties.bearer_token.description
BearerToken is the token for bearer authentication

# components.schemas.configv3.HTTPWorkflowWebhook.properties.hmac_header.description
HMACHeader is the header containing the HMAC signature (default: X-Webhook-Signature)

# components.schemas.configv3.HTTPWorkflowWebhook.properties.hmac_secret.description
HMACSecret is the secret for HMAC signature validation

# components.schemas.configv3.HTTPWorkflowWebhook.properties.method.description
Method is the HTTP method (default: POST)

# components.schemas.configv3.HTTPWorkflowWebhook.properties.path.description
Path is the URL path to listen on (e.g., "/webhook")

# components.schemas.configv3.HTTPWorkflowWebhook.properties.port.description
Port is the webhook server port (default: 8080)

# components.schemas.configv3.HTTPWorkflowWebhook.properties.rate_limit_enabled.description
RateLimitEnabled enables rate limiting for the webhook

# components.schemas.configv3.HTTPWorkflowWebhook.properties.rate_limit_max_per_min.description
RateLimitMaxPerMin is the maximum requests per minute when rate limiting is enabled

# components.schemas.configv3.InheritHeaders.properties.all.description
Inherit all headers (except blocked ones)

# components.schemas.configv3.InheritHeaders.properties.names.description
Specific header names to inherit (normalized/lowercased)

# components.schemas.configv3.InputDiscovery.properties.file_path.description
FilePath is used for globbing files for. For K8s, we will use this glob path
instead of well-known ones to handle non-stdout cases

# components.schemas.configv3.InputDiscovery.properties.parsing_pattern.description
ParsingPattern is used for extracting information out of literal file paths.
For K8s, it will be used for extracting pod UID (required) and container name (optional).

# components.schemas.configv3.InputRateLimit.properties.evaluation_policy.description
Policy defines how rate limiting will be evaluated

# components.schemas.configv3.InputRateLimitPolicy.properties.absolute_limit.description
AbsoluteLimit defines the absolute limit for certain policies, see pkg/ratelimiter/type.go

# components.schemas.configv3.InputRateLimitPolicy.properties.evaluation_mode.description
EvaluationMode defines how evaluation will be handled, such as if it is only going to be monitored or enforced

# components.schemas.configv3.InputRateLimitPolicy.properties.policy_type.description
PolicyType defines what kind of rate limiting policy will be pursued

# components.schemas.configv3.InputRateLimitPolicy.properties.refresh_interval.description
RefreshInterval defines when to refresh current value for certain policies, see pkg/ratelimiter/type.go

# components.schemas.configv3.InputRateLimitPolicy.properties.relative_limit.description
RelativeLimit defines the relative limit for certain policies, see pkg/ratelimiter/type.go

# components.schemas.configv3.InputRateLimitPolicy.properties.sub_policies.description
SubPolicies are used for composite (ie. depends on multiple policies) policy types such as "and" & "or"

# components.schemas.configv3.K8sCustomResourceConfig.properties.group.description
Group is the API group of the custom resource (e.g., "monitoring.coreos.com")

# components.schemas.configv3.K8sCustomResourceConfig.properties.resource.description
Resource is the plural resource name (e.g., "prometheusrules")

# components.schemas.configv3.K8sCustomResourceConfig.properties.version.description
Version is the API version of the custom resource (e.g., "v1")

# components.schemas.configv3.K8sEventRBACConfig.properties.custom_rules.description
CustomRules defines additional RBAC rules needed for custom resources

# components.schemas.configv3.K8sEventRBACRule.properties.api_groups.description
APIGroups is a list of API groups (e.g., ["monitoring.coreos.com"])

# components.schemas.configv3.K8sEventRBACRule.properties.resources.description
Resources is a list of resources (e.g., ["prometheusrules"])

# components.schemas.configv3.K8sEventRBACRule.properties.verbs.description
Verbs is a list of verbs (e.g., ["get", "list", "watch"])

# components.schemas.configv3.LiveTailSettings.properties.lower_threshold_size.description
Deprecated: These fields are retained for backward compatibility with existing configs.
They are parsed but ignored at runtime. Use ItemTruncationSize and ItemMaxBodySize instead.

# components.schemas.configv3.LoadReporting.properties.enable_oob_stream.description
EnableOOBStream registers the xds.service.orca.v3.OpenRcaService
OOB streaming server. Inline ORCA trailers on Export responses
are emitted regardless of this flag, since Envoy CSWRR consumes
only the inline path. Enable OOB only when a non-Envoy consumer
(e.g., grpc-go's weighted_round_robin, GCP CSM, grpcurl) needs to
subscribe to load reports.

# components.schemas.configv3.LoadReporting.properties.min_reporting_interval.description
MinReportingInterval is the lower bound for how often the gRPC OOB stream pushes a LoadReport.

# components.schemas.configv3.LoadReporting.properties.sample_interval.description
SampleInterval is the cadence at which the reporter resamples process CPU, memory, and buffer fullness.

# components.schemas.configv3.MetadataMapping.properties.labels.description
Labels mapping for user-defined labels. Path must resolve to map[string]any.

# components.schemas.configv3.MetadataMapping.properties.log_name.description
LogName mapping for GCL log name. When enabled, uses extracted value or falls back to node.LogName.

# components.schemas.configv3.MetadataMapping.properties.resource_labels.description
ResourceLabels mapping for GCL resource labels. Path must resolve to map[string]any.

# components.schemas.configv3.MetadataMapping.properties.resource_type.description
ResourceType mapping for GCL resource type. When enabled, uses extracted value or defaults to "logging_log".

# components.schemas.configv3.MetadataMapping.properties.severity.description
Severity mapping for log severity level (INFO, WARN, ERROR, etc.).

# components.schemas.configv3.MetadataMapping.properties.span_id.description
SpanID mapping for span ID within trace.

# components.schemas.configv3.MetadataMapping.properties.trace_id.description
TraceID mapping for distributed trace ID.

# components.schemas.configv3.MetricConfig.properties.aggregation.description
Aggregation is required for "sum" and can be cumulative or delta

# components.schemas.configv3.MetricConfig.properties.description.description
Description is optional and describes what this metric represents

# components.schemas.configv3.MetricConfig.properties.metric_type.description
Type is required and can be either "gauge" or "sum".

# components.schemas.configv3.MetricConfig.properties.monotonic.description
Monotonic is required for "sum" and can be true or false

# components.schemas.configv3.MetricConfig.properties.name.description
Name is the name of the metric as it will be reported in the OpenTelemetry Collector.
It is required and must be unique across all metrics.

# components.schemas.configv3.MetricConfig.properties.scalar_oids.description
Either ScalarOIDs or ColumnOIDs is required.
ScalarOIDs is used if one or more scalar OID values is used for this metric.
ColumnOIDs is used if one or more column OID indexed set of values is used for this metric.

# components.schemas.configv3.MetricConfig.properties.value_type.description
ValueType is required and can be either int or double

# components.schemas.configv3.Node.properties.alert_as_log.description
Alert as log is used to send alerts as log instead of events by default for some destinations

# components.schemas.configv3.Node.properties.allowed_origins.description
Browser origins allowed to use an HTTP ingestion node's token, e.g. https://*.acme.com. Empty means no restriction.

# components.schemas.configv3.Node.properties.auth_password.description
AuthPassword is the authentication password used for this SNMP connection.
Only valid for version "v3" and if "no_auth_no_priv" is not selected for SecurityLevel

# components.schemas.configv3.Node.properties.auth_type.description
AuthType is the type of authentication protocol to use for this SNMP connection.
Only valid for version “v3” and if “no_auth_no_priv” is not selected for SecurityLevel
Valid options: “md5”, “sha”, “sha224”, “sha256”, “sha384”, “sha512”
Default: "md5"

# components.schemas.configv3.Node.properties.authentication.description
Since both inputs and outputs have these in common, this field is shared here

# components.schemas.configv3.Node.properties.authorization.description
Authorization is used by HTTP pull and HTTP output node

# components.schemas.configv3.Node.properties.auto_detect_line_pattern.description
For the next 3 bool, should these functionalities stay at the input level?

# components.schemas.configv3.Node.properties.body_mapping.description
BodyMapping controls what gets sent as the payload body to destination.
When enabled, only the mapped OTTL path is sent as body.
When disabled, entire OTEL item is sent as body.

# components.schemas.configv3.Node.properties.buffer_path.description
Persistent retry buffer related fields
DEPRECATED

# components.schemas.configv3.Node.properties.capture_group_masks.description
the mapping for capture groups such as "pw: ******" or "pw: ''" if removal without replacement desired. If 'Mask' is defined, this feature will be suppressed by it.

# components.schemas.configv3.Node.properties.cloud_id.description
Elasticsearch specific
cloudID or address url for endpoint

# components.schemas.configv3.Node.properties.collection_interval.description
CollectionInterval sets how frequently the scraper
should be called and used as the context timeout
to ensure that scrapers don't exceed the interval.

# components.schemas.configv3.Node.properties.community.description
Community is the SNMP community string to use.
Only valid for versions "v1" and "v2c"
Default: public

# components.schemas.configv3.Node.properties.connector_metadata.description
ConnectorMetadata is used by HTTP input node to denote cloud based HTTP connectors

# components.schemas.configv3.Node.properties.credentials_path.description
CredentialsPath is a path to a file containing credentials. In the case of GCL output, it is a service account credentials JSON file

# components.schemas.configv3.Node.properties.custom_resources.description
CustomResources configures custom CRDs to watch for events

# components.schemas.configv3.Node.properties.custom_tags.description
CustomTags are here for backwards compatibility reasons

# components.schemas.configv3.Node.properties.customer_id.description
Following fields are for Google SecOps (Chronicle) output node

# components.schemas.configv3.Node.properties.delimiter.description
Following fields apply to split with delimiter filter type
Delimiter is the specified delimiting character used to split a single log to multiple logs

# components.schemas.configv3.Node.properties.dimensions_as_attributes.description
DEPRECATED: It is always assumed as true, changing the value will result in no-op. Left for backwards compatibility reasons

# components.schemas.configv3.Node.properties.discovery.description
Discovery allows users to deviate from internal discovery logics via defining custom rules

# components.schemas.configv3.Node.properties.docker_mode.description
DockerMode expects file to be in Docker json log format and automatically extracts "log" fields.

# components.schemas.configv3.Node.properties.drop_limit.description
DropLimit is the size threshold above which individual items are dropped entirely.
Items larger than this limit are discarded. nil means no dropping.
When both limits are set, DropLimit must be >= TruncateLimit.

# components.schemas.configv3.Node.properties.emit_intermediate.description
EmitIntermediate controls whether to emit intermediate step results

# components.schemas.configv3.Node.properties.emit_transform.description
EmitTransform contains OTTL statements to transform the final emitted log.
Statements can access: body, attributes, steps["name"].body, variables["key"], webhook_payload["key"]

# components.schemas.configv3.Node.properties.enable_indexer_discovery.description
Splunk Load Balanced weighted destinations mode

# components.schemas.configv3.Node.properties.endpoint_expression.description
OTTL expression fields for dynamic values

# components.schemas.configv3.Node.properties.engine_id.description
EngineID is the unique identifier for the SNMP engine, used for Trap listener

# components.schemas.configv3.Node.properties.error_mode.description
ErrorMode controls error reporting behavior for parse processors.
Valid values: "silent" (default) - errors are silently ignored, "strict" - errors are logged and reported as metrics.
Applies to: parse_json_attributes, extract_json_field, grok, json_unroll, ottl_transform, route, route_ottl processors.

# components.schemas.configv3.Node.properties.expression_type.description
Currently only used by Route node, but it distinguishes CEL and OTTL for expression type

# components.schemas.configv3.Node.properties.failure_pattern.description
Since both filters and ratio has common field, this field is shared here
FailurePattern is the regex pattern which is used to determine whether the trace events should be considered failure

# components.schemas.configv3.Node.properties.fallback_value.description
Following fields apply to log level detector
FallbackValue is the default value set if log level is not found in the log using given pattern

# components.schemas.configv3.Node.properties.field_path.description
Following fields apply to extract-json-field filter type.
FieldPath specifies the json path (dot separated) to the field whose value will be extracted and rest of the json content will be discarded.

# components.schemas.configv3.Node.properties.global_timeout.description
GlobalTimeout is the maximum total time for the entire workflow execution

# components.schemas.configv3.Node.properties.headers.description
Headers are used by both HTTP input and output node

# components.schemas.configv3.Node.properties.index.description
Index field is co-used by Elastic and Splunk configuration

# components.schemas.configv3.Node.properties.initial_delay.description
InitialDelay sets the initial start delay for the scraper,
any non positive value is assumed to be immediately.

# components.schemas.configv3.Node.properties.json_field_path.description
JSONFieldPath is the path within the JSON that holds the list that needs to be json unrolled

# components.schemas.configv3.Node.properties.keep_log_if_failed.description
Following fields apply to log transformer JavaScript and enrichment using JavaScript
Starting from agent v0.1.51, filters that were using "required" field will use "keep_log_if_failed" instead. Default value of this field is false
Reason for change is that script-based filters and alike should fail fast and discard log so the issue could be caught earlier

# components.schemas.configv3.Node.properties.labels.description
Following fields are for any output node that support custom labeling
Currently used by Prometheus metrics exporter, Loki and GCL output node

# components.schemas.configv3.Node.properties.load_reporting.description
LoadReporting opts the OTLP ingest server into publishing per-server load metrics for resource-aware load balancing

# components.schemas.configv3.Node.properties.log_host.description
for some integrations it makes sense to just ask for target host name and
agent can form the full endpoint with given api key etc.

# components.schemas.configv3.Node.properties.log_name.description
Following fields are for GCL output node

# components.schemas.configv3.Node.properties.log_parsing_mode.description
LogParsingMode is used for pre-parsing inputs with certain encodings

# components.schemas.configv3.Node.properties.mask.description
Mask is the replacement string such as "******" or "" if removal without replacement desired.

# components.schemas.configv3.Node.properties.mask_captured.description
TODO: (VPB-440) Remove MaskCaptured field

		Deprecated @ 07-06-23 Use CaptureGroupMasks instead

		MaskCaptured is the mapping for capture groups such as "pw: ******" or "pw: ''" if removal without replacement desired. If 'Mask' is defined, this feature will be suppressed by it.

# components.schemas.configv3.Node.properties.max_connection_age.description
MaxConnectionAge caps the lifetime of a long-lived grpc connection

# components.schemas.configv3.Node.properties.max_connection_age_grace.description
MaxConnectionAgeGrace is the grace window after MaxConnectionAge before the grpc server forcibly closes the connection.

# components.schemas.configv3.Node.properties.max_token_count.description
MaxTokenCount is the number of tokens kept from each line for clustering.

# components.schemas.configv3.Node.properties.memory_buffer.description
MemoryBuffer configures the in-memory buffer queue settings.

# components.schemas.configv3.Node.properties.metadata_mapping.description
NEW: Generic mapping sections for destination nodes
MetadataMapping defines how to extract destination-specific metadata fields from OTEL items.
Each field can be enabled/disabled, mapped to an OTTL path, and configured to keep/delete from item.
Supported destinations: GCL (future: Splunk, CloudWatch, Datadog, etc.)

# components.schemas.configv3.Node.properties.metrics.description
Metrics defines what SNMP metrics will be collected for this receiver and is composed of metric
names along with their metric configurations

# components.schemas.configv3.Node.properties.multiline_flush_interval.description
MultilineFlushInterval, when set on a kubernetes_input, docker_input, or
file_input node, overrides the pipeline-level multiline_flush_interval for
that source. Useful when one input has a slower producer than the rest.

# components.schemas.configv3.Node.properties.namespace_expression.description
Following fields are for AWS Cloudwatch output node

# components.schemas.configv3.Node.properties.negate.description
Negate reverts the result of filter. Can be applied to regex, attribute and combination filter

# components.schemas.configv3.Node.properties.new_field_name.description
NewFieldName is currrently used for JSON unroll only. It is the name that the exploded array element will receive in each new event.
Leave empty to expand the array element with its original name.

# components.schemas.configv3.Node.properties.node_reference.description
NodeReference refers to an org-level destination. When this is set the destination details should be pulled from org-settings API.

# components.schemas.configv3.Node.properties.pattern.description
Since both filters and regex rules have pattern, this field is shared here

# components.schemas.configv3.Node.properties.pattern_field_path.description
Contains the location of the pattern to use
Used by Regex Filter and Grok

# components.schemas.configv3.Node.properties.predefined_pattern.description
Following fields apply to mask filter type
PredefinedPattern names such as "credit_card"

# components.schemas.configv3.Node.properties.privacy_password.description
PrivacyPassword is the authentication password used for this SNMP connection.
Only valid for version “v3” and if "auth_priv" is selected for SecurityLevel

# components.schemas.configv3.Node.properties.privacy_type.description
PrivacyType is the type of privacy protocol to use for this SNMP connection.
Only valid for version “v3” and if "auth_priv" is selected for SecurityLevel
Valid options: “des”, “aes”, “aes192”, “aes256”, “aes192c”, “aes256c”
Default: "des"

# components.schemas.configv3.Node.properties.process_field.description
ProcessField is a dot separated path to the field which is used to determine which field the log processor should use to get the log message from to process.
If this field is not provided, the default is item["body"].

# components.schemas.configv3.Node.properties.project_id.description
Following fields are for Google PubSub output node

# components.schemas.configv3.Node.properties.rate_limit.description
RateLimit allows users to define rate limiting policies

# components.schemas.configv3.Node.properties.rbac.description
RBAC configures custom RBAC rules needed to watch custom resources

# components.schemas.configv3.Node.properties.reader_header_timeout.description
Deprecated: fasthttp has no separate header timeout. ReadTimeout covers the entire request
(headers + body), which is a superset of ReadHeaderTimeout. This field is ignored.

# components.schemas.configv3.Node.properties.redis_address.description
Global Redis connection settings (shared across all steps that enable caching)
RedisAddress is the Redis server address (e.g., "localhost:6379" or "redis://localhost:6379")

# components.schemas.configv3.Node.properties.redis_ca_cert_path.description
RedisCACertPath is the path to CA certificate for TLS

# components.schemas.configv3.Node.properties.redis_cert_path.description
RedisCertPath is the path to client certificate for mTLS

# components.schemas.configv3.Node.properties.redis_key_path.description
RedisKeyPath is the path to client key for mTLS

# components.schemas.configv3.Node.properties.redis_sentinel_master.description
RedisSentinelMaster is the master name when using Sentinel mode

# components.schemas.configv3.Node.properties.redis_username.description
RedisUsername for Redis ACL authentication (Redis 6.0+)

# components.schemas.configv3.Node.properties.resource_fields.description
ResourceFields allows certain additional labels to be collected for associated source

# components.schemas.configv3.Node.properties.resource_labels_expression.description
ResourceLabelsExpression is a field path that will point to where to be sent labels can be found as a map

# components.schemas.configv3.Node.properties.resource_type_expression.description
ResourceTypeExpression is a CEL expression to fetch resource type from items dynamically

# components.schemas.configv3.Node.properties.resources_to_watch.description
ResourcesToWatch configures which built-in Kubernetes resource types to monitor for events
Keys are resource kind names (e.g., "CoreEvent", "HPA", "Deployment")
By default, CoreEvent and HPA are enabled

# components.schemas.configv3.Node.properties.retire_period.description
RetirePeriod is used in both log to pattern node and prometheus exporter output node

# components.schemas.configv3.Node.properties.s3_config.description
AWS service-specific configuration blocks (optional - override base AWS config)

# components.schemas.configv3.Node.properties.sample_field_path.description
SampleFieldPath points cluster samples at a field other than the patternized one.

# components.schemas.configv3.Node.properties.sampling.description
Sampling has value between 0.0 and 1.0, if not defined assumed as 1.0 and no sampling

# components.schemas.configv3.Node.properties.script.description
Since both filters and inputs have script, this field is shared here
Is the script content in JavaScript for filters
Is the exec script for exec input

# components.schemas.configv3.Node.properties.security_level.description
SecurityLevel is the security level to use for this SNMP connection.
Only valid for version “v3”
Valid options: “no_auth_no_priv”, “auth_no_priv”, “auth_priv”
Default: "no_auth_no_priv"

# components.schemas.configv3.Node.properties.send_as_json.description
Send as json is used to send data to Sumologic in JSON format instead

# components.schemas.configv3.Node.properties.shared_key.description
Other fields are shared with InputPort
Format can be any of these https://docs.fluentbit.io/manual/pipeline/outputs

# components.schemas.configv3.Node.properties.source_metadata.description
SourceMetadata allows users to filter out unwanted fields in resource and attribute maps

# components.schemas.configv3.Node.properties.steps.description
Steps defines the sequence of HTTP requests in the workflow

# components.schemas.configv3.Node.properties.timeout.description
Timeout is an optional value used to set scraper's context deadline.

# components.schemas.configv3.Node.properties.transport.description
Transport is for SNMP Trap and Syslog. Can be "udp" or "tcp"

# components.schemas.configv3.Node.properties.truncate_limit.description
TruncateLimit is the size threshold above which individual items are truncated.
Items larger than this limit but smaller than DropLimit are truncated to this size.
nil means no truncation.

# components.schemas.configv3.Node.properties.use_legacy_formatting.description
UseLegacyFormatting will be used for supporting agent v0 formats for outputs

# components.schemas.configv3.Node.properties.user_schema.description
User specified schema - userful for combination of deotelized data + encodings requiring fixed schema

# components.schemas.configv3.Node.properties.variables.description
Variables are global variables accessible to all steps (string values, use ParseJSON in OTTL for complex objects)

# components.schemas.configv3.Node.properties.version.description
Version is the version of SNMP to use for this connection.
Valid options: v1, v2c, v3.
Default: v2c

# components.schemas.configv3.Node.properties.webhook.description
Webhook configures webhook trigger for the workflow

# components.schemas.configv3.Node.properties.workflow_pull_interval.description
PullInterval is the interval between workflow executions (for scheduled pull mode)
Uses unique YAML tag to avoid conflict with InputHTTPPull which is also embedded inline in Node

# components.schemas.configv3.Node.properties.workflow_pull_schedule.description
PullSchedule is the cron expression for workflow execution (for scheduled pull mode)
Uses unique YAML tag to avoid conflict with InputHTTPPull which is also embedded inline in Node

# components.schemas.configv3.SASL.properties.mechanism.description
Supported SASL mechanism: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, GSSAPI

# components.schemas.configv3.SASL.properties.password.description
SASL authentication password (for PLAIN and SCRAM mechanisms)

# components.schemas.configv3.SASL.properties.username.description
SASL authentication username (for PLAIN and SCRAM mechanisms)

# components.schemas.configv3.SequenceProcessor.properties.capture_group_masks.description
the mapping for capture groups such as "pw: ******" or "pw: ''" if removal without replacement desired. If 'Mask' is defined, this feature will be suppressed by it.

# components.schemas.configv3.SequenceProcessor.properties.delimiter.description
Following fields apply to split with delimiter filter type
Delimiter is the specified delimiting character used to split a single log to multiple logs

# components.schemas.configv3.SequenceProcessor.properties.error_mode.description
ErrorMode controls error reporting behavior for parse processors.
Valid values: "silent" (default) - errors are silently ignored, "strict" - errors are logged and reported as metrics.
Applies to: parse_json_attributes, extract_json_field, grok, json_unroll, ottl_transform, route, route_ottl processors.

# components.schemas.configv3.SequenceProcessor.properties.fallback_value.description
Following fields apply to log level detector
FallbackValue is the default value set if log level is not found in the log using given pattern

# components.schemas.configv3.SequenceProcessor.properties.field_path.description
Following fields apply to extract-json-field filter type.
FieldPath specifies the json path (dot separated) to the field whose value will be extracted and rest of the json content will be discarded.

# components.schemas.configv3.SequenceProcessor.properties.json_field_path.description
JSONFieldPath is the path within the JSON that holds the list that needs to be json unrolled

# components.schemas.configv3.SequenceProcessor.properties.keep_log_if_failed.description
Following fields apply to log transformer JavaScript and enrichment using JavaScript
Starting from agent v0.1.51, filters that were using "required" field will use "keep_log_if_failed" instead. Default value of this field is false
Reason for change is that script-based filters and alike should fail fast and discard log so the issue could be caught earlier

# components.schemas.configv3.SequenceProcessor.properties.mask.description
Mask is the replacement string such as "******" or "" if removal without replacement desired.

# components.schemas.configv3.SequenceProcessor.properties.mask_captured.description
TODO: (VPB-440) Remove MaskCaptured field

		Deprecated @ 07-06-23 Use CaptureGroupMasks instead

		MaskCaptured is the mapping for capture groups such as "pw: ******" or "pw: ''" if removal without replacement desired. If 'Mask' is defined, this feature will be suppressed by it.

# components.schemas.configv3.SequenceProcessor.properties.max_token_count.description
MaxTokenCount is the number of tokens kept from each line for clustering.

# components.schemas.configv3.SequenceProcessor.properties.negate.description
Negate reverts the result of filter. Can be applied to regex, attribute and combination filter

# components.schemas.configv3.SequenceProcessor.properties.new_field_name.description
NewFieldName is currrently used for JSON unroll only. It is the name that the exploded array element will receive in each new event.
Leave empty to expand the array element with its original name.

# components.schemas.configv3.SequenceProcessor.properties.predefined_pattern.description
Following fields apply to mask filter type
PredefinedPattern names such as "credit_card"

# components.schemas.configv3.SequenceProcessor.properties.sample_field_path.description
SampleFieldPath points cluster samples at a field other than the patternized one.

# components.schemas.configv3.TLS.properties.ca_path.description
absolute path to scan CA certificate files

# components.schemas.configv3.TLS.properties.enabled.description
a flag for clients with TCP to enable TLS dialing

# components.schemas.configv3.TLS.properties.ignore_certificate_check.description
optional flag to ignore certificate check

# components.schemas.core.Access.properties.resource.description
E.g. "org:<uuid>" or "org:*" for support acccess permission

# components.schemas.core.BaseConfCreateRequest.properties.cluster_name.description
Pipelines with same cluster name will be grouped together

# components.schemas.core.BaseConfCreateRequest.properties.environment.description
Environment where the pipeline will be deployed

# components.schemas.core.BaseConfCreateRequest.properties.fleet_subtype.description
FleetSubtype is required when Environment is Kubernetes

# components.schemas.core.ClusterStat.properties.anomaly.description
DEPRECATED
AnomalyScore is the cluster's anomaly score

# components.schemas.core.ClusterStat.properties.delta.description
Delta is the percentage increase of this cluster's count compared to previous window.

# components.schemas.core.ClusterStat.properties.offset_counts.description
DEPRECATED
OffsetCounts is counts of cluster in previous offset windows.

# components.schemas.core.ClusterStat.properties.offset_deltas.description
DEPRECATED
OffsetDeltas is the percentage increase of this cluster's count compared to previous windows.

# components.schemas.core.ClusterStat.properties.offset_proportions.description
DEPRECATED
OffsetProportions is proportions of this cluster's count within all clusters counts in previous windows.

# components.schemas.core.ClusterStat.properties.past_count.description
DEPRECATED
PastCount is count of cluster in previous window.

# components.schemas.core.ClusterStat.properties.past_proportion.description
DEPRECATED
PastProportion is proportion of this cluster's count within all clusters counts in previous window.

# components.schemas.core.ClusterStat.properties.proportion.description
Proportion of this cluster to rest of the cluster. Rest of the cluster can be scoped to tag or source.

# components.schemas.core.Conf.properties.metadata.description
Stores status (updated/updates available/deleted) of compound nodes

# components.schemas.core.Conf.properties.retrieved.description
Latest retrieval time for installation. Will move to a separate table once obscured hostID for install host is implemented

# components.schemas.core.ConfCompoundNodesMetadata.properties.deleted.description
IDs of compound nodes that have been deleted

# components.schemas.core.ConfCompoundNodesMetadata.properties.updated.description
IDs of compound nodes updated to latest version

# components.schemas.core.ConfCompoundNodesMetadata.properties.updates_available.description
IDs of compound nodes that have updates available

# components.schemas.core.ConfCreateRequest.properties.cluster_name.description
Pipelines with same cluster name will be grouped together

# components.schemas.core.ConfCreateRequest.properties.environment.description
Environment where the pipeline will be deployed

# components.schemas.core.ConfCreateRequest.properties.fleet_subtype.description
FleetSubtype is required when Environment is Kubernetes

# components.schemas.core.ConfCreateResponse.properties.metadata.description
Stores status (updated/updates available/deleted) of compound nodes

# components.schemas.core.ConfCreateResponse.properties.retrieved.description
Latest retrieval time for installation. Will move to a separate table once obscured hostID for install host is implemented

# components.schemas.core.HostedAgentEnv.properties.cloud.description
Cloud is the cloud provider name. By default it's AWS

# components.schemas.core.HostedAgentEnv.properties.created.description
Created & Updated are timestamps in core.StorageTimeFormat

# components.schemas.core.HostedAgentEnv.properties.enabled_endpoints.description
EnabledEndpoints is a user supplied list of endpoints desired with respect to type

# components.schemas.core.HostedAgentEnv.properties.endpoints.description
Endpoints is map of URLs that can be used for accessing agent

# components.schemas.core.HostedAgentEnv.properties.has_auto_gen_config.description
HasAutoGenConfig indicates this env has auto generated config (Generate one for me at the UI)

# components.schemas.core.HostedAgentEnv.properties.has_https_endpoint.description
DEPRECATED
HasHTTPSEndpoint indicates this env has an HTTPS endpoint.

# components.schemas.core.HostedAgentEnv.properties.https_endpoint.description
DEPRECATED
HTTPSEndpoint is the URL of the HTTPS endpoint if provisioned.
It's format is https://{region}.{cloud}.ingress.edgedelta.com/listen/{env_id}

# components.schemas.core.HostedAgentEnv.properties.is_suspended.description
IsSuspended indicates agents should scale down to zero or not

# components.schemas.core.HostedAgentEnv.properties.purpose.description
Purpose denotes the reason for creating this cloud fleet

# components.schemas.core.HostedAgentEnv.properties.region.description
Region in the cloud provider. By default it's us-west2.
We have to pre-provision hosted clusters in multiple regions so not all regions are applicable.

# components.schemas.core.HostedAgentEnv.properties.state.description
Last successful create resource step for this env to prevent duplicate resource creation
Default is StartState

# components.schemas.core.OperationStatus.x-enum-comments.Skipped
used for operations that are skipped due to already being claimed by other clusters

# components.schemas.core.OperationStatus.x-enum-descriptions[]
used for operations that are skipped due to already being claimed by other clusters

# components.schemas.core.Rehydration.properties.archive_flush_interval.description
Archive Flush Interval is the flush interval for the agent with this tag,
this helps us calculate which files overflowed into the next s3 bucket due to flush latency

# components.schemas.core.Rehydration.properties.archive_source.description
ArchiveSource is the minimal archive reference for the source config
Used instead of legacy Source integration name and bucket

# components.schemas.core.Rehydration.properties.assigned_cluster.description
AssignedCluster is the cluster that this rehydration is assigned to
This is used to route the retries of the rehydration to the correct cluster
and preventing multiple clusters from processing the same rehydration

# components.schemas.core.Rehydration.properties.checkpoint.description
Checkpoint is the last object key the rehydration job processed. Shouldn't be shown to user

# components.schemas.core.Rehydration.properties.checkpoint_v2.description
CheckpointV2 saves pending files instead of processed ones.
It also differs structurally so they are not compatible with Checkpoint field.
Used in the rehydration with queue and parallel workers.
Shouldn't be shown to user

# components.schemas.core.Rehydration.properties.created.description
Created & Updated are timestamps in core.StorageTimeFormat

# components.schemas.core.Rehydration.properties.exclude_overlap.description
ExcludeOverlap exclude logs rehydrated by existing rehydrations

# components.schemas.core.Rehydration.properties.facets.description
Facets are used to filter rehydrations with facet_options api

# components.schemas.core.Rehydration.properties.from.description
From & To are timestamps in core.URLTimeFormat

# components.schemas.core.Rehydration.properties.metrics.description
Metrics is the new metrics object that contains all the metrics
collected during the rehydration process
Some of the information here is also persisted to ProcessStats to protect UI behaviour

# components.schemas.core.Rehydration.properties.percentage.description
Percentage is duplicated here for org level rehydrations, omitted in individual rehydrations
because RehydrationWithStatus is used instead

# components.schemas.core.Rehydration.properties.prefix_filter.description
Prefix and prefix regex are used to filter rehydrations with prefix filter

# components.schemas.core.Rehydration.properties.process_stats.description
ProcessStats is the overall process stats of the rehydration process

# components.schemas.core.SelfAccessWithProfile.properties.login.description
DEPRECATED on 10-12-22.  Use Email instead.

# components.schemas.core.SelfAccessWithProfile.properties.resource.description
E.g. "org:<uuid>" or "org:*" for support acccess permission

# components.schemas.core.SelfAccessWithProfile.properties.secondEmail.description
DEPRECATED on 10-12-22.  Use Email instead.

# components.schemas.core.TLS.properties.ca_path.description
absolute path to scan CA certificate files

# components.schemas.core.Template.properties.configVersion.description
The version of the underlying config YAML

# components.schemas.dashboard.Screenshot.properties.full_light_url.description
FullLightURL and FullDarkURL hold renders that are not card previews: a full-page
PNG or a PDF export. They are kept apart from the pair above because the list
scales the preview into a 120px card, where a full-page capture is an unreadable
sliver — so exporting must not replace what the list shows.

# components.schemas.dashboard.Screenshot.properties.light_url.description
LightURL and DarkURL are the card preview the dashboard list shows. They always
hold a viewport-sized PNG.

# components.schemas.dashboard.Screenshot.properties.reported_error.description
ReportedError is set when the dashboard rendered into its error state. The images
are still produced and Status is still ok — this says what they show.

# components.schemas.nodetype.NodeType.x-enum-comments.InputHTTPWorkflowNodeType
#nosec G101 -- node type identifier, not a credential

# components.schemas.nodetype.NodeType.x-enum-comments.OutputEDLogType
ed_logs_output is renamed from ed_archive_output. ed_archive_output is kept for backward compatibility.

# components.schemas.nodetype.NodeType.x-enum-descriptions[]
#nosec G101 -- node type identifier, not a credential

# components.schemas.nodetype.NodeType.x-enum-descriptions[]
ed_logs_output is renamed from ed_archive_output. ed_archive_output is kept for backward compatibility.

# components.schemas.pipeline.AddSourceRequest.properties.node.description
Configuration of the source node to be added

# components.schemas.pipeline.GetVisualPipelineResponse.properties.pipelineNodes.description
Deprecated: 6-2-23 This field will be removed in a future release.  Please use Pipeline.Nodes instead

# components.schemas.pipeline.Node.properties.auth_password.description
AuthPassword is the authentication password used for this SNMP connection.
Only valid for version "v3" and if "no_auth_no_priv" is not selected for SecurityLevel

# components.schemas.pipeline.Node.properties.auth_type.description
AuthType is the type of authentication protocol to use for this SNMP connection.
Only valid for version “v3” and if “no_auth_no_priv” is not selected for SecurityLevel
Valid options: “md5”, “sha”, “sha224”, “sha256”, “sha384”, “sha512”
Default: "md5"

# components.schemas.pipeline.Node.properties.auto_detect_line_pattern.description
For the next 3 bool, should these functionalities stay at the input level?

# components.schemas.pipeline.Node.properties.collection_interval.description
CollectionInterval sets how frequently the scraper
should be called and used as the context timeout
to ensure that scrapers don't exceed the interval.

# components.schemas.pipeline.Node.properties.community.description
Community is the SNMP community string to use.
Only valid for versions "v1" and "v2c"
Default: public

# components.schemas.pipeline.Node.properties.connector_metadata.description
ConnectorMetadata is used by HTTP input node to denote cloud based HTTP connectors

# components.schemas.pipeline.Node.properties.custom_resources.description
CustomResources configures custom CRDs to watch for events

# components.schemas.pipeline.Node.properties.discovery.description
Discovery allows users to deviate from internal discovery logics via defining custom rules

# components.schemas.pipeline.Node.properties.docker_mode.description
DockerMode expects file to be in Docker json log format and automatically extracts "log" fields.

# components.schemas.pipeline.Node.properties.drop_limit.description
DropLimit is the size threshold above which individual items are dropped entirely.
Items larger than this limit are discarded. nil means no dropping.
When both limits are set, DropLimit must be >= TruncateLimit.

# components.schemas.pipeline.Node.properties.emit_intermediate.description
EmitIntermediate controls whether to emit intermediate step results

# components.schemas.pipeline.Node.properties.emit_transform.description
EmitTransform contains OTTL statements to transform the final emitted log.
Statements can access: body, attributes, steps["name"].body, variables["key"], webhook_payload["key"]

# components.schemas.pipeline.Node.properties.endpoint_expression.description
OTTL expression fields for dynamic values

# components.schemas.pipeline.Node.properties.engine_id.description
EngineID is the unique identifier for the SNMP engine, used for Trap listener

# components.schemas.pipeline.Node.properties.global_timeout.description
GlobalTimeout is the maximum total time for the entire workflow execution

# components.schemas.pipeline.Node.properties.initial_delay.description
InitialDelay sets the initial start delay for the scraper,
any non positive value is assumed to be immediately.

# components.schemas.pipeline.Node.properties.load_reporting.description
LoadReporting opts the OTLP ingest server into publishing per-server load metrics for resource-aware load balancing

# components.schemas.pipeline.Node.properties.log_parsing_mode.description
LogParsingMode is used for pre-parsing inputs with certain encodings

# components.schemas.pipeline.Node.properties.max_connection_age_grace.description
MaxConnectionAgeGrace is the grace window after MaxConnectionAge before the grpc server forcibly closes the connection.

# components.schemas.pipeline.Node.properties.metrics.description
Metrics defines what SNMP metrics will be collected for this receiver and is composed of metric
names along with their metric configurations

# components.schemas.pipeline.Node.properties.multiline_flush_interval.description
MultilineFlushInterval, when set on a kubernetes_input, docker_input, or
file_input node, overrides the pipeline-level multiline_flush_interval for
that source. Useful when one input has a slower producer than the rest.

# components.schemas.pipeline.Node.properties.privacy_password.description
PrivacyPassword is the authentication password used for this SNMP connection.
Only valid for version “v3” and if "auth_priv" is selected for SecurityLevel

# components.schemas.pipeline.Node.properties.privacy_type.description
PrivacyType is the type of privacy protocol to use for this SNMP connection.
Only valid for version “v3” and if "auth_priv" is selected for SecurityLevel
Valid options: “des”, “aes”, “aes192”, “aes256”, “aes192c”, “aes256c”
Default: "des"

# components.schemas.pipeline.Node.properties.rate_limit.description
RateLimit allows users to define rate limiting policies

# components.schemas.pipeline.Node.properties.rbac.description
RBAC configures custom RBAC rules needed to watch custom resources

# components.schemas.pipeline.Node.properties.reader_header_timeout.description
Deprecated: fasthttp has no separate header timeout. ReadTimeout covers the entire request
(headers + body), which is a superset of ReadHeaderTimeout. This field is ignored.

# components.schemas.pipeline.Node.properties.redis_address.description
Global Redis connection settings (shared across all steps that enable caching)
RedisAddress is the Redis server address (e.g., "localhost:6379" or "redis://localhost:6379")

# components.schemas.pipeline.Node.properties.redis_ca_cert_path.description
RedisCACertPath is the path to CA certificate for TLS

# components.schemas.pipeline.Node.properties.redis_cert_path.description
RedisCertPath is the path to client certificate for mTLS

# components.schemas.pipeline.Node.properties.redis_key_path.description
RedisKeyPath is the path to client key for mTLS

# components.schemas.pipeline.Node.properties.redis_sentinel_master.description
RedisSentinelMaster is the master name when using Sentinel mode

# components.schemas.pipeline.Node.properties.redis_username.description
RedisUsername for Redis ACL authentication (Redis 6.0+)

# components.schemas.pipeline.Node.properties.resource_fields.description
ResourceFields allows certain additional labels to be collected for associated source

# components.schemas.pipeline.Node.properties.resources_to_watch.description
ResourcesToWatch configures which built-in Kubernetes resource types to monitor for events
Keys are resource kind names (e.g., "CoreEvent", "HPA", "Deployment")
By default, CoreEvent and HPA are enabled

# components.schemas.pipeline.Node.properties.sampling.description
Sampling has value between 0.0 and 1.0, if not defined assumed as 1.0 and no sampling

# components.schemas.pipeline.Node.properties.security_level.description
SecurityLevel is the security level to use for this SNMP connection.
Only valid for version “v3”
Valid options: “no_auth_no_priv”, “auth_no_priv”, “auth_priv”
Default: "no_auth_no_priv"

# components.schemas.pipeline.Node.properties.shared_key.description
Other fields are shared with InputPort
Format can be any of these https://docs.fluentbit.io/manual/pipeline/outputs

# components.schemas.pipeline.Node.properties.source_metadata.description
SourceMetadata allows users to filter out unwanted fields in resource and attribute maps

# components.schemas.pipeline.Node.properties.steps.description
Steps defines the sequence of HTTP requests in the workflow

# components.schemas.pipeline.Node.properties.timeout.description
Timeout is an optional value used to set scraper's context deadline.

# components.schemas.pipeline.Node.properties.truncate_limit.description
TruncateLimit is the size threshold above which individual items are truncated.
Items larger than this limit but smaller than DropLimit are truncated to this size.
nil means no truncation.

# components.schemas.pipeline.Node.properties.variables.description
Variables are global variables accessible to all steps (string values, use ParseJSON in OTTL for complex objects)

# components.schemas.pipeline.Node.properties.version.description
Version is the version of SNMP to use for this connection.
Valid options: v1, v2c, v3.
Default: v2c

# components.schemas.pipeline.Node.properties.webhook.description
Webhook configures webhook trigger for the workflow

# components.schemas.pipeline.Node.properties.workflow_pull_interval.description
PullInterval is the interval between workflow executions (for scheduled pull mode)
Uses unique YAML tag to avoid conflict with InputHTTPPull which is also embedded inline in Node

# components.schemas.pipeline.Node.properties.workflow_pull_schedule.description
PullSchedule is the cron expression for workflow execution (for scheduled pull mode)
Uses unique YAML tag to avoid conflict with InputHTTPPull which is also embedded inline in Node

# components.schemas.pipeline.PathOutput.properties.nodes.description
The name of the nodes to which the path outputs

# components.schemas.pipeline.PathOutput.properties.outputDisplayString.description
A user-readable display string characterizing the `OutputTypes` property

# components.schemas.pipeline.PathOutput.properties.outputTypes.description
The types of Outputs allowed (e.g. string, log, metric) for this path
For non-compound nodes, these would be the same as the OutputTypes of the node
For compound nodes, these would depend on the processor nodes connected to compound output node

# components.schemas.pipeline.PathOutput.properties.path.description
The name of the path. Default paths use an empty string.

# components.schemas.pipeline.Pipeline.properties.nodeTemplatesStatus.description
Status of node templates used in the pipeline

# components.schemas.pipeline.Pipeline.properties.tag.description
The human-readable identifier of the pipeline (unique within an Org)

# components.schemas.pipeline.Pipeline.properties.version.description
The version of the pipeline configuration

# components.schemas.pipeline.VisualizerNode.properties.atLeastOnce.description
AtLeastOnce is for some nodes that needs to be present always

# components.schemas.pipeline.VisualizerNode.properties.category.description
The Category of the PipelineNode (e.g. Input, Processor, Output)

# components.schemas.pipeline.VisualizerNode.properties.childNodes.description
Nested child nodes if this node is a compound node

# components.schemas.pipeline.VisualizerNode.properties.deprecatedNodeType.description
Deprecated node type to support backward compatibility

# components.schemas.pipeline.VisualizerNode.properties.extent.description
Required for positioning relative to parent node (extent: "parent")

# components.schemas.pipeline.VisualizerNode.properties.id.description
The unique identifier for this PipelineNode instance

# components.schemas.pipeline.VisualizerNode.properties.inputDisplayString.description
A user-readable display string characterizing the `InputTypes` property

# components.schemas.pipeline.VisualizerNode.properties.inputTypes.description
The types of Inputs allowed (e.g. string, log, metric)

# components.schemas.pipeline.VisualizerNode.properties.metadata.description
Metadata for storing UI-specific data like node position

# components.schemas.pipeline.VisualizerNode.properties.outputDisplayString.description
A user-readable display string characterizing the `OutputTypes` property

# components.schemas.pipeline.VisualizerNode.properties.outputTypes.description
The types of Outputs allowed (e.g. string, log, metric)

# components.schemas.pipeline.VisualizerNode.properties.outputs.description
A list of IDs of Nodes which this Node outputs to

# components.schemas.pipeline.VisualizerNode.properties.parentNode.description
Parent node if this node is a child of a compound node

# components.schemas.pipeline.VisualizerNode.properties.pathOutputs.description
A list of outputs, broken down by path when multiple paths are defined

# components.schemas.pipeline.VisualizerNode.properties.releaseStatus.description
The release status of the node (e.g. released or beta)

# components.schemas.pipeline.VisualizerNode.properties.subcategories.description
The Subcategories of the PipelineNode (e.g. Filters, Transformations, etc.)

# components.schemas.pipeline.VisualizerNode.properties.type.description
An identifier for this Node's NodeSpec (e.g. regex-processor)

# components.schemas.pipeline.VisualizerNode.properties.visibility.description
The Visibility setting for the catalog item (e.g. basic, advanced, or hidden).

# components.schemas.ApiError.properties.Error.description
Human-readable error message describing what went wrong.