datadog_api_client 2.48.0 → 2.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.generator/schemas/v1/openapi.yaml +424 -44
- data/.generator/schemas/v2/openapi.yaml +2290 -500
- data/CHANGELOG.md +25 -0
- data/examples/v1/dashboards/CreateDashboard_1093147852.rb +66 -0
- data/examples/v1/dashboards/CreateDashboard_1442588603.rb +1 -1
- data/examples/v1/dashboards/CreateDashboard_1617893815.rb +61 -0
- data/examples/v1/dashboards/CreateDashboard_1712853070.rb +66 -0
- data/examples/v1/dashboards/CreateDashboard_2345541687.rb +65 -0
- data/examples/v1/dashboards/CreateDashboard_252716965.rb +1 -1
- data/examples/v1/dashboards/CreateDashboard_2617251399.rb +66 -0
- data/examples/v1/dashboards/CreateDashboard_2823363212.rb +55 -0
- data/examples/v1/dashboards/CreateDashboard_3882428227.rb +1 -1
- data/examples/v1/monitors/CreateMonitor_3626832481.rb +33 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_2106135939.rb +49 -0
- data/examples/v1/tags/GetHostTags.rb +1 -1
- data/examples/v1/tags/ListHostTags.rb +1 -1
- data/examples/v2/aws-integration/CreateAWSAccount.rb +0 -11
- data/examples/v2/aws-integration/CreateAWSAccount_1716720881.rb +0 -11
- data/examples/v2/aws-integration/UpdateAWSAccount.rb +0 -11
- data/examples/v2/observability-pipelines/CreatePipeline.rb +1 -1
- data/examples/v2/observability-pipelines/UpdatePipeline.rb +1 -1
- data/examples/v2/observability-pipelines/ValidatePipeline.rb +1 -1
- data/examples/v2/reference-tables/UpdateReferenceTable.rb +0 -1
- data/examples/v2/reference-tables/UpsertRows.rb +1 -3
- data/examples/v2/security-monitoring/CreateSecurityMonitoringCriticalAsset.rb +20 -0
- data/examples/v2/security-monitoring/DeleteSecurityMonitoringCriticalAsset.rb +8 -0
- data/examples/v2/security-monitoring/GetCriticalAssetsAffectingRule.rb +8 -0
- data/examples/v2/security-monitoring/GetSecurityMonitoringCriticalAsset.rb +8 -0
- data/examples/v2/security-monitoring/ListSecurityFindings.rb +5 -0
- data/examples/v2/security-monitoring/ListSecurityFindings_2925663885.rb +8 -0
- data/examples/v2/security-monitoring/ListSecurityMonitoringCriticalAssets.rb +5 -0
- data/examples/v2/security-monitoring/SearchSecurityFindings.rb +13 -0
- data/examples/v2/security-monitoring/SearchSecurityFindings_3678541639.rb +16 -0
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringCriticalAsset.rb +24 -0
- data/examples/v2/spa/GetSPARecommendations.rb +1 -1
- data/examples/v2/spa/GetSPARecommendationsWithShard.rb +8 -0
- data/lib/datadog_api_client/configuration.rb +7 -6
- data/lib/datadog_api_client/inflector.rb +79 -6
- data/lib/datadog_api_client/v1/api/tags_api.rb +17 -17
- data/lib/datadog_api_client/v1/models/bar_chart_widget_definition.rb +216 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_definition_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_display.rb +63 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_flat.rb +123 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_flat_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_legend.rb +28 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_request.rb +261 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_scaling.rb +27 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_stacked.rb +133 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_stacked_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/bar_chart_widget_style.rb +125 -0
- data/lib/datadog_api_client/v1/models/distribution_widget_request.rb +36 -2
- data/lib/datadog_api_client/v1/models/distribution_widget_x_axis.rb +29 -1
- data/lib/datadog_api_client/v1/models/heat_map_widget_definition.rb +23 -1
- data/lib/datadog_api_client/v1/models/heat_map_widget_request.rb +21 -1
- data/lib/datadog_api_client/v1/models/heat_map_widget_x_axis.rb +107 -0
- data/lib/datadog_api_client/v1/models/host_tags.rb +2 -2
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_data_source.rb +26 -0
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_model_type_override.rb +28 -0
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_monitor_options.rb +147 -0
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_query_definition.rb +232 -0
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_query_definition.rb +2 -1
- data/lib/datadog_api_client/v1/models/monitor_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/split_graph_source_widget_definition.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_api_step.rb +2 -1
- data/lib/datadog_api_client/v1/models/synthetics_api_subtest_step.rb +236 -0
- data/lib/datadog_api_client/v1/models/synthetics_api_subtest_step_subtype.rb +26 -0
- data/lib/datadog_api_client/v1/models/tag_to_hosts.rb +2 -2
- data/lib/datadog_api_client/v1/models/widget_definition.rb +1 -0
- data/lib/datadog_api_client/v1/models/{distribution_widget_histogram_request_type.rb → widget_histogram_request_type.rb} +1 -1
- data/lib/datadog_api_client/v1/models/widget_marker.rb +3 -1
- data/lib/datadog_api_client/v2/api/events_api.rb +0 -2
- data/lib/datadog_api_client/v2/api/fleet_automation_api.rb +3 -3
- data/lib/datadog_api_client/v2/api/observability_pipelines_api.rb +6 -6
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +597 -0
- data/lib/datadog_api_client/v2/api/spa_api.rb +86 -11
- data/lib/datadog_api_client/v2/models/aws_account_create_request_attributes.rb +1 -11
- data/lib/datadog_api_client/v2/models/aws_account_response_attributes.rb +1 -11
- data/lib/datadog_api_client/v2/models/aws_account_update_request_attributes.rb +1 -11
- data/lib/datadog_api_client/v2/models/azure_storage_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/batch_upsert_rows_request_data_attributes.rb +2 -2
- data/lib/datadog_api_client/v2/models/batch_upsert_rows_request_data_attributes_value.rb +63 -0
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +23 -1
- data/lib/datadog_api_client/v2/models/list_security_findings_response.rb +127 -0
- data/lib/datadog_api_client/v2/models/microsoft_sentinel_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_add_env_vars_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_add_fields_processor.rb +4 -2
- data/lib/datadog_api_client/v2/models/observability_pipeline_add_hostname_processor.rb +198 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_add_hostname_processor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_amazon_data_firehose_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_amazon_s3_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_amazon_s3_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_amazon_security_lake_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_cloud_prem_destination.rb +169 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_cloud_prem_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_config.rb +25 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_destination_item.rb +17 -13
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_pipeline_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_processor_item.rb +14 -10
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_source_item.rb +11 -10
- data/lib/datadog_api_client/v2/models/observability_pipeline_crowd_strike_next_gen_siem_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_custom_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_agent_source.rb +4 -2
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_logs_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_metrics_destination.rb +169 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_metrics_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_tags_processor.rb +4 -2
- data/lib/datadog_api_client/v2/models/observability_pipeline_dedupe_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_elasticsearch_destination.rb +13 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_elasticsearch_destination_data_stream.rb +125 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_enrichment_table_processor.rb +15 -3
- data/lib/datadog_api_client/v2/models/observability_pipeline_enrichment_table_reference_table.rb +156 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_filter_processor.rb +6 -4
- data/lib/datadog_api_client/v2/models/observability_pipeline_fluent_bit_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_fluentd_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_chronicle_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_cloud_storage_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_pub_sub_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_pub_sub_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_destination.rb +220 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_destination_auth_strategy.rb +28 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_destination_compression.rb +123 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_destination_compression_algorithm.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_destination_encoding.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_client_source_auth_strategy.rb +1 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_http_server_source.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb +361 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination_compression.rb +30 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination_encoding.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/{observability_pipeline_kafka_source_librdkafka_option.rb → observability_pipeline_kafka_librdkafka_option.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{observability_pipeline_kafka_source_sasl.rb → observability_pipeline_kafka_sasl.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{observability_pipeline_pipeline_kafka_source_sasl_mechanism.rb → observability_pipeline_kafka_sasl_mechanism.rb} +1 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_source.rb +5 -3
- data/lib/datadog_api_client/v2/models/observability_pipeline_logstash_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_metric_tags_processor.rb +229 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_metric_tags_processor_rule.rb +188 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_metric_tags_processor_rule_action.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_metric_tags_processor_rule_mode.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_metric_tags_processor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_new_relic_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_ocsf_mapper_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_opentelemetry_source.rb +176 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_opentelemetry_source_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_parse_grok_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_parse_json_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_parse_xml_processor.rb +300 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_parse_xml_processor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb +21 -6
- data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor_overflow_action.rb +1 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_reduce_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_remove_fields_processor.rb +4 -2
- data/lib/datadog_api_client/v2/models/observability_pipeline_rename_fields_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_rsyslog_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_rsyslog_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_sample_processor.rb +35 -20
- data/lib/datadog_api_client/v2/models/observability_pipeline_sensitive_data_scanner_processor.rb +4 -2
- data/lib/datadog_api_client/v2/models/observability_pipeline_sensitive_data_scanner_processor_custom_pattern_options.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_sensitive_data_scanner_processor_library_pattern_options.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_sentinel_one_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_split_array_processor.rb +229 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_split_array_processor_array_config.rb +144 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_split_array_processor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_splunk_tcp_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_sumo_logic_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_sumo_logic_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_syslog_ng_destination.rb +2 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_syslog_ng_source.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_throttle_processor.rb +3 -1
- data/lib/datadog_api_client/v2/models/patch_table_request_data_attributes.rb +1 -11
- data/lib/datadog_api_client/v2/models/recommendation_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/security_findings_attributes.rb +127 -0
- data/lib/datadog_api_client/v2/models/security_findings_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/security_findings_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_findings_links.rb +105 -0
- data/lib/datadog_api_client/v2/models/{data_export_config.rb → security_findings_meta.rb} +32 -42
- data/lib/datadog_api_client/v2/models/security_findings_page.rb +105 -0
- data/lib/datadog_api_client/v2/models/security_findings_search_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/security_findings_search_request_data.rb +105 -0
- data/lib/datadog_api_client/v2/models/security_findings_search_request_data_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/security_findings_search_request_page.rb +137 -0
- data/lib/datadog_api_client/v2/models/security_findings_sort.rb +27 -0
- data/lib/datadog_api_client/v2/models/security_findings_status.rb +27 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset.rb +125 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_attributes.rb +235 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_create_attributes.rb +187 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_create_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_severity.rb +32 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_update_attributes.rb +175 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_update_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/{awsccm_config.rb → security_monitoring_critical_assets_response.rb} +12 -12
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +99 -7
|
@@ -1023,6 +1023,13 @@ components:
|
|
|
1023
1023
|
required: true
|
|
1024
1024
|
schema:
|
|
1025
1025
|
type: string
|
|
1026
|
+
SecurityMonitoringCriticalAssetID:
|
|
1027
|
+
description: The ID of the critical asset.
|
|
1028
|
+
in: path
|
|
1029
|
+
name: critical_asset_id
|
|
1030
|
+
required: true
|
|
1031
|
+
schema:
|
|
1032
|
+
type: string
|
|
1026
1033
|
SecurityMonitoringRuleID:
|
|
1027
1034
|
description: The ID of the rule.
|
|
1028
1035
|
in: path
|
|
@@ -1485,8 +1492,6 @@ components:
|
|
|
1485
1492
|
$ref: '#/components/schemas/AWSAccountPartition'
|
|
1486
1493
|
aws_regions:
|
|
1487
1494
|
$ref: '#/components/schemas/AWSRegions'
|
|
1488
|
-
ccm_config:
|
|
1489
|
-
$ref: '#/components/schemas/AWSCCMConfig'
|
|
1490
1495
|
logs_config:
|
|
1491
1496
|
$ref: '#/components/schemas/AWSLogsConfig'
|
|
1492
1497
|
metrics_config:
|
|
@@ -1552,8 +1557,6 @@ components:
|
|
|
1552
1557
|
$ref: '#/components/schemas/AWSAccountPartition'
|
|
1553
1558
|
aws_regions:
|
|
1554
1559
|
$ref: '#/components/schemas/AWSRegions'
|
|
1555
|
-
ccm_config:
|
|
1556
|
-
$ref: '#/components/schemas/AWSCCMConfig'
|
|
1557
1560
|
created_at:
|
|
1558
1561
|
description: Timestamp of when the account integration was created.
|
|
1559
1562
|
format: date-time
|
|
@@ -1627,8 +1630,6 @@ components:
|
|
|
1627
1630
|
$ref: '#/components/schemas/AWSAccountPartition'
|
|
1628
1631
|
aws_regions:
|
|
1629
1632
|
$ref: '#/components/schemas/AWSRegions'
|
|
1630
|
-
ccm_config:
|
|
1631
|
-
$ref: '#/components/schemas/AWSCCMConfig'
|
|
1632
1633
|
logs_config:
|
|
1633
1634
|
$ref: '#/components/schemas/AWSLogsConfig'
|
|
1634
1635
|
metrics_config:
|
|
@@ -1760,15 +1761,6 @@ components:
|
|
|
1760
1761
|
required:
|
|
1761
1762
|
- role_name
|
|
1762
1763
|
type: object
|
|
1763
|
-
AWSCCMConfig:
|
|
1764
|
-
description: AWS Cloud Cost Management config.
|
|
1765
|
-
properties:
|
|
1766
|
-
data_export_configs:
|
|
1767
|
-
description: List of data export configurations for Cost and Usage Reports.
|
|
1768
|
-
items:
|
|
1769
|
-
$ref: '#/components/schemas/DataExportConfig'
|
|
1770
|
-
type: array
|
|
1771
|
-
type: object
|
|
1772
1764
|
AWSCredentials:
|
|
1773
1765
|
description: The definition of `AWSCredentials` object.
|
|
1774
1766
|
oneOf:
|
|
@@ -6677,8 +6669,11 @@ components:
|
|
|
6677
6669
|
x-enum-varnames:
|
|
6678
6670
|
- AZURE_SCAN_OPTIONS
|
|
6679
6671
|
AzureStorageDestination:
|
|
6680
|
-
description: The `azure_storage` destination forwards logs to an Azure Blob
|
|
6672
|
+
description: 'The `azure_storage` destination forwards logs to an Azure Blob
|
|
6681
6673
|
Storage container.
|
|
6674
|
+
|
|
6675
|
+
|
|
6676
|
+
**Supported pipeline types:** logs'
|
|
6682
6677
|
properties:
|
|
6683
6678
|
blob_prefix:
|
|
6684
6679
|
description: Optional prefix for blobs written to the container.
|
|
@@ -6709,6 +6704,8 @@ components:
|
|
|
6709
6704
|
- inputs
|
|
6710
6705
|
- container_name
|
|
6711
6706
|
type: object
|
|
6707
|
+
x-pipeline-types:
|
|
6708
|
+
- logs
|
|
6712
6709
|
AzureStorageDestinationType:
|
|
6713
6710
|
default: azure_storage
|
|
6714
6711
|
description: The destination type. The value should always be `azure_storage`.
|
|
@@ -7075,19 +7072,27 @@ components:
|
|
|
7075
7072
|
BatchUpsertRowsRequestDataAttributes:
|
|
7076
7073
|
description: Attributes containing row data values for row creation or update
|
|
7077
7074
|
operations.
|
|
7075
|
+
example:
|
|
7076
|
+
values: {}
|
|
7078
7077
|
properties:
|
|
7079
7078
|
values:
|
|
7080
7079
|
additionalProperties:
|
|
7081
|
-
|
|
7082
|
-
description: Key-value pairs representing row data, where keys are
|
|
7083
|
-
names
|
|
7084
|
-
example:
|
|
7085
|
-
example_key_value: primary_key_value
|
|
7086
|
-
name: row_name
|
|
7080
|
+
$ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributesValue'
|
|
7081
|
+
description: Key-value pairs representing row data, where keys are schema
|
|
7082
|
+
field names and values match the corresponding column types.
|
|
7087
7083
|
type: object
|
|
7088
7084
|
required:
|
|
7089
7085
|
- values
|
|
7090
7086
|
type: object
|
|
7087
|
+
BatchUpsertRowsRequestDataAttributesValue:
|
|
7088
|
+
description: Types allowed for Reference Table row values.
|
|
7089
|
+
oneOf:
|
|
7090
|
+
- example: row_name
|
|
7091
|
+
type: string
|
|
7092
|
+
- example: 25
|
|
7093
|
+
format: int32
|
|
7094
|
+
maximum: 2147483647
|
|
7095
|
+
type: integer
|
|
7091
7096
|
BillConfig:
|
|
7092
7097
|
description: Bill config.
|
|
7093
7098
|
properties:
|
|
@@ -16806,30 +16811,6 @@ components:
|
|
|
16806
16811
|
example: canceled
|
|
16807
16812
|
type: string
|
|
16808
16813
|
type: object
|
|
16809
|
-
DataExportConfig:
|
|
16810
|
-
description: AWS Cost and Usage Report data export configuration.
|
|
16811
|
-
properties:
|
|
16812
|
-
bucket_name:
|
|
16813
|
-
description: Name of the S3 bucket where the Cost and Usage Report is stored.
|
|
16814
|
-
example: billing
|
|
16815
|
-
type: string
|
|
16816
|
-
bucket_region:
|
|
16817
|
-
description: AWS region of the S3 bucket.
|
|
16818
|
-
example: us-east-1
|
|
16819
|
-
type: string
|
|
16820
|
-
report_name:
|
|
16821
|
-
description: Name of the Cost and Usage Report.
|
|
16822
|
-
example: cost-and-usage-report
|
|
16823
|
-
type: string
|
|
16824
|
-
report_prefix:
|
|
16825
|
-
description: S3 prefix where the Cost and Usage Report is stored.
|
|
16826
|
-
example: reports
|
|
16827
|
-
type: string
|
|
16828
|
-
report_type:
|
|
16829
|
-
description: Type of the Cost and Usage Report.
|
|
16830
|
-
example: CUR2.0
|
|
16831
|
-
type: string
|
|
16832
|
-
type: object
|
|
16833
16814
|
DataRelationshipsTeams:
|
|
16834
16815
|
description: Associates teams with this schedule in a data structure.
|
|
16835
16816
|
properties:
|
|
@@ -24015,6 +23996,13 @@ components:
|
|
|
24015
23996
|
product for this service account. Note: This requires resource_collection_enabled
|
|
24016
23997
|
to be set to true.'
|
|
24017
23998
|
type: boolean
|
|
23999
|
+
is_global_location_enabled:
|
|
24000
|
+
default: true
|
|
24001
|
+
description: When enabled, Datadog collects metrics where location is explicitly
|
|
24002
|
+
stated as "global" or where location information cannot be deduced from
|
|
24003
|
+
GCP labels.
|
|
24004
|
+
example: true
|
|
24005
|
+
type: boolean
|
|
24018
24006
|
is_per_project_quota_enabled:
|
|
24019
24007
|
default: false
|
|
24020
24008
|
description: When enabled, Datadog applies the `X-Goog-User-Project` header,
|
|
@@ -24056,6 +24044,18 @@ components:
|
|
|
24056
24044
|
items:
|
|
24057
24045
|
$ref: '#/components/schemas/GCPMonitoredResourceConfig'
|
|
24058
24046
|
type: array
|
|
24047
|
+
region_filter_configs:
|
|
24048
|
+
description: Configurations for GCP location filtering, such as region,
|
|
24049
|
+
multi-region, or zone. Only monitored resources that match the specified
|
|
24050
|
+
regions are imported into Datadog. By default, Datadog collects from all
|
|
24051
|
+
locations.
|
|
24052
|
+
example:
|
|
24053
|
+
- nam4
|
|
24054
|
+
- europe-north1
|
|
24055
|
+
items:
|
|
24056
|
+
description: Region Filter Configs
|
|
24057
|
+
type: string
|
|
24058
|
+
type: array
|
|
24059
24059
|
resource_collection_enabled:
|
|
24060
24060
|
description: When enabled, Datadog scans for all resources in your GCP environment.
|
|
24061
24061
|
type: boolean
|
|
@@ -30917,6 +30917,19 @@ components:
|
|
|
30917
30917
|
example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
|
|
30918
30918
|
type: string
|
|
30919
30919
|
type: object
|
|
30920
|
+
ListSecurityFindingsResponse:
|
|
30921
|
+
description: The expected response schema when listing security findings.
|
|
30922
|
+
properties:
|
|
30923
|
+
data:
|
|
30924
|
+
description: Array of security findings matching the search query.
|
|
30925
|
+
items:
|
|
30926
|
+
$ref: '#/components/schemas/SecurityFindingsData'
|
|
30927
|
+
type: array
|
|
30928
|
+
links:
|
|
30929
|
+
$ref: '#/components/schemas/SecurityFindingsLinks'
|
|
30930
|
+
meta:
|
|
30931
|
+
$ref: '#/components/schemas/SecurityFindingsMeta'
|
|
30932
|
+
type: object
|
|
30920
30933
|
ListTagsResponse:
|
|
30921
30934
|
description: List tags response.
|
|
30922
30935
|
properties:
|
|
@@ -33607,8 +33620,11 @@ components:
|
|
|
33607
33620
|
- query
|
|
33608
33621
|
type: object
|
|
33609
33622
|
MicrosoftSentinelDestination:
|
|
33610
|
-
description: The `microsoft_sentinel` destination forwards logs to Microsoft
|
|
33623
|
+
description: 'The `microsoft_sentinel` destination forwards logs to Microsoft
|
|
33611
33624
|
Sentinel.
|
|
33625
|
+
|
|
33626
|
+
|
|
33627
|
+
**Supported pipeline types:** logs'
|
|
33612
33628
|
properties:
|
|
33613
33629
|
client_id:
|
|
33614
33630
|
description: Azure AD client ID used for authentication.
|
|
@@ -33649,6 +33665,8 @@ components:
|
|
|
33649
33665
|
- dcr_immutable_id
|
|
33650
33666
|
- table
|
|
33651
33667
|
type: object
|
|
33668
|
+
x-pipeline-types:
|
|
33669
|
+
- logs
|
|
33652
33670
|
MicrosoftSentinelDestinationType:
|
|
33653
33671
|
default: microsoft_sentinel
|
|
33654
33672
|
description: The destination type. The value should always be `microsoft_sentinel`.
|
|
@@ -35353,13 +35371,16 @@ components:
|
|
|
35353
35371
|
- data
|
|
35354
35372
|
type: object
|
|
35355
35373
|
ObservabilityPipelineAddEnvVarsProcessor:
|
|
35356
|
-
description: The `add_env_vars` processor adds environment variable values
|
|
35357
|
-
log events.
|
|
35374
|
+
description: 'The `add_env_vars` processor adds environment variable values
|
|
35375
|
+
to log events.
|
|
35376
|
+
|
|
35377
|
+
|
|
35378
|
+
**Supported pipeline types:** logs'
|
|
35358
35379
|
properties:
|
|
35359
35380
|
display_name:
|
|
35360
35381
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35361
35382
|
enabled:
|
|
35362
|
-
description:
|
|
35383
|
+
description: Indicates whether the processor is enabled.
|
|
35363
35384
|
example: true
|
|
35364
35385
|
type: boolean
|
|
35365
35386
|
id:
|
|
@@ -35386,6 +35407,8 @@ components:
|
|
|
35386
35407
|
- variables
|
|
35387
35408
|
- enabled
|
|
35388
35409
|
type: object
|
|
35410
|
+
x-pipeline-types:
|
|
35411
|
+
- logs
|
|
35389
35412
|
ObservabilityPipelineAddEnvVarsProcessorType:
|
|
35390
35413
|
default: add_env_vars
|
|
35391
35414
|
description: The processor type. The value should always be `add_env_vars`.
|
|
@@ -35411,12 +35434,15 @@ components:
|
|
|
35411
35434
|
- name
|
|
35412
35435
|
type: object
|
|
35413
35436
|
ObservabilityPipelineAddFieldsProcessor:
|
|
35414
|
-
description: The `add_fields` processor adds static key-value fields to logs.
|
|
35437
|
+
description: 'The `add_fields` processor adds static key-value fields to logs.
|
|
35438
|
+
|
|
35439
|
+
|
|
35440
|
+
**Supported pipeline types:** logs'
|
|
35415
35441
|
properties:
|
|
35416
35442
|
display_name:
|
|
35417
35443
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35418
35444
|
enabled:
|
|
35419
|
-
description:
|
|
35445
|
+
description: Indicates whether the processor is enabled.
|
|
35420
35446
|
example: true
|
|
35421
35447
|
type: boolean
|
|
35422
35448
|
fields:
|
|
@@ -35426,8 +35452,8 @@ components:
|
|
|
35426
35452
|
$ref: '#/components/schemas/ObservabilityPipelineFieldValue'
|
|
35427
35453
|
type: array
|
|
35428
35454
|
id:
|
|
35429
|
-
description: The unique identifier for this component. Used
|
|
35430
|
-
|
|
35455
|
+
description: The unique identifier for this component. Used in other parts
|
|
35456
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
35431
35457
|
to downstream components).
|
|
35432
35458
|
example: add-fields-processor
|
|
35433
35459
|
type: string
|
|
@@ -35445,6 +35471,8 @@ components:
|
|
|
35445
35471
|
- fields
|
|
35446
35472
|
- enabled
|
|
35447
35473
|
type: object
|
|
35474
|
+
x-pipeline-types:
|
|
35475
|
+
- logs
|
|
35448
35476
|
ObservabilityPipelineAddFieldsProcessorType:
|
|
35449
35477
|
default: add_fields
|
|
35450
35478
|
description: The processor type. The value should always be `add_fields`.
|
|
@@ -35454,15 +35482,60 @@ components:
|
|
|
35454
35482
|
type: string
|
|
35455
35483
|
x-enum-varnames:
|
|
35456
35484
|
- ADD_FIELDS
|
|
35485
|
+
ObservabilityPipelineAddHostnameProcessor:
|
|
35486
|
+
description: 'The `add_hostname` processor adds the hostname to log events.
|
|
35487
|
+
|
|
35488
|
+
|
|
35489
|
+
**Supported pipeline types:** logs'
|
|
35490
|
+
properties:
|
|
35491
|
+
display_name:
|
|
35492
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35493
|
+
enabled:
|
|
35494
|
+
description: Indicates whether the processor is enabled.
|
|
35495
|
+
example: true
|
|
35496
|
+
type: boolean
|
|
35497
|
+
id:
|
|
35498
|
+
description: The unique identifier for this component. Used in other parts
|
|
35499
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
35500
|
+
to downstream components).
|
|
35501
|
+
example: add-hostname-processor
|
|
35502
|
+
type: string
|
|
35503
|
+
include:
|
|
35504
|
+
description: A Datadog search query used to determine which logs this processor
|
|
35505
|
+
targets.
|
|
35506
|
+
example: service:my-service
|
|
35507
|
+
type: string
|
|
35508
|
+
type:
|
|
35509
|
+
$ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessorType'
|
|
35510
|
+
required:
|
|
35511
|
+
- id
|
|
35512
|
+
- type
|
|
35513
|
+
- include
|
|
35514
|
+
- enabled
|
|
35515
|
+
type: object
|
|
35516
|
+
x-pipeline-types:
|
|
35517
|
+
- logs
|
|
35518
|
+
ObservabilityPipelineAddHostnameProcessorType:
|
|
35519
|
+
default: add_hostname
|
|
35520
|
+
description: The processor type. The value should always be `add_hostname`.
|
|
35521
|
+
enum:
|
|
35522
|
+
- add_hostname
|
|
35523
|
+
example: add_hostname
|
|
35524
|
+
type: string
|
|
35525
|
+
x-enum-varnames:
|
|
35526
|
+
- ADD_HOSTNAME
|
|
35457
35527
|
ObservabilityPipelineAmazonDataFirehoseSource:
|
|
35458
|
-
description: The `amazon_data_firehose` source ingests logs from AWS Data Firehose.
|
|
35528
|
+
description: 'The `amazon_data_firehose` source ingests logs from AWS Data Firehose.
|
|
35529
|
+
|
|
35530
|
+
|
|
35531
|
+
**Supported pipeline types:** logs'
|
|
35459
35532
|
properties:
|
|
35460
35533
|
auth:
|
|
35461
35534
|
$ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
|
|
35462
35535
|
id:
|
|
35463
|
-
description: The unique identifier for this component. Used
|
|
35464
|
-
|
|
35465
|
-
components).
|
|
35536
|
+
description: The unique identifier for this component. Used in other parts
|
|
35537
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
35538
|
+
to downstream components).
|
|
35466
35539
|
example: amazon-firehose-source
|
|
35467
35540
|
type: string
|
|
35468
35541
|
tls:
|
|
@@ -35473,6 +35546,8 @@ components:
|
|
|
35473
35546
|
- id
|
|
35474
35547
|
- type
|
|
35475
35548
|
type: object
|
|
35549
|
+
x-pipeline-types:
|
|
35550
|
+
- logs
|
|
35476
35551
|
ObservabilityPipelineAmazonDataFirehoseSourceType:
|
|
35477
35552
|
default: amazon_data_firehose
|
|
35478
35553
|
description: The source type. The value should always be `amazon_data_firehose`.
|
|
@@ -35483,7 +35558,10 @@ components:
|
|
|
35483
35558
|
x-enum-varnames:
|
|
35484
35559
|
- AMAZON_DATA_FIREHOSE
|
|
35485
35560
|
ObservabilityPipelineAmazonOpenSearchDestination:
|
|
35486
|
-
description: The `amazon_opensearch` destination writes logs to Amazon OpenSearch.
|
|
35561
|
+
description: 'The `amazon_opensearch` destination writes logs to Amazon OpenSearch.
|
|
35562
|
+
|
|
35563
|
+
|
|
35564
|
+
**Supported pipeline types:** logs'
|
|
35487
35565
|
properties:
|
|
35488
35566
|
auth:
|
|
35489
35567
|
$ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuth'
|
|
@@ -35511,6 +35589,8 @@ components:
|
|
|
35511
35589
|
- inputs
|
|
35512
35590
|
- auth
|
|
35513
35591
|
type: object
|
|
35592
|
+
x-pipeline-types:
|
|
35593
|
+
- logs
|
|
35514
35594
|
ObservabilityPipelineAmazonOpenSearchDestinationAuth:
|
|
35515
35595
|
description: 'Authentication settings for the Amazon OpenSearch destination.
|
|
35516
35596
|
|
|
@@ -35554,8 +35634,11 @@ components:
|
|
|
35554
35634
|
x-enum-varnames:
|
|
35555
35635
|
- AMAZON_OPENSEARCH
|
|
35556
35636
|
ObservabilityPipelineAmazonS3Destination:
|
|
35557
|
-
description: The `amazon_s3` destination sends your logs in Datadog-rehydratable
|
|
35637
|
+
description: 'The `amazon_s3` destination sends your logs in Datadog-rehydratable
|
|
35558
35638
|
format to an Amazon S3 bucket for archiving.
|
|
35639
|
+
|
|
35640
|
+
|
|
35641
|
+
**Supported pipeline types:** logs'
|
|
35559
35642
|
properties:
|
|
35560
35643
|
auth:
|
|
35561
35644
|
$ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
|
|
@@ -35596,6 +35679,8 @@ components:
|
|
|
35596
35679
|
- region
|
|
35597
35680
|
- storage_class
|
|
35598
35681
|
type: object
|
|
35682
|
+
x-pipeline-types:
|
|
35683
|
+
- logs
|
|
35599
35684
|
ObservabilityPipelineAmazonS3DestinationStorageClass:
|
|
35600
35685
|
description: S3 storage class.
|
|
35601
35686
|
enum:
|
|
@@ -35632,14 +35717,17 @@ components:
|
|
|
35632
35717
|
ObservabilityPipelineAmazonS3Source:
|
|
35633
35718
|
description: 'The `amazon_s3` source ingests logs from an Amazon S3 bucket.
|
|
35634
35719
|
|
|
35635
|
-
It supports AWS authentication and TLS encryption.
|
|
35720
|
+
It supports AWS authentication and TLS encryption.
|
|
35721
|
+
|
|
35722
|
+
|
|
35723
|
+
**Supported pipeline types:** logs'
|
|
35636
35724
|
properties:
|
|
35637
35725
|
auth:
|
|
35638
35726
|
$ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
|
|
35639
35727
|
id:
|
|
35640
|
-
description: The unique identifier for this component. Used
|
|
35641
|
-
|
|
35642
|
-
components).
|
|
35728
|
+
description: The unique identifier for this component. Used in other parts
|
|
35729
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
35730
|
+
to downstream components).
|
|
35643
35731
|
example: aws-s3-source
|
|
35644
35732
|
type: string
|
|
35645
35733
|
region:
|
|
@@ -35655,6 +35743,8 @@ components:
|
|
|
35655
35743
|
- type
|
|
35656
35744
|
- region
|
|
35657
35745
|
type: object
|
|
35746
|
+
x-pipeline-types:
|
|
35747
|
+
- logs
|
|
35658
35748
|
ObservabilityPipelineAmazonS3SourceType:
|
|
35659
35749
|
default: amazon_s3
|
|
35660
35750
|
description: The source type. Always `amazon_s3`.
|
|
@@ -35665,8 +35755,11 @@ components:
|
|
|
35665
35755
|
x-enum-varnames:
|
|
35666
35756
|
- AMAZON_S3
|
|
35667
35757
|
ObservabilityPipelineAmazonSecurityLakeDestination:
|
|
35668
|
-
description: The `amazon_security_lake` destination sends your logs to Amazon
|
|
35758
|
+
description: 'The `amazon_security_lake` destination sends your logs to Amazon
|
|
35669
35759
|
Security Lake.
|
|
35760
|
+
|
|
35761
|
+
|
|
35762
|
+
**Supported pipeline types:** logs'
|
|
35670
35763
|
properties:
|
|
35671
35764
|
auth:
|
|
35672
35765
|
$ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
|
|
@@ -35706,6 +35799,8 @@ components:
|
|
|
35706
35799
|
- region
|
|
35707
35800
|
- custom_source_name
|
|
35708
35801
|
type: object
|
|
35802
|
+
x-pipeline-types:
|
|
35803
|
+
- logs
|
|
35709
35804
|
ObservabilityPipelineAmazonSecurityLakeDestinationType:
|
|
35710
35805
|
default: amazon_security_lake
|
|
35711
35806
|
description: The destination type. Always `amazon_security_lake`.
|
|
@@ -35731,6 +35826,42 @@ components:
|
|
|
35731
35826
|
role session.
|
|
35732
35827
|
type: string
|
|
35733
35828
|
type: object
|
|
35829
|
+
ObservabilityPipelineCloudPremDestination:
|
|
35830
|
+
description: 'The `cloud_prem` destination sends logs to Datadog CloudPrem.
|
|
35831
|
+
|
|
35832
|
+
|
|
35833
|
+
**Supported pipeline types:** logs'
|
|
35834
|
+
properties:
|
|
35835
|
+
id:
|
|
35836
|
+
description: The unique identifier for this component.
|
|
35837
|
+
example: cloud-prem-destination
|
|
35838
|
+
type: string
|
|
35839
|
+
inputs:
|
|
35840
|
+
description: A list of component IDs whose output is used as the `input`
|
|
35841
|
+
for this component.
|
|
35842
|
+
example:
|
|
35843
|
+
- filter-processor
|
|
35844
|
+
items:
|
|
35845
|
+
type: string
|
|
35846
|
+
type: array
|
|
35847
|
+
type:
|
|
35848
|
+
$ref: '#/components/schemas/ObservabilityPipelineCloudPremDestinationType'
|
|
35849
|
+
required:
|
|
35850
|
+
- id
|
|
35851
|
+
- type
|
|
35852
|
+
- inputs
|
|
35853
|
+
type: object
|
|
35854
|
+
x-pipeline-types:
|
|
35855
|
+
- logs
|
|
35856
|
+
ObservabilityPipelineCloudPremDestinationType:
|
|
35857
|
+
default: cloud_prem
|
|
35858
|
+
description: The destination type. The value should always be `cloud_prem`.
|
|
35859
|
+
enum:
|
|
35860
|
+
- cloud_prem
|
|
35861
|
+
example: cloud_prem
|
|
35862
|
+
type: string
|
|
35863
|
+
x-enum-varnames:
|
|
35864
|
+
- CLOUD_PREM
|
|
35734
35865
|
ObservabilityPipelineComponentDisplayName:
|
|
35735
35866
|
description: The display name for a component.
|
|
35736
35867
|
example: my component
|
|
@@ -35744,12 +35875,14 @@ components:
|
|
|
35744
35875
|
example:
|
|
35745
35876
|
- id: datadog-logs-destination
|
|
35746
35877
|
inputs:
|
|
35747
|
-
-
|
|
35878
|
+
- my-processor-group
|
|
35748
35879
|
type: datadog_logs
|
|
35749
35880
|
items:
|
|
35750
35881
|
$ref: '#/components/schemas/ObservabilityPipelineConfigDestinationItem'
|
|
35751
35882
|
type: array
|
|
35752
|
-
|
|
35883
|
+
pipeline_type:
|
|
35884
|
+
$ref: '#/components/schemas/ObservabilityPipelineConfigPipelineType'
|
|
35885
|
+
processor_groups:
|
|
35753
35886
|
description: A list of processor groups that transform or enrich log data.
|
|
35754
35887
|
example:
|
|
35755
35888
|
- enabled: true
|
|
@@ -35770,6 +35903,17 @@ components:
|
|
|
35770
35903
|
items:
|
|
35771
35904
|
$ref: '#/components/schemas/ObservabilityPipelineConfigProcessorGroup'
|
|
35772
35905
|
type: array
|
|
35906
|
+
processors:
|
|
35907
|
+
deprecated: true
|
|
35908
|
+
description: 'A list of processor groups that transform or enrich log data.
|
|
35909
|
+
|
|
35910
|
+
|
|
35911
|
+
**Deprecated:** This field is deprecated, you should now use the processor_groups
|
|
35912
|
+
field.'
|
|
35913
|
+
example: []
|
|
35914
|
+
items:
|
|
35915
|
+
$ref: '#/components/schemas/ObservabilityPipelineConfigProcessorGroup'
|
|
35916
|
+
type: array
|
|
35773
35917
|
sources:
|
|
35774
35918
|
description: A list of configured data sources for the pipeline.
|
|
35775
35919
|
example:
|
|
@@ -35785,25 +35929,40 @@ components:
|
|
|
35785
35929
|
ObservabilityPipelineConfigDestinationItem:
|
|
35786
35930
|
description: A destination for the pipeline.
|
|
35787
35931
|
oneOf:
|
|
35788
|
-
- $ref: '#/components/schemas/
|
|
35932
|
+
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestination'
|
|
35933
|
+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
|
|
35789
35934
|
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Destination'
|
|
35790
|
-
- $ref: '#/components/schemas/
|
|
35791
|
-
- $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestination'
|
|
35792
|
-
- $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestination'
|
|
35793
|
-
- $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestination'
|
|
35794
|
-
- $ref: '#/components/schemas/ObservabilityPipelineRsyslogDestination'
|
|
35795
|
-
- $ref: '#/components/schemas/ObservabilityPipelineSyslogNgDestination'
|
|
35935
|
+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination'
|
|
35796
35936
|
- $ref: '#/components/schemas/AzureStorageDestination'
|
|
35797
|
-
- $ref: '#/components/schemas/
|
|
35937
|
+
- $ref: '#/components/schemas/ObservabilityPipelineCloudPremDestination'
|
|
35938
|
+
- $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination'
|
|
35939
|
+
- $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestination'
|
|
35940
|
+
- $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestination'
|
|
35798
35941
|
- $ref: '#/components/schemas/ObservabilityPipelineGoogleChronicleDestination'
|
|
35942
|
+
- $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestination'
|
|
35943
|
+
- $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestination'
|
|
35944
|
+
- $ref: '#/components/schemas/ObservabilityPipelineKafkaDestination'
|
|
35945
|
+
- $ref: '#/components/schemas/MicrosoftSentinelDestination'
|
|
35799
35946
|
- $ref: '#/components/schemas/ObservabilityPipelineNewRelicDestination'
|
|
35800
|
-
- $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
|
|
35801
35947
|
- $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
|
|
35802
|
-
- $ref: '#/components/schemas/
|
|
35948
|
+
- $ref: '#/components/schemas/ObservabilityPipelineRsyslogDestination'
|
|
35949
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
|
|
35803
35950
|
- $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
|
|
35804
|
-
- $ref: '#/components/schemas/
|
|
35805
|
-
- $ref: '#/components/schemas/
|
|
35806
|
-
- $ref: '#/components/schemas/
|
|
35951
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestination'
|
|
35952
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestination'
|
|
35953
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSyslogNgDestination'
|
|
35954
|
+
- $ref: '#/components/schemas/ObservabilityPipelineDatadogMetricsDestination'
|
|
35955
|
+
ObservabilityPipelineConfigPipelineType:
|
|
35956
|
+
default: logs
|
|
35957
|
+
description: The type of data being ingested. Defaults to `logs` if not specified.
|
|
35958
|
+
enum:
|
|
35959
|
+
- logs
|
|
35960
|
+
- metrics
|
|
35961
|
+
example: logs
|
|
35962
|
+
type: string
|
|
35963
|
+
x-enum-varnames:
|
|
35964
|
+
- LOGS
|
|
35965
|
+
- METRICS
|
|
35807
35966
|
ObservabilityPipelineConfigProcessorGroup:
|
|
35808
35967
|
description: A group of processors.
|
|
35809
35968
|
example:
|
|
@@ -35877,45 +36036,53 @@ components:
|
|
|
35877
36036
|
description: A processor for the pipeline.
|
|
35878
36037
|
oneOf:
|
|
35879
36038
|
- $ref: '#/components/schemas/ObservabilityPipelineFilterProcessor'
|
|
36039
|
+
- $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor'
|
|
36040
|
+
- $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessor'
|
|
36041
|
+
- $ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessor'
|
|
36042
|
+
- $ref: '#/components/schemas/ObservabilityPipelineCustomProcessor'
|
|
36043
|
+
- $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessor'
|
|
36044
|
+
- $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessor'
|
|
36045
|
+
- $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor'
|
|
36046
|
+
- $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor'
|
|
36047
|
+
- $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessor'
|
|
36048
|
+
- $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessor'
|
|
35880
36049
|
- $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessor'
|
|
36050
|
+
- $ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessor'
|
|
35881
36051
|
- $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessor'
|
|
35882
|
-
- $ref: '#/components/schemas/
|
|
36052
|
+
- $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor'
|
|
35883
36053
|
- $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessor'
|
|
35884
36054
|
- $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessor'
|
|
35885
|
-
- $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor'
|
|
35886
36055
|
- $ref: '#/components/schemas/ObservabilityPipelineSampleProcessor'
|
|
35887
|
-
- $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessor'
|
|
35888
36056
|
- $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessor'
|
|
35889
|
-
- $ref: '#/components/schemas/
|
|
35890
|
-
- $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor'
|
|
35891
|
-
- $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessor'
|
|
35892
|
-
- $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor'
|
|
35893
|
-
- $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor'
|
|
36057
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessor'
|
|
35894
36058
|
- $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessor'
|
|
35895
|
-
- $ref: '#/components/schemas/
|
|
35896
|
-
- $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessor'
|
|
36059
|
+
- $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessor'
|
|
35897
36060
|
ObservabilityPipelineConfigSourceItem:
|
|
35898
36061
|
description: A data source for the pipeline.
|
|
35899
36062
|
oneOf:
|
|
35900
|
-
- $ref: '#/components/schemas/ObservabilityPipelineKafkaSource'
|
|
35901
36063
|
- $ref: '#/components/schemas/ObservabilityPipelineDatadogAgentSource'
|
|
35902
|
-
- $ref: '#/components/schemas/
|
|
35903
|
-
- $ref: '#/components/schemas/ObservabilityPipelineSplunkHecSource'
|
|
36064
|
+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSource'
|
|
35904
36065
|
- $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Source'
|
|
35905
|
-
- $ref: '#/components/schemas/ObservabilityPipelineFluentdSource'
|
|
35906
36066
|
- $ref: '#/components/schemas/ObservabilityPipelineFluentBitSource'
|
|
35907
|
-
- $ref: '#/components/schemas/
|
|
35908
|
-
- $ref: '#/components/schemas/ObservabilityPipelineSumoLogicSource'
|
|
35909
|
-
- $ref: '#/components/schemas/ObservabilityPipelineRsyslogSource'
|
|
35910
|
-
- $ref: '#/components/schemas/ObservabilityPipelineSyslogNgSource'
|
|
35911
|
-
- $ref: '#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSource'
|
|
36067
|
+
- $ref: '#/components/schemas/ObservabilityPipelineFluentdSource'
|
|
35912
36068
|
- $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
|
|
35913
36069
|
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
|
|
36070
|
+
- $ref: '#/components/schemas/ObservabilityPipelineHttpServerSource'
|
|
36071
|
+
- $ref: '#/components/schemas/ObservabilityPipelineKafkaSource'
|
|
35914
36072
|
- $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
|
|
36073
|
+
- $ref: '#/components/schemas/ObservabilityPipelineRsyslogSource'
|
|
35915
36074
|
- $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
|
|
36075
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSplunkHecSource'
|
|
36076
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSplunkTcpSource'
|
|
36077
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSumoLogicSource'
|
|
36078
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSyslogNgSource'
|
|
36079
|
+
- $ref: '#/components/schemas/ObservabilityPipelineOpentelemetrySource'
|
|
35916
36080
|
ObservabilityPipelineCrowdStrikeNextGenSiemDestination:
|
|
35917
|
-
description: The `crowdstrike_next_gen_siem` destination forwards logs to CrowdStrike
|
|
36081
|
+
description: 'The `crowdstrike_next_gen_siem` destination forwards logs to CrowdStrike
|
|
35918
36082
|
Next Gen SIEM.
|
|
36083
|
+
|
|
36084
|
+
|
|
36085
|
+
**Supported pipeline types:** logs'
|
|
35919
36086
|
properties:
|
|
35920
36087
|
compression:
|
|
35921
36088
|
$ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression'
|
|
@@ -35943,6 +36110,8 @@ components:
|
|
|
35943
36110
|
- inputs
|
|
35944
36111
|
- encoding
|
|
35945
36112
|
type: object
|
|
36113
|
+
x-pipeline-types:
|
|
36114
|
+
- logs
|
|
35946
36115
|
ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression:
|
|
35947
36116
|
description: Compression configuration for log events.
|
|
35948
36117
|
properties:
|
|
@@ -35986,14 +36155,17 @@ components:
|
|
|
35986
36155
|
x-enum-varnames:
|
|
35987
36156
|
- CROWDSTRIKE_NEXT_GEN_SIEM
|
|
35988
36157
|
ObservabilityPipelineCustomProcessor:
|
|
35989
|
-
description: The `custom_processor` processor transforms events using [Vector
|
|
36158
|
+
description: 'The `custom_processor` processor transforms events using [Vector
|
|
35990
36159
|
Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with
|
|
35991
36160
|
advanced filtering capabilities.
|
|
36161
|
+
|
|
36162
|
+
|
|
36163
|
+
**Supported pipeline types:** logs'
|
|
35992
36164
|
properties:
|
|
35993
36165
|
display_name:
|
|
35994
36166
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35995
36167
|
enabled:
|
|
35996
|
-
description:
|
|
36168
|
+
description: Indicates whether the processor is enabled.
|
|
35997
36169
|
example: true
|
|
35998
36170
|
type: boolean
|
|
35999
36171
|
id:
|
|
@@ -36022,6 +36194,8 @@ components:
|
|
|
36022
36194
|
- remaps
|
|
36023
36195
|
- enabled
|
|
36024
36196
|
type: object
|
|
36197
|
+
x-pipeline-types:
|
|
36198
|
+
- logs
|
|
36025
36199
|
ObservabilityPipelineCustomProcessorRemap:
|
|
36026
36200
|
description: Defines a single VRL remap rule with its own filtering and transformation
|
|
36027
36201
|
logic.
|
|
@@ -36097,12 +36271,16 @@ components:
|
|
|
36097
36271
|
- config
|
|
36098
36272
|
type: object
|
|
36099
36273
|
ObservabilityPipelineDatadogAgentSource:
|
|
36100
|
-
description: The `datadog_agent` source collects logs from the Datadog
|
|
36274
|
+
description: 'The `datadog_agent` source collects logs/metrics from the Datadog
|
|
36275
|
+
Agent.
|
|
36276
|
+
|
|
36277
|
+
|
|
36278
|
+
**Supported pipeline types:** logs, metrics'
|
|
36101
36279
|
properties:
|
|
36102
36280
|
id:
|
|
36103
|
-
description: The unique identifier for this component. Used
|
|
36104
|
-
|
|
36105
|
-
components).
|
|
36281
|
+
description: The unique identifier for this component. Used in other parts
|
|
36282
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
36283
|
+
to downstream components).
|
|
36106
36284
|
example: datadog-agent-source
|
|
36107
36285
|
type: string
|
|
36108
36286
|
tls:
|
|
@@ -36113,6 +36291,9 @@ components:
|
|
|
36113
36291
|
- id
|
|
36114
36292
|
- type
|
|
36115
36293
|
type: object
|
|
36294
|
+
x-pipeline-types:
|
|
36295
|
+
- logs
|
|
36296
|
+
- metrics
|
|
36116
36297
|
ObservabilityPipelineDatadogAgentSourceType:
|
|
36117
36298
|
default: datadog_agent
|
|
36118
36299
|
description: The source type. The value should always be `datadog_agent`.
|
|
@@ -36123,7 +36304,10 @@ components:
|
|
|
36123
36304
|
x-enum-varnames:
|
|
36124
36305
|
- DATADOG_AGENT
|
|
36125
36306
|
ObservabilityPipelineDatadogLogsDestination:
|
|
36126
|
-
description: The `datadog_logs` destination forwards logs to Datadog Log Management.
|
|
36307
|
+
description: 'The `datadog_logs` destination forwards logs to Datadog Log Management.
|
|
36308
|
+
|
|
36309
|
+
|
|
36310
|
+
**Supported pipeline types:** logs'
|
|
36127
36311
|
properties:
|
|
36128
36312
|
id:
|
|
36129
36313
|
description: The unique identifier for this component.
|
|
@@ -36144,6 +36328,8 @@ components:
|
|
|
36144
36328
|
- type
|
|
36145
36329
|
- inputs
|
|
36146
36330
|
type: object
|
|
36331
|
+
x-pipeline-types:
|
|
36332
|
+
- logs
|
|
36147
36333
|
ObservabilityPipelineDatadogLogsDestinationType:
|
|
36148
36334
|
default: datadog_logs
|
|
36149
36335
|
description: The destination type. The value should always be `datadog_logs`.
|
|
@@ -36153,21 +36339,60 @@ components:
|
|
|
36153
36339
|
type: string
|
|
36154
36340
|
x-enum-varnames:
|
|
36155
36341
|
- DATADOG_LOGS
|
|
36342
|
+
ObservabilityPipelineDatadogMetricsDestination:
|
|
36343
|
+
description: 'The `datadog_metrics` destination forwards metrics to Datadog.
|
|
36344
|
+
|
|
36345
|
+
|
|
36346
|
+
**Supported pipeline types:** metrics'
|
|
36347
|
+
properties:
|
|
36348
|
+
id:
|
|
36349
|
+
description: The unique identifier for this component.
|
|
36350
|
+
example: datadog-metrics-destination
|
|
36351
|
+
type: string
|
|
36352
|
+
inputs:
|
|
36353
|
+
description: A list of component IDs whose output is used as the input for
|
|
36354
|
+
this component.
|
|
36355
|
+
example:
|
|
36356
|
+
- metric-tags-processor
|
|
36357
|
+
items:
|
|
36358
|
+
type: string
|
|
36359
|
+
type: array
|
|
36360
|
+
type:
|
|
36361
|
+
$ref: '#/components/schemas/ObservabilityPipelineDatadogMetricsDestinationType'
|
|
36362
|
+
required:
|
|
36363
|
+
- id
|
|
36364
|
+
- type
|
|
36365
|
+
- inputs
|
|
36366
|
+
type: object
|
|
36367
|
+
x-pipeline-types:
|
|
36368
|
+
- metrics
|
|
36369
|
+
ObservabilityPipelineDatadogMetricsDestinationType:
|
|
36370
|
+
default: datadog_metrics
|
|
36371
|
+
description: The destination type. The value should always be `datadog_metrics`.
|
|
36372
|
+
enum:
|
|
36373
|
+
- datadog_metrics
|
|
36374
|
+
example: datadog_metrics
|
|
36375
|
+
type: string
|
|
36376
|
+
x-enum-varnames:
|
|
36377
|
+
- DATADOG_METRICS
|
|
36156
36378
|
ObservabilityPipelineDatadogTagsProcessor:
|
|
36157
|
-
description: The `datadog_tags` processor includes or excludes specific Datadog
|
|
36379
|
+
description: 'The `datadog_tags` processor includes or excludes specific Datadog
|
|
36158
36380
|
tags in your logs.
|
|
36381
|
+
|
|
36382
|
+
|
|
36383
|
+
**Supported pipeline types:** logs'
|
|
36159
36384
|
properties:
|
|
36160
36385
|
action:
|
|
36161
36386
|
$ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction'
|
|
36162
36387
|
display_name:
|
|
36163
36388
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36164
36389
|
enabled:
|
|
36165
|
-
description:
|
|
36390
|
+
description: Indicates whether the processor is enabled.
|
|
36166
36391
|
example: true
|
|
36167
36392
|
type: boolean
|
|
36168
36393
|
id:
|
|
36169
|
-
description: The unique identifier for this component. Used
|
|
36170
|
-
|
|
36394
|
+
description: The unique identifier for this component. Used in other parts
|
|
36395
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
36171
36396
|
to downstream components).
|
|
36172
36397
|
example: datadog-tags-processor
|
|
36173
36398
|
type: string
|
|
@@ -36198,6 +36423,8 @@ components:
|
|
|
36198
36423
|
- keys
|
|
36199
36424
|
- enabled
|
|
36200
36425
|
type: object
|
|
36426
|
+
x-pipeline-types:
|
|
36427
|
+
- logs
|
|
36201
36428
|
ObservabilityPipelineDatadogTagsProcessorAction:
|
|
36202
36429
|
description: The action to take on tags with matching keys.
|
|
36203
36430
|
enum:
|
|
@@ -36240,12 +36467,15 @@ components:
|
|
|
36240
36467
|
- DECODE_JSON
|
|
36241
36468
|
- DECODE_SYSLOG
|
|
36242
36469
|
ObservabilityPipelineDedupeProcessor:
|
|
36243
|
-
description: The `dedupe` processor removes duplicate fields in log events.
|
|
36470
|
+
description: 'The `dedupe` processor removes duplicate fields in log events.
|
|
36471
|
+
|
|
36472
|
+
|
|
36473
|
+
**Supported pipeline types:** logs'
|
|
36244
36474
|
properties:
|
|
36245
36475
|
display_name:
|
|
36246
36476
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36247
36477
|
enabled:
|
|
36248
|
-
description:
|
|
36478
|
+
description: Indicates whether the processor is enabled.
|
|
36249
36479
|
example: true
|
|
36250
36480
|
type: boolean
|
|
36251
36481
|
fields:
|
|
@@ -36277,6 +36507,8 @@ components:
|
|
|
36277
36507
|
- mode
|
|
36278
36508
|
- enabled
|
|
36279
36509
|
type: object
|
|
36510
|
+
x-pipeline-types:
|
|
36511
|
+
- logs
|
|
36280
36512
|
ObservabilityPipelineDedupeProcessorMode:
|
|
36281
36513
|
description: The deduplication mode to apply to the fields.
|
|
36282
36514
|
enum:
|
|
@@ -36297,8 +36529,11 @@ components:
|
|
|
36297
36529
|
x-enum-varnames:
|
|
36298
36530
|
- DEDUPE
|
|
36299
36531
|
ObservabilityPipelineElasticsearchDestination:
|
|
36300
|
-
description: The `elasticsearch` destination writes logs to an Elasticsearch
|
|
36532
|
+
description: 'The `elasticsearch` destination writes logs to an Elasticsearch
|
|
36301
36533
|
cluster.
|
|
36534
|
+
|
|
36535
|
+
|
|
36536
|
+
**Supported pipeline types:** logs'
|
|
36302
36537
|
properties:
|
|
36303
36538
|
api_version:
|
|
36304
36539
|
$ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion'
|
|
@@ -36306,6 +36541,8 @@ components:
|
|
|
36306
36541
|
description: The index to write logs to in Elasticsearch.
|
|
36307
36542
|
example: logs-index
|
|
36308
36543
|
type: string
|
|
36544
|
+
data_stream:
|
|
36545
|
+
$ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationDataStream'
|
|
36309
36546
|
id:
|
|
36310
36547
|
description: The unique identifier for this component.
|
|
36311
36548
|
example: elasticsearch-destination
|
|
@@ -36325,6 +36562,8 @@ components:
|
|
|
36325
36562
|
- type
|
|
36326
36563
|
- inputs
|
|
36327
36564
|
type: object
|
|
36565
|
+
x-pipeline-types:
|
|
36566
|
+
- logs
|
|
36328
36567
|
ObservabilityPipelineElasticsearchDestinationApiVersion:
|
|
36329
36568
|
description: The Elasticsearch API version to use. Set to `auto` to auto-detect.
|
|
36330
36569
|
enum:
|
|
@@ -36339,6 +36578,23 @@ components:
|
|
|
36339
36578
|
- V6
|
|
36340
36579
|
- V7
|
|
36341
36580
|
- V8
|
|
36581
|
+
ObservabilityPipelineElasticsearchDestinationDataStream:
|
|
36582
|
+
description: Configuration options for writing to Elasticsearch Data Streams
|
|
36583
|
+
instead of a fixed index.
|
|
36584
|
+
properties:
|
|
36585
|
+
dataset:
|
|
36586
|
+
description: The data stream dataset for your logs. This groups logs by
|
|
36587
|
+
their source or application.
|
|
36588
|
+
type: string
|
|
36589
|
+
dtype:
|
|
36590
|
+
description: The data stream type for your logs. This determines how logs
|
|
36591
|
+
are categorized within the data stream.
|
|
36592
|
+
type: string
|
|
36593
|
+
namespace:
|
|
36594
|
+
description: The data stream namespace for your logs. This separates logs
|
|
36595
|
+
into different environments or domains.
|
|
36596
|
+
type: string
|
|
36597
|
+
type: object
|
|
36342
36598
|
ObservabilityPipelineElasticsearchDestinationType:
|
|
36343
36599
|
default: elasticsearch
|
|
36344
36600
|
description: The destination type. The value should always be `elasticsearch`.
|
|
@@ -36478,13 +36734,17 @@ components:
|
|
|
36478
36734
|
- path
|
|
36479
36735
|
type: object
|
|
36480
36736
|
ObservabilityPipelineEnrichmentTableProcessor:
|
|
36481
|
-
description: The `enrichment_table` processor enriches logs using a static
|
|
36482
|
-
file or
|
|
36737
|
+
description: 'The `enrichment_table` processor enriches logs using a static
|
|
36738
|
+
CSV file, GeoIP database, or reference table. Exactly one of `file`, `geoip`,
|
|
36739
|
+
or `reference_table` must be configured.
|
|
36740
|
+
|
|
36741
|
+
|
|
36742
|
+
**Supported pipeline types:** logs'
|
|
36483
36743
|
properties:
|
|
36484
36744
|
display_name:
|
|
36485
36745
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36486
36746
|
enabled:
|
|
36487
|
-
description:
|
|
36747
|
+
description: Indicates whether the processor is enabled.
|
|
36488
36748
|
example: true
|
|
36489
36749
|
type: boolean
|
|
36490
36750
|
file:
|
|
@@ -36500,6 +36760,8 @@ components:
|
|
|
36500
36760
|
targets.
|
|
36501
36761
|
example: source:my-source
|
|
36502
36762
|
type: string
|
|
36763
|
+
reference_table:
|
|
36764
|
+
$ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableReferenceTable'
|
|
36503
36765
|
target:
|
|
36504
36766
|
description: Path where enrichment results should be stored in the log.
|
|
36505
36767
|
example: enriched.geoip
|
|
@@ -36513,6 +36775,8 @@ components:
|
|
|
36513
36775
|
- target
|
|
36514
36776
|
- enabled
|
|
36515
36777
|
type: object
|
|
36778
|
+
x-pipeline-types:
|
|
36779
|
+
- logs
|
|
36516
36780
|
ObservabilityPipelineEnrichmentTableProcessorType:
|
|
36517
36781
|
default: enrichment_table
|
|
36518
36782
|
description: The processor type. The value should always be `enrichment_table`.
|
|
@@ -36522,6 +36786,28 @@ components:
|
|
|
36522
36786
|
type: string
|
|
36523
36787
|
x-enum-varnames:
|
|
36524
36788
|
- ENRICHMENT_TABLE
|
|
36789
|
+
ObservabilityPipelineEnrichmentTableReferenceTable:
|
|
36790
|
+
description: Uses a Datadog reference table to enrich logs.
|
|
36791
|
+
properties:
|
|
36792
|
+
columns:
|
|
36793
|
+
description: List of column names to include from the reference table. If
|
|
36794
|
+
not provided, all columns are included.
|
|
36795
|
+
items:
|
|
36796
|
+
type: string
|
|
36797
|
+
type: array
|
|
36798
|
+
key_field:
|
|
36799
|
+
description: Path to the field in the log event to match against the reference
|
|
36800
|
+
table.
|
|
36801
|
+
example: log.user.id
|
|
36802
|
+
type: string
|
|
36803
|
+
table_id:
|
|
36804
|
+
description: The unique identifier of the reference table.
|
|
36805
|
+
example: 550e8400-e29b-41d4-a716-446655440000
|
|
36806
|
+
type: string
|
|
36807
|
+
required:
|
|
36808
|
+
- key_field
|
|
36809
|
+
- table_id
|
|
36810
|
+
type: object
|
|
36525
36811
|
ObservabilityPipelineFieldValue:
|
|
36526
36812
|
description: Represents a static key-value pair used in various processors.
|
|
36527
36813
|
properties:
|
|
@@ -36538,26 +36824,29 @@ components:
|
|
|
36538
36824
|
- value
|
|
36539
36825
|
type: object
|
|
36540
36826
|
ObservabilityPipelineFilterProcessor:
|
|
36541
|
-
description: The `filter` processor allows conditional processing of logs
|
|
36542
|
-
on a Datadog search query. Logs that match the `include` query
|
|
36543
|
-
through; others are discarded.
|
|
36827
|
+
description: 'The `filter` processor allows conditional processing of logs/metrics
|
|
36828
|
+
based on a Datadog search query. Logs/metrics that match the `include` query
|
|
36829
|
+
are passed through; others are discarded.
|
|
36830
|
+
|
|
36831
|
+
|
|
36832
|
+
**Supported pipeline types:** logs, metrics'
|
|
36544
36833
|
properties:
|
|
36545
36834
|
display_name:
|
|
36546
36835
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36547
36836
|
enabled:
|
|
36548
|
-
description:
|
|
36837
|
+
description: Indicates whether the processor is enabled.
|
|
36549
36838
|
example: true
|
|
36550
36839
|
type: boolean
|
|
36551
36840
|
id:
|
|
36552
|
-
description: The unique identifier for this component. Used
|
|
36553
|
-
|
|
36841
|
+
description: The unique identifier for this component. Used in other parts
|
|
36842
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
36554
36843
|
to downstream components).
|
|
36555
36844
|
example: filter-processor
|
|
36556
36845
|
type: string
|
|
36557
36846
|
include:
|
|
36558
|
-
description: A Datadog search query used to determine which logs
|
|
36559
|
-
pass through the filter. Logs that match this query continue
|
|
36560
|
-
components; others are dropped.
|
|
36847
|
+
description: A Datadog search query used to determine which logs/metrics
|
|
36848
|
+
should pass through the filter. Logs/metrics that match this query continue
|
|
36849
|
+
to downstream components; others are dropped.
|
|
36561
36850
|
example: service:my-service
|
|
36562
36851
|
type: string
|
|
36563
36852
|
type:
|
|
@@ -36568,6 +36857,9 @@ components:
|
|
|
36568
36857
|
- include
|
|
36569
36858
|
- enabled
|
|
36570
36859
|
type: object
|
|
36860
|
+
x-pipeline-types:
|
|
36861
|
+
- logs
|
|
36862
|
+
- metrics
|
|
36571
36863
|
ObservabilityPipelineFilterProcessorType:
|
|
36572
36864
|
default: filter
|
|
36573
36865
|
description: The processor type. The value should always be `filter`.
|
|
@@ -36578,11 +36870,14 @@ components:
|
|
|
36578
36870
|
x-enum-varnames:
|
|
36579
36871
|
- FILTER
|
|
36580
36872
|
ObservabilityPipelineFluentBitSource:
|
|
36581
|
-
description: The `fluent_bit` source ingests logs from Fluent Bit.
|
|
36873
|
+
description: 'The `fluent_bit` source ingests logs from Fluent Bit.
|
|
36874
|
+
|
|
36875
|
+
|
|
36876
|
+
**Supported pipeline types:** logs'
|
|
36582
36877
|
properties:
|
|
36583
36878
|
id:
|
|
36584
|
-
description: The unique identifier for this component. Used
|
|
36585
|
-
|
|
36879
|
+
description: The unique identifier for this component. Used in other parts
|
|
36880
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
36586
36881
|
to downstream components).
|
|
36587
36882
|
example: fluent-source
|
|
36588
36883
|
type: string
|
|
@@ -36594,6 +36889,8 @@ components:
|
|
|
36594
36889
|
- id
|
|
36595
36890
|
- type
|
|
36596
36891
|
type: object
|
|
36892
|
+
x-pipeline-types:
|
|
36893
|
+
- logs
|
|
36597
36894
|
ObservabilityPipelineFluentBitSourceType:
|
|
36598
36895
|
default: fluent_bit
|
|
36599
36896
|
description: The source type. The value should always be `fluent_bit`.
|
|
@@ -36604,11 +36901,14 @@ components:
|
|
|
36604
36901
|
x-enum-varnames:
|
|
36605
36902
|
- FLUENT_BIT
|
|
36606
36903
|
ObservabilityPipelineFluentdSource:
|
|
36607
|
-
description: The `fluentd` source ingests logs from a Fluentd-compatible service.
|
|
36904
|
+
description: 'The `fluentd` source ingests logs from a Fluentd-compatible service.
|
|
36905
|
+
|
|
36906
|
+
|
|
36907
|
+
**Supported pipeline types:** logs'
|
|
36608
36908
|
properties:
|
|
36609
36909
|
id:
|
|
36610
|
-
description: The unique identifier for this component. Used
|
|
36611
|
-
|
|
36910
|
+
description: The unique identifier for this component. Used in other parts
|
|
36911
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
36612
36912
|
to downstream components).
|
|
36613
36913
|
example: fluent-source
|
|
36614
36914
|
type: string
|
|
@@ -36620,6 +36920,8 @@ components:
|
|
|
36620
36920
|
- id
|
|
36621
36921
|
- type
|
|
36622
36922
|
type: object
|
|
36923
|
+
x-pipeline-types:
|
|
36924
|
+
- logs
|
|
36623
36925
|
ObservabilityPipelineFluentdSourceType:
|
|
36624
36926
|
default: fluentd
|
|
36625
36927
|
description: The source type. The value should always be `fluentd.
|
|
@@ -36644,12 +36946,15 @@ components:
|
|
|
36644
36946
|
from logs and sends them to Datadog.
|
|
36645
36947
|
|
|
36646
36948
|
Metrics can be counters, gauges, or distributions and optionally grouped by
|
|
36647
|
-
log fields.
|
|
36949
|
+
log fields.
|
|
36950
|
+
|
|
36951
|
+
|
|
36952
|
+
**Supported pipeline types:** logs'
|
|
36648
36953
|
properties:
|
|
36649
36954
|
display_name:
|
|
36650
36955
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36651
36956
|
enabled:
|
|
36652
|
-
description:
|
|
36957
|
+
description: Indicates whether the processor is enabled.
|
|
36653
36958
|
example: true
|
|
36654
36959
|
type: boolean
|
|
36655
36960
|
id:
|
|
@@ -36674,6 +36979,8 @@ components:
|
|
|
36674
36979
|
- type
|
|
36675
36980
|
- enabled
|
|
36676
36981
|
type: object
|
|
36982
|
+
x-pipeline-types:
|
|
36983
|
+
- logs
|
|
36677
36984
|
ObservabilityPipelineGenerateMetricsProcessorType:
|
|
36678
36985
|
default: generate_datadog_metrics
|
|
36679
36986
|
description: The processor type. Always `generate_datadog_metrics`.
|
|
@@ -36768,7 +37075,10 @@ components:
|
|
|
36768
37075
|
- GAUGE
|
|
36769
37076
|
- DISTRIBUTION
|
|
36770
37077
|
ObservabilityPipelineGoogleChronicleDestination:
|
|
36771
|
-
description: The `google_chronicle` destination sends logs to Google Chronicle.
|
|
37078
|
+
description: 'The `google_chronicle` destination sends logs to Google Chronicle.
|
|
37079
|
+
|
|
37080
|
+
|
|
37081
|
+
**Supported pipeline types:** logs'
|
|
36772
37082
|
properties:
|
|
36773
37083
|
auth:
|
|
36774
37084
|
$ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
|
|
@@ -36802,6 +37112,8 @@ components:
|
|
|
36802
37112
|
- inputs
|
|
36803
37113
|
- customer_id
|
|
36804
37114
|
type: object
|
|
37115
|
+
x-pipeline-types:
|
|
37116
|
+
- logs
|
|
36805
37117
|
ObservabilityPipelineGoogleChronicleDestinationEncoding:
|
|
36806
37118
|
description: The encoding format for the logs sent to Chronicle.
|
|
36807
37119
|
enum:
|
|
@@ -36825,7 +37137,10 @@ components:
|
|
|
36825
37137
|
description: 'The `google_cloud_storage` destination stores logs in a Google
|
|
36826
37138
|
Cloud Storage (GCS) bucket.
|
|
36827
37139
|
|
|
36828
|
-
It requires a bucket name, GCP authentication, and metadata fields.
|
|
37140
|
+
It requires a bucket name, GCP authentication, and metadata fields.
|
|
37141
|
+
|
|
37142
|
+
|
|
37143
|
+
**Supported pipeline types:** logs'
|
|
36829
37144
|
properties:
|
|
36830
37145
|
acl:
|
|
36831
37146
|
$ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationAcl'
|
|
@@ -36867,6 +37182,8 @@ components:
|
|
|
36867
37182
|
- bucket
|
|
36868
37183
|
- storage_class
|
|
36869
37184
|
type: object
|
|
37185
|
+
x-pipeline-types:
|
|
37186
|
+
- logs
|
|
36870
37187
|
ObservabilityPipelineGoogleCloudStorageDestinationAcl:
|
|
36871
37188
|
description: Access control list setting for objects written to the bucket.
|
|
36872
37189
|
enum:
|
|
@@ -36909,8 +37226,11 @@ components:
|
|
|
36909
37226
|
x-enum-varnames:
|
|
36910
37227
|
- GOOGLE_CLOUD_STORAGE
|
|
36911
37228
|
ObservabilityPipelineGooglePubSubDestination:
|
|
36912
|
-
description: The `google_pubsub` destination publishes logs to a Google Cloud
|
|
37229
|
+
description: 'The `google_pubsub` destination publishes logs to a Google Cloud
|
|
36913
37230
|
Pub/Sub topic.
|
|
37231
|
+
|
|
37232
|
+
|
|
37233
|
+
**Supported pipeline types:** logs'
|
|
36914
37234
|
properties:
|
|
36915
37235
|
auth:
|
|
36916
37236
|
$ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
|
|
@@ -36948,6 +37268,8 @@ components:
|
|
|
36948
37268
|
- project
|
|
36949
37269
|
- topic
|
|
36950
37270
|
type: object
|
|
37271
|
+
x-pipeline-types:
|
|
37272
|
+
- logs
|
|
36951
37273
|
ObservabilityPipelineGooglePubSubDestinationEncoding:
|
|
36952
37274
|
description: Encoding format for log events.
|
|
36953
37275
|
enum:
|
|
@@ -36968,17 +37290,20 @@ components:
|
|
|
36968
37290
|
x-enum-varnames:
|
|
36969
37291
|
- GOOGLE_PUBSUB
|
|
36970
37292
|
ObservabilityPipelineGooglePubSubSource:
|
|
36971
|
-
description: The `google_pubsub` source ingests logs from a Google Cloud Pub/Sub
|
|
37293
|
+
description: 'The `google_pubsub` source ingests logs from a Google Cloud Pub/Sub
|
|
36972
37294
|
subscription.
|
|
37295
|
+
|
|
37296
|
+
|
|
37297
|
+
**Supported pipeline types:** logs'
|
|
36973
37298
|
properties:
|
|
36974
37299
|
auth:
|
|
36975
37300
|
$ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
|
|
36976
37301
|
decoding:
|
|
36977
37302
|
$ref: '#/components/schemas/ObservabilityPipelineDecoding'
|
|
36978
37303
|
id:
|
|
36979
|
-
description: The unique identifier for this component. Used
|
|
36980
|
-
|
|
36981
|
-
components).
|
|
37304
|
+
description: The unique identifier for this component. Used in other parts
|
|
37305
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
37306
|
+
to downstream components).
|
|
36982
37307
|
example: google-pubsub-source
|
|
36983
37308
|
type: string
|
|
36984
37309
|
project:
|
|
@@ -37000,6 +37325,8 @@ components:
|
|
|
37000
37325
|
- project
|
|
37001
37326
|
- subscription
|
|
37002
37327
|
type: object
|
|
37328
|
+
x-pipeline-types:
|
|
37329
|
+
- logs
|
|
37003
37330
|
ObservabilityPipelineGooglePubSubSourceType:
|
|
37004
37331
|
default: google_pubsub
|
|
37005
37332
|
description: The source type. The value should always be `google_pubsub`.
|
|
@@ -37009,18 +37336,103 @@ components:
|
|
|
37009
37336
|
type: string
|
|
37010
37337
|
x-enum-varnames:
|
|
37011
37338
|
- GOOGLE_PUBSUB
|
|
37339
|
+
ObservabilityPipelineHttpClientDestination:
|
|
37340
|
+
description: 'The `http_client` destination sends data to an HTTP endpoint.
|
|
37341
|
+
|
|
37342
|
+
|
|
37343
|
+
**Supported pipeline types:** logs, metrics'
|
|
37344
|
+
properties:
|
|
37345
|
+
auth_strategy:
|
|
37346
|
+
$ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationAuthStrategy'
|
|
37347
|
+
compression:
|
|
37348
|
+
$ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationCompression'
|
|
37349
|
+
encoding:
|
|
37350
|
+
$ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationEncoding'
|
|
37351
|
+
id:
|
|
37352
|
+
description: The unique identifier for this component.
|
|
37353
|
+
example: http-client-destination
|
|
37354
|
+
type: string
|
|
37355
|
+
inputs:
|
|
37356
|
+
description: A list of component IDs whose output is used as the input for
|
|
37357
|
+
this component.
|
|
37358
|
+
example:
|
|
37359
|
+
- filter-processor
|
|
37360
|
+
items:
|
|
37361
|
+
type: string
|
|
37362
|
+
type: array
|
|
37363
|
+
tls:
|
|
37364
|
+
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
|
37365
|
+
type:
|
|
37366
|
+
$ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationType'
|
|
37367
|
+
required:
|
|
37368
|
+
- id
|
|
37369
|
+
- type
|
|
37370
|
+
- inputs
|
|
37371
|
+
- encoding
|
|
37372
|
+
type: object
|
|
37373
|
+
x-pipeline-types:
|
|
37374
|
+
- logs
|
|
37375
|
+
- metrics
|
|
37376
|
+
ObservabilityPipelineHttpClientDestinationAuthStrategy:
|
|
37377
|
+
description: HTTP authentication strategy.
|
|
37378
|
+
enum:
|
|
37379
|
+
- none
|
|
37380
|
+
- basic
|
|
37381
|
+
- bearer
|
|
37382
|
+
example: basic
|
|
37383
|
+
type: string
|
|
37384
|
+
x-enum-varnames:
|
|
37385
|
+
- NONE
|
|
37386
|
+
- BASIC
|
|
37387
|
+
- BEARER
|
|
37388
|
+
ObservabilityPipelineHttpClientDestinationCompression:
|
|
37389
|
+
description: Compression configuration for HTTP requests.
|
|
37390
|
+
properties:
|
|
37391
|
+
algorithm:
|
|
37392
|
+
$ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationCompressionAlgorithm'
|
|
37393
|
+
required:
|
|
37394
|
+
- algorithm
|
|
37395
|
+
type: object
|
|
37396
|
+
ObservabilityPipelineHttpClientDestinationCompressionAlgorithm:
|
|
37397
|
+
description: Compression algorithm.
|
|
37398
|
+
enum:
|
|
37399
|
+
- gzip
|
|
37400
|
+
example: gzip
|
|
37401
|
+
type: string
|
|
37402
|
+
x-enum-varnames:
|
|
37403
|
+
- GZIP
|
|
37404
|
+
ObservabilityPipelineHttpClientDestinationEncoding:
|
|
37405
|
+
description: Encoding format for log events.
|
|
37406
|
+
enum:
|
|
37407
|
+
- json
|
|
37408
|
+
example: json
|
|
37409
|
+
type: string
|
|
37410
|
+
x-enum-varnames:
|
|
37411
|
+
- JSON
|
|
37412
|
+
ObservabilityPipelineHttpClientDestinationType:
|
|
37413
|
+
default: http_client
|
|
37414
|
+
description: The destination type. The value should always be `http_client`.
|
|
37415
|
+
enum:
|
|
37416
|
+
- http_client
|
|
37417
|
+
example: http_client
|
|
37418
|
+
type: string
|
|
37419
|
+
x-enum-varnames:
|
|
37420
|
+
- HTTP_CLIENT
|
|
37012
37421
|
ObservabilityPipelineHttpClientSource:
|
|
37013
|
-
description: The `http_client` source scrapes logs from HTTP endpoints at regular
|
|
37422
|
+
description: 'The `http_client` source scrapes logs from HTTP endpoints at regular
|
|
37014
37423
|
intervals.
|
|
37424
|
+
|
|
37425
|
+
|
|
37426
|
+
**Supported pipeline types:** logs'
|
|
37015
37427
|
properties:
|
|
37016
37428
|
auth_strategy:
|
|
37017
37429
|
$ref: '#/components/schemas/ObservabilityPipelineHttpClientSourceAuthStrategy'
|
|
37018
37430
|
decoding:
|
|
37019
37431
|
$ref: '#/components/schemas/ObservabilityPipelineDecoding'
|
|
37020
37432
|
id:
|
|
37021
|
-
description: The unique identifier for this component. Used
|
|
37022
|
-
|
|
37023
|
-
components).
|
|
37433
|
+
description: The unique identifier for this component. Used in other parts
|
|
37434
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
37435
|
+
to downstream components).
|
|
37024
37436
|
example: http-client-source
|
|
37025
37437
|
type: string
|
|
37026
37438
|
scrape_interval_secs:
|
|
@@ -37042,14 +37454,18 @@ components:
|
|
|
37042
37454
|
- type
|
|
37043
37455
|
- decoding
|
|
37044
37456
|
type: object
|
|
37457
|
+
x-pipeline-types:
|
|
37458
|
+
- logs
|
|
37045
37459
|
ObservabilityPipelineHttpClientSourceAuthStrategy:
|
|
37046
37460
|
description: Optional authentication strategy for HTTP requests.
|
|
37047
37461
|
enum:
|
|
37462
|
+
- none
|
|
37048
37463
|
- basic
|
|
37049
37464
|
- bearer
|
|
37050
37465
|
example: basic
|
|
37051
37466
|
type: string
|
|
37052
37467
|
x-enum-varnames:
|
|
37468
|
+
- NONE
|
|
37053
37469
|
- BASIC
|
|
37054
37470
|
- BEARER
|
|
37055
37471
|
ObservabilityPipelineHttpClientSourceType:
|
|
@@ -37062,8 +37478,11 @@ components:
|
|
|
37062
37478
|
x-enum-varnames:
|
|
37063
37479
|
- HTTP_CLIENT
|
|
37064
37480
|
ObservabilityPipelineHttpServerSource:
|
|
37065
|
-
description: The `http_server` source collects logs over HTTP POST from external
|
|
37481
|
+
description: 'The `http_server` source collects logs over HTTP POST from external
|
|
37066
37482
|
services.
|
|
37483
|
+
|
|
37484
|
+
|
|
37485
|
+
**Supported pipeline types:** logs'
|
|
37067
37486
|
properties:
|
|
37068
37487
|
auth_strategy:
|
|
37069
37488
|
$ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceAuthStrategy'
|
|
@@ -37083,6 +37502,8 @@ components:
|
|
|
37083
37502
|
- auth_strategy
|
|
37084
37503
|
- decoding
|
|
37085
37504
|
type: object
|
|
37505
|
+
x-pipeline-types:
|
|
37506
|
+
- logs
|
|
37086
37507
|
ObservabilityPipelineHttpServerSourceAuthStrategy:
|
|
37087
37508
|
description: HTTP authentication method.
|
|
37088
37509
|
enum:
|
|
@@ -37102,50 +37523,125 @@ components:
|
|
|
37102
37523
|
type: string
|
|
37103
37524
|
x-enum-varnames:
|
|
37104
37525
|
- HTTP_SERVER
|
|
37105
|
-
|
|
37106
|
-
description: The `kafka`
|
|
37526
|
+
ObservabilityPipelineKafkaDestination:
|
|
37527
|
+
description: 'The `kafka` destination sends logs to Apache Kafka topics.
|
|
37528
|
+
|
|
37529
|
+
|
|
37530
|
+
**Supported pipeline types:** logs'
|
|
37107
37531
|
properties:
|
|
37108
|
-
|
|
37109
|
-
|
|
37110
|
-
|
|
37532
|
+
compression:
|
|
37533
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationCompression'
|
|
37534
|
+
encoding:
|
|
37535
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationEncoding'
|
|
37536
|
+
headers_key:
|
|
37537
|
+
description: The field name to use for Kafka message headers.
|
|
37538
|
+
example: headers
|
|
37111
37539
|
type: string
|
|
37112
37540
|
id:
|
|
37113
|
-
description: The unique identifier for this component.
|
|
37114
|
-
|
|
37115
|
-
|
|
37116
|
-
|
|
37541
|
+
description: The unique identifier for this component.
|
|
37542
|
+
example: kafka-destination
|
|
37543
|
+
type: string
|
|
37544
|
+
inputs:
|
|
37545
|
+
description: A list of component IDs whose output is used as the `input`
|
|
37546
|
+
for this component.
|
|
37547
|
+
example:
|
|
37548
|
+
- filter-processor
|
|
37549
|
+
items:
|
|
37550
|
+
type: string
|
|
37551
|
+
type: array
|
|
37552
|
+
key_field:
|
|
37553
|
+
description: The field name to use as the Kafka message key.
|
|
37554
|
+
example: message_id
|
|
37117
37555
|
type: string
|
|
37118
37556
|
librdkafka_options:
|
|
37119
|
-
description: Optional list of advanced Kafka
|
|
37557
|
+
description: Optional list of advanced Kafka producer configuration options,
|
|
37120
37558
|
defined as key-value pairs.
|
|
37121
37559
|
items:
|
|
37122
|
-
$ref: '#/components/schemas/
|
|
37560
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption'
|
|
37123
37561
|
type: array
|
|
37562
|
+
message_timeout_ms:
|
|
37563
|
+
description: Maximum time in milliseconds to wait for message delivery confirmation.
|
|
37564
|
+
example: 300000
|
|
37565
|
+
format: int64
|
|
37566
|
+
minimum: 1
|
|
37567
|
+
type: integer
|
|
37568
|
+
rate_limit_duration_secs:
|
|
37569
|
+
description: Duration in seconds for the rate limit window.
|
|
37570
|
+
example: 1
|
|
37571
|
+
format: int64
|
|
37572
|
+
minimum: 1
|
|
37573
|
+
type: integer
|
|
37574
|
+
rate_limit_num:
|
|
37575
|
+
description: Maximum number of messages allowed per rate limit duration.
|
|
37576
|
+
example: 1000
|
|
37577
|
+
format: int64
|
|
37578
|
+
minimum: 1
|
|
37579
|
+
type: integer
|
|
37124
37580
|
sasl:
|
|
37125
|
-
$ref: '#/components/schemas/
|
|
37581
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaSasl'
|
|
37582
|
+
socket_timeout_ms:
|
|
37583
|
+
description: Socket timeout in milliseconds for network requests.
|
|
37584
|
+
example: 60000
|
|
37585
|
+
format: int64
|
|
37586
|
+
maximum: 300000
|
|
37587
|
+
minimum: 10
|
|
37588
|
+
type: integer
|
|
37126
37589
|
tls:
|
|
37127
37590
|
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
|
37128
|
-
|
|
37129
|
-
description:
|
|
37130
|
-
|
|
37131
|
-
|
|
37132
|
-
- topic1
|
|
37133
|
-
- topic2
|
|
37134
|
-
items:
|
|
37135
|
-
type: string
|
|
37136
|
-
type: array
|
|
37591
|
+
topic:
|
|
37592
|
+
description: The Kafka topic name to publish logs to.
|
|
37593
|
+
example: logs-topic
|
|
37594
|
+
type: string
|
|
37137
37595
|
type:
|
|
37138
|
-
$ref: '#/components/schemas/
|
|
37596
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationType'
|
|
37139
37597
|
required:
|
|
37140
37598
|
- id
|
|
37141
37599
|
- type
|
|
37142
|
-
-
|
|
37143
|
-
-
|
|
37600
|
+
- inputs
|
|
37601
|
+
- topic
|
|
37602
|
+
- encoding
|
|
37144
37603
|
type: object
|
|
37145
|
-
|
|
37604
|
+
x-pipeline-types:
|
|
37605
|
+
- logs
|
|
37606
|
+
ObservabilityPipelineKafkaDestinationCompression:
|
|
37607
|
+
description: Compression codec for Kafka messages.
|
|
37608
|
+
enum:
|
|
37609
|
+
- none
|
|
37610
|
+
- gzip
|
|
37611
|
+
- snappy
|
|
37612
|
+
- lz4
|
|
37613
|
+
- zstd
|
|
37614
|
+
example: gzip
|
|
37615
|
+
type: string
|
|
37616
|
+
x-enum-varnames:
|
|
37617
|
+
- NONE
|
|
37618
|
+
- GZIP
|
|
37619
|
+
- SNAPPY
|
|
37620
|
+
- LZ4
|
|
37621
|
+
- ZSTD
|
|
37622
|
+
ObservabilityPipelineKafkaDestinationEncoding:
|
|
37623
|
+
description: Encoding format for log events.
|
|
37624
|
+
enum:
|
|
37625
|
+
- json
|
|
37626
|
+
- raw_message
|
|
37627
|
+
example: json
|
|
37628
|
+
type: string
|
|
37629
|
+
x-enum-varnames:
|
|
37630
|
+
- JSON
|
|
37631
|
+
- RAW_MESSAGE
|
|
37632
|
+
ObservabilityPipelineKafkaDestinationType:
|
|
37633
|
+
default: kafka
|
|
37634
|
+
description: The destination type. The value should always be `kafka`.
|
|
37635
|
+
enum:
|
|
37636
|
+
- kafka
|
|
37637
|
+
example: kafka
|
|
37638
|
+
type: string
|
|
37639
|
+
x-enum-varnames:
|
|
37640
|
+
- KAFKA
|
|
37641
|
+
ObservabilityPipelineKafkaLibrdkafkaOption:
|
|
37146
37642
|
description: Represents a key-value pair used to configure low-level `librdkafka`
|
|
37147
|
-
client options for Kafka
|
|
37148
|
-
settings.
|
|
37643
|
+
client options for Kafka source and destination, such as timeouts, buffer
|
|
37644
|
+
sizes, and security settings.
|
|
37149
37645
|
properties:
|
|
37150
37646
|
name:
|
|
37151
37647
|
description: The name of the `librdkafka` configuration option to set.
|
|
@@ -37160,12 +37656,68 @@ components:
|
|
|
37160
37656
|
- name
|
|
37161
37657
|
- value
|
|
37162
37658
|
type: object
|
|
37163
|
-
|
|
37659
|
+
ObservabilityPipelineKafkaSasl:
|
|
37164
37660
|
description: Specifies the SASL mechanism for authenticating with a Kafka cluster.
|
|
37165
37661
|
properties:
|
|
37166
37662
|
mechanism:
|
|
37167
|
-
$ref: '#/components/schemas/
|
|
37663
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaSaslMechanism'
|
|
37168
37664
|
type: object
|
|
37665
|
+
ObservabilityPipelineKafkaSaslMechanism:
|
|
37666
|
+
description: SASL mechanism used for Kafka authentication.
|
|
37667
|
+
enum:
|
|
37668
|
+
- PLAIN
|
|
37669
|
+
- SCRAM-SHA-256
|
|
37670
|
+
- SCRAM-SHA-512
|
|
37671
|
+
type: string
|
|
37672
|
+
x-enum-varnames:
|
|
37673
|
+
- PLAIN
|
|
37674
|
+
- SCRAMNOT_SHANOT_256
|
|
37675
|
+
- SCRAMNOT_SHANOT_512
|
|
37676
|
+
ObservabilityPipelineKafkaSource:
|
|
37677
|
+
description: 'The `kafka` source ingests data from Apache Kafka topics.
|
|
37678
|
+
|
|
37679
|
+
|
|
37680
|
+
**Supported pipeline types:** logs'
|
|
37681
|
+
properties:
|
|
37682
|
+
group_id:
|
|
37683
|
+
description: Consumer group ID used by the Kafka client.
|
|
37684
|
+
example: consumer-group-0
|
|
37685
|
+
type: string
|
|
37686
|
+
id:
|
|
37687
|
+
description: The unique identifier for this component. Used in other parts
|
|
37688
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
37689
|
+
to downstream components).
|
|
37690
|
+
example: kafka-source
|
|
37691
|
+
type: string
|
|
37692
|
+
librdkafka_options:
|
|
37693
|
+
description: Optional list of advanced Kafka client configuration options,
|
|
37694
|
+
defined as key-value pairs.
|
|
37695
|
+
items:
|
|
37696
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption'
|
|
37697
|
+
type: array
|
|
37698
|
+
sasl:
|
|
37699
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaSasl'
|
|
37700
|
+
tls:
|
|
37701
|
+
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
|
37702
|
+
topics:
|
|
37703
|
+
description: A list of Kafka topic names to subscribe to. The source ingests
|
|
37704
|
+
messages from each topic specified.
|
|
37705
|
+
example:
|
|
37706
|
+
- topic1
|
|
37707
|
+
- topic2
|
|
37708
|
+
items:
|
|
37709
|
+
type: string
|
|
37710
|
+
type: array
|
|
37711
|
+
type:
|
|
37712
|
+
$ref: '#/components/schemas/ObservabilityPipelineKafkaSourceType'
|
|
37713
|
+
required:
|
|
37714
|
+
- id
|
|
37715
|
+
- type
|
|
37716
|
+
- group_id
|
|
37717
|
+
- topics
|
|
37718
|
+
type: object
|
|
37719
|
+
x-pipeline-types:
|
|
37720
|
+
- logs
|
|
37169
37721
|
ObservabilityPipelineKafkaSourceType:
|
|
37170
37722
|
default: kafka
|
|
37171
37723
|
description: The source type. The value should always be `kafka`.
|
|
@@ -37176,12 +37728,15 @@ components:
|
|
|
37176
37728
|
x-enum-varnames:
|
|
37177
37729
|
- KAFKA
|
|
37178
37730
|
ObservabilityPipelineLogstashSource:
|
|
37179
|
-
description: The `logstash` source ingests logs from a Logstash forwarder.
|
|
37731
|
+
description: 'The `logstash` source ingests logs from a Logstash forwarder.
|
|
37732
|
+
|
|
37733
|
+
|
|
37734
|
+
**Supported pipeline types:** logs'
|
|
37180
37735
|
properties:
|
|
37181
37736
|
id:
|
|
37182
|
-
description: The unique identifier for this component. Used
|
|
37183
|
-
|
|
37184
|
-
components).
|
|
37737
|
+
description: The unique identifier for this component. Used in other parts
|
|
37738
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
37739
|
+
to downstream components).
|
|
37185
37740
|
example: logstash-source
|
|
37186
37741
|
type: string
|
|
37187
37742
|
tls:
|
|
@@ -37192,6 +37747,8 @@ components:
|
|
|
37192
37747
|
- id
|
|
37193
37748
|
- type
|
|
37194
37749
|
type: object
|
|
37750
|
+
x-pipeline-types:
|
|
37751
|
+
- logs
|
|
37195
37752
|
ObservabilityPipelineLogstashSourceType:
|
|
37196
37753
|
default: logstash
|
|
37197
37754
|
description: The source type. The value should always be `logstash`.
|
|
@@ -37216,13 +37773,112 @@ components:
|
|
|
37216
37773
|
- name
|
|
37217
37774
|
- value
|
|
37218
37775
|
type: object
|
|
37776
|
+
ObservabilityPipelineMetricTagsProcessor:
|
|
37777
|
+
description: 'The `metric_tags` processor filters metrics based on their tags
|
|
37778
|
+
using Datadog tag key patterns.
|
|
37779
|
+
|
|
37780
|
+
|
|
37781
|
+
**Supported pipeline types:** metrics'
|
|
37782
|
+
properties:
|
|
37783
|
+
display_name:
|
|
37784
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37785
|
+
enabled:
|
|
37786
|
+
description: Indicates whether the processor is enabled.
|
|
37787
|
+
example: true
|
|
37788
|
+
type: boolean
|
|
37789
|
+
id:
|
|
37790
|
+
description: The unique identifier for this component. Used in other parts
|
|
37791
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
37792
|
+
to downstream components).
|
|
37793
|
+
example: metric-tags-processor
|
|
37794
|
+
type: string
|
|
37795
|
+
include:
|
|
37796
|
+
description: A Datadog search query that determines which metrics the processor
|
|
37797
|
+
targets.
|
|
37798
|
+
example: '*'
|
|
37799
|
+
type: string
|
|
37800
|
+
rules:
|
|
37801
|
+
description: A list of rules for filtering metric tags.
|
|
37802
|
+
items:
|
|
37803
|
+
$ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRule'
|
|
37804
|
+
maxItems: 100
|
|
37805
|
+
minItems: 1
|
|
37806
|
+
type: array
|
|
37807
|
+
type:
|
|
37808
|
+
$ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorType'
|
|
37809
|
+
required:
|
|
37810
|
+
- id
|
|
37811
|
+
- type
|
|
37812
|
+
- include
|
|
37813
|
+
- rules
|
|
37814
|
+
- enabled
|
|
37815
|
+
type: object
|
|
37816
|
+
x-pipeline-types:
|
|
37817
|
+
- metrics
|
|
37818
|
+
ObservabilityPipelineMetricTagsProcessorRule:
|
|
37819
|
+
description: Defines a rule for filtering metric tags based on key patterns.
|
|
37820
|
+
properties:
|
|
37821
|
+
action:
|
|
37822
|
+
$ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleAction'
|
|
37823
|
+
include:
|
|
37824
|
+
description: A Datadog search query used to determine which metrics this
|
|
37825
|
+
rule targets.
|
|
37826
|
+
example: '*'
|
|
37827
|
+
type: string
|
|
37828
|
+
keys:
|
|
37829
|
+
description: A list of tag keys to include or exclude.
|
|
37830
|
+
example:
|
|
37831
|
+
- env
|
|
37832
|
+
- service
|
|
37833
|
+
- version
|
|
37834
|
+
items:
|
|
37835
|
+
type: string
|
|
37836
|
+
type: array
|
|
37837
|
+
mode:
|
|
37838
|
+
$ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleMode'
|
|
37839
|
+
required:
|
|
37840
|
+
- include
|
|
37841
|
+
- mode
|
|
37842
|
+
- action
|
|
37843
|
+
- keys
|
|
37844
|
+
type: object
|
|
37845
|
+
ObservabilityPipelineMetricTagsProcessorRuleAction:
|
|
37846
|
+
description: The action to take on tags with matching keys.
|
|
37847
|
+
enum:
|
|
37848
|
+
- include
|
|
37849
|
+
- exclude
|
|
37850
|
+
example: include
|
|
37851
|
+
type: string
|
|
37852
|
+
x-enum-varnames:
|
|
37853
|
+
- INCLUDE
|
|
37854
|
+
- EXCLUDE
|
|
37855
|
+
ObservabilityPipelineMetricTagsProcessorRuleMode:
|
|
37856
|
+
description: The processing mode for tag filtering.
|
|
37857
|
+
enum:
|
|
37858
|
+
- filter
|
|
37859
|
+
example: filter
|
|
37860
|
+
type: string
|
|
37861
|
+
x-enum-varnames:
|
|
37862
|
+
- FILTER
|
|
37863
|
+
ObservabilityPipelineMetricTagsProcessorType:
|
|
37864
|
+
default: metric_tags
|
|
37865
|
+
description: The processor type. The value should always be `metric_tags`.
|
|
37866
|
+
enum:
|
|
37867
|
+
- metric_tags
|
|
37868
|
+
example: metric_tags
|
|
37869
|
+
type: string
|
|
37870
|
+
x-enum-varnames:
|
|
37871
|
+
- METRIC_TAGS
|
|
37219
37872
|
ObservabilityPipelineMetricValue:
|
|
37220
37873
|
description: Specifies how the value of the generated metric is computed.
|
|
37221
37874
|
oneOf:
|
|
37222
37875
|
- $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOne'
|
|
37223
37876
|
- $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByField'
|
|
37224
37877
|
ObservabilityPipelineNewRelicDestination:
|
|
37225
|
-
description: The `new_relic` destination sends logs to the New Relic platform.
|
|
37878
|
+
description: 'The `new_relic` destination sends logs to the New Relic platform.
|
|
37879
|
+
|
|
37880
|
+
|
|
37881
|
+
**Supported pipeline types:** logs'
|
|
37226
37882
|
properties:
|
|
37227
37883
|
id:
|
|
37228
37884
|
description: The unique identifier for this component.
|
|
@@ -37246,6 +37902,8 @@ components:
|
|
|
37246
37902
|
- inputs
|
|
37247
37903
|
- region
|
|
37248
37904
|
type: object
|
|
37905
|
+
x-pipeline-types:
|
|
37906
|
+
- logs
|
|
37249
37907
|
ObservabilityPipelineNewRelicDestinationRegion:
|
|
37250
37908
|
description: The New Relic region.
|
|
37251
37909
|
enum:
|
|
@@ -37266,13 +37924,16 @@ components:
|
|
|
37266
37924
|
x-enum-varnames:
|
|
37267
37925
|
- NEW_RELIC
|
|
37268
37926
|
ObservabilityPipelineOcsfMapperProcessor:
|
|
37269
|
-
description: The `ocsf_mapper` processor transforms logs into the OCSF schema
|
|
37927
|
+
description: 'The `ocsf_mapper` processor transforms logs into the OCSF schema
|
|
37270
37928
|
using a predefined mapping configuration.
|
|
37929
|
+
|
|
37930
|
+
|
|
37931
|
+
**Supported pipeline types:** logs'
|
|
37271
37932
|
properties:
|
|
37272
37933
|
display_name:
|
|
37273
37934
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37274
37935
|
enabled:
|
|
37275
|
-
description:
|
|
37936
|
+
description: Indicates whether the processor is enabled.
|
|
37276
37937
|
example: true
|
|
37277
37938
|
type: boolean
|
|
37278
37939
|
id:
|
|
@@ -37299,6 +37960,8 @@ components:
|
|
|
37299
37960
|
- mappings
|
|
37300
37961
|
- enabled
|
|
37301
37962
|
type: object
|
|
37963
|
+
x-pipeline-types:
|
|
37964
|
+
- logs
|
|
37302
37965
|
ObservabilityPipelineOcsfMapperProcessorMapping:
|
|
37303
37966
|
description: Defines how specific events are transformed to OCSF using a mapping
|
|
37304
37967
|
configuration.
|
|
@@ -37358,7 +38021,10 @@ components:
|
|
|
37358
38021
|
- OKTA_SYSTEM_LOG_AUTHENTICATION
|
|
37359
38022
|
- PALO_ALTO_NETWORKS_FIREWALL_TRAFFIC
|
|
37360
38023
|
ObservabilityPipelineOpenSearchDestination:
|
|
37361
|
-
description: The `opensearch` destination writes logs to an OpenSearch cluster.
|
|
38024
|
+
description: 'The `opensearch` destination writes logs to an OpenSearch cluster.
|
|
38025
|
+
|
|
38026
|
+
|
|
38027
|
+
**Supported pipeline types:** logs'
|
|
37362
38028
|
properties:
|
|
37363
38029
|
bulk_index:
|
|
37364
38030
|
description: The index to write logs to.
|
|
@@ -37383,6 +38049,8 @@ components:
|
|
|
37383
38049
|
- type
|
|
37384
38050
|
- inputs
|
|
37385
38051
|
type: object
|
|
38052
|
+
x-pipeline-types:
|
|
38053
|
+
- logs
|
|
37386
38054
|
ObservabilityPipelineOpenSearchDestinationType:
|
|
37387
38055
|
default: opensearch
|
|
37388
38056
|
description: The destination type. The value should always be `opensearch`.
|
|
@@ -37392,9 +38060,56 @@ components:
|
|
|
37392
38060
|
type: string
|
|
37393
38061
|
x-enum-varnames:
|
|
37394
38062
|
- OPENSEARCH
|
|
38063
|
+
ObservabilityPipelineOpentelemetrySource:
|
|
38064
|
+
description: 'The `opentelemetry` source receives telemetry data using the OpenTelemetry
|
|
38065
|
+
Protocol (OTLP) over gRPC and HTTP.
|
|
38066
|
+
|
|
38067
|
+
|
|
38068
|
+
**Supported pipeline types:** logs'
|
|
38069
|
+
properties:
|
|
38070
|
+
grpc_address_key:
|
|
38071
|
+
description: Environment variable name containing the gRPC server address
|
|
38072
|
+
for receiving OTLP data. Must be a valid environment variable name (alphanumeric
|
|
38073
|
+
characters and underscores only).
|
|
38074
|
+
example: OTEL_GRPC_ADDRESS
|
|
38075
|
+
type: string
|
|
38076
|
+
http_address_key:
|
|
38077
|
+
description: Environment variable name containing the HTTP server address
|
|
38078
|
+
for receiving OTLP data. Must be a valid environment variable name (alphanumeric
|
|
38079
|
+
characters and underscores only).
|
|
38080
|
+
example: OTEL_HTTP_ADDRESS
|
|
38081
|
+
type: string
|
|
38082
|
+
id:
|
|
38083
|
+
description: The unique identifier for this component. Used in other parts
|
|
38084
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
38085
|
+
to downstream components).
|
|
38086
|
+
example: opentelemetry-source
|
|
38087
|
+
type: string
|
|
38088
|
+
tls:
|
|
38089
|
+
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
|
38090
|
+
type:
|
|
38091
|
+
$ref: '#/components/schemas/ObservabilityPipelineOpentelemetrySourceType'
|
|
38092
|
+
required:
|
|
38093
|
+
- id
|
|
38094
|
+
- type
|
|
38095
|
+
type: object
|
|
38096
|
+
x-pipeline-types:
|
|
38097
|
+
- logs
|
|
38098
|
+
ObservabilityPipelineOpentelemetrySourceType:
|
|
38099
|
+
default: opentelemetry
|
|
38100
|
+
description: The source type. The value should always be `opentelemetry`.
|
|
38101
|
+
enum:
|
|
38102
|
+
- opentelemetry
|
|
38103
|
+
example: opentelemetry
|
|
38104
|
+
type: string
|
|
38105
|
+
x-enum-varnames:
|
|
38106
|
+
- OPENTELEMETRY
|
|
37395
38107
|
ObservabilityPipelineParseGrokProcessor:
|
|
37396
|
-
description: The `parse_grok` processor extracts structured fields from unstructured
|
|
38108
|
+
description: 'The `parse_grok` processor extracts structured fields from unstructured
|
|
37397
38109
|
log messages using Grok patterns.
|
|
38110
|
+
|
|
38111
|
+
|
|
38112
|
+
**Supported pipeline types:** logs'
|
|
37398
38113
|
properties:
|
|
37399
38114
|
disable_library_rules:
|
|
37400
38115
|
default: false
|
|
@@ -37405,7 +38120,7 @@ components:
|
|
|
37405
38120
|
display_name:
|
|
37406
38121
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37407
38122
|
enabled:
|
|
37408
|
-
description:
|
|
38123
|
+
description: Indicates whether the processor is enabled.
|
|
37409
38124
|
example: true
|
|
37410
38125
|
type: boolean
|
|
37411
38126
|
id:
|
|
@@ -37433,6 +38148,8 @@ components:
|
|
|
37433
38148
|
- rules
|
|
37434
38149
|
- enabled
|
|
37435
38150
|
type: object
|
|
38151
|
+
x-pipeline-types:
|
|
38152
|
+
- logs
|
|
37436
38153
|
ObservabilityPipelineParseGrokProcessorRule:
|
|
37437
38154
|
description: 'A Grok parsing rule used in the `parse_grok` processor. Each rule
|
|
37438
38155
|
defines how to extract structured fields
|
|
@@ -37512,14 +38229,17 @@ components:
|
|
|
37512
38229
|
x-enum-varnames:
|
|
37513
38230
|
- PARSE_GROK
|
|
37514
38231
|
ObservabilityPipelineParseJSONProcessor:
|
|
37515
|
-
description: The `parse_json` processor extracts JSON from a specified field
|
|
38232
|
+
description: 'The `parse_json` processor extracts JSON from a specified field
|
|
37516
38233
|
and flattens it into the event. This is useful when logs contain embedded
|
|
37517
38234
|
JSON as a string.
|
|
38235
|
+
|
|
38236
|
+
|
|
38237
|
+
**Supported pipeline types:** logs'
|
|
37518
38238
|
properties:
|
|
37519
38239
|
display_name:
|
|
37520
38240
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37521
38241
|
enabled:
|
|
37522
|
-
description:
|
|
38242
|
+
description: Indicates whether the processor is enabled.
|
|
37523
38243
|
example: true
|
|
37524
38244
|
type: boolean
|
|
37525
38245
|
field:
|
|
@@ -37546,6 +38266,8 @@ components:
|
|
|
37546
38266
|
- field
|
|
37547
38267
|
- enabled
|
|
37548
38268
|
type: object
|
|
38269
|
+
x-pipeline-types:
|
|
38270
|
+
- logs
|
|
37549
38271
|
ObservabilityPipelineParseJSONProcessorType:
|
|
37550
38272
|
default: parse_json
|
|
37551
38273
|
description: The processor type. The value should always be `parse_json`.
|
|
@@ -37555,37 +38277,101 @@ components:
|
|
|
37555
38277
|
type: string
|
|
37556
38278
|
x-enum-varnames:
|
|
37557
38279
|
- PARSE_JSON
|
|
37558
|
-
|
|
37559
|
-
description:
|
|
38280
|
+
ObservabilityPipelineParseXMLProcessor:
|
|
38281
|
+
description: 'The `parse_xml` processor parses XML from a specified field and
|
|
38282
|
+
extracts it into the event.
|
|
38283
|
+
|
|
38284
|
+
|
|
38285
|
+
**Supported pipeline types:** logs'
|
|
38286
|
+
properties:
|
|
38287
|
+
always_use_text_key:
|
|
38288
|
+
description: Whether to always use a text key for element content.
|
|
38289
|
+
type: boolean
|
|
38290
|
+
attr_prefix:
|
|
38291
|
+
description: The prefix to use for XML attributes in the parsed output.
|
|
38292
|
+
type: string
|
|
38293
|
+
display_name:
|
|
38294
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
38295
|
+
enabled:
|
|
38296
|
+
description: Indicates whether the processor is enabled.
|
|
38297
|
+
example: true
|
|
38298
|
+
type: boolean
|
|
38299
|
+
field:
|
|
38300
|
+
description: The name of the log field that contains an XML string.
|
|
38301
|
+
example: message
|
|
38302
|
+
type: string
|
|
38303
|
+
id:
|
|
38304
|
+
description: The unique identifier for this component. Used in other parts
|
|
38305
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
38306
|
+
to downstream components).
|
|
38307
|
+
example: parse-xml-processor
|
|
38308
|
+
type: string
|
|
38309
|
+
include:
|
|
38310
|
+
description: A Datadog search query used to determine which logs this processor
|
|
38311
|
+
targets.
|
|
38312
|
+
example: service:my-service
|
|
38313
|
+
type: string
|
|
38314
|
+
include_attr:
|
|
38315
|
+
description: Whether to include XML attributes in the parsed output.
|
|
38316
|
+
type: boolean
|
|
38317
|
+
parse_bool:
|
|
38318
|
+
description: Whether to parse boolean values from strings.
|
|
38319
|
+
type: boolean
|
|
38320
|
+
parse_null:
|
|
38321
|
+
description: Whether to parse null values.
|
|
38322
|
+
type: boolean
|
|
38323
|
+
parse_number:
|
|
38324
|
+
description: Whether to parse numeric values from strings.
|
|
38325
|
+
type: boolean
|
|
38326
|
+
text_key:
|
|
38327
|
+
description: The key name to use for text content within XML elements. Must
|
|
38328
|
+
be at least 1 character if specified.
|
|
38329
|
+
minLength: 1
|
|
38330
|
+
type: string
|
|
38331
|
+
type:
|
|
38332
|
+
$ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessorType'
|
|
38333
|
+
required:
|
|
38334
|
+
- id
|
|
38335
|
+
- type
|
|
38336
|
+
- include
|
|
38337
|
+
- field
|
|
38338
|
+
- enabled
|
|
38339
|
+
type: object
|
|
38340
|
+
x-pipeline-types:
|
|
38341
|
+
- logs
|
|
38342
|
+
ObservabilityPipelineParseXMLProcessorType:
|
|
38343
|
+
default: parse_xml
|
|
38344
|
+
description: The processor type. The value should always be `parse_xml`.
|
|
37560
38345
|
enum:
|
|
37561
|
-
-
|
|
37562
|
-
|
|
37563
|
-
- SCRAM-SHA-512
|
|
38346
|
+
- parse_xml
|
|
38347
|
+
example: parse_xml
|
|
37564
38348
|
type: string
|
|
37565
38349
|
x-enum-varnames:
|
|
37566
|
-
-
|
|
37567
|
-
- SCRAMNOT_SHANOT_256
|
|
37568
|
-
- SCRAMNOT_SHANOT_512
|
|
38350
|
+
- PARSE_XML
|
|
37569
38351
|
ObservabilityPipelineQuotaProcessor:
|
|
37570
|
-
description: The
|
|
38352
|
+
description: 'The `quota` processor measures logging traffic for logs that match
|
|
37571
38353
|
a specified filter. When the configured daily quota is met, the processor
|
|
37572
38354
|
can drop or alert.
|
|
38355
|
+
|
|
38356
|
+
|
|
38357
|
+
**Supported pipeline types:** logs'
|
|
37573
38358
|
properties:
|
|
37574
38359
|
display_name:
|
|
37575
38360
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37576
38361
|
drop_events:
|
|
37577
|
-
description: If set to `true`, logs that
|
|
37578
|
-
after the quota
|
|
37579
|
-
|
|
38362
|
+
description: 'If set to `true`, logs that match the quota filter and are
|
|
38363
|
+
sent after the quota is exceeded are dropped. Logs that do not match the
|
|
38364
|
+
filter continue through the pipeline. **Note**: You can set either `drop_events`
|
|
38365
|
+
or `overflow_action`, but not both.'
|
|
37580
38366
|
example: false
|
|
37581
38367
|
type: boolean
|
|
37582
38368
|
enabled:
|
|
37583
|
-
description:
|
|
38369
|
+
description: Indicates whether the processor is enabled.
|
|
37584
38370
|
example: true
|
|
37585
38371
|
type: boolean
|
|
37586
38372
|
id:
|
|
37587
|
-
description: The unique identifier for this component. Used
|
|
37588
|
-
|
|
38373
|
+
description: The unique identifier for this component. Used in other parts
|
|
38374
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
37589
38375
|
to downstream components).
|
|
37590
38376
|
example: quota-processor
|
|
37591
38377
|
type: string
|
|
@@ -37620,6 +38406,8 @@ components:
|
|
|
37620
38406
|
items:
|
|
37621
38407
|
type: string
|
|
37622
38408
|
type: array
|
|
38409
|
+
too_many_buckets_action:
|
|
38410
|
+
$ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction'
|
|
37623
38411
|
type:
|
|
37624
38412
|
$ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorType'
|
|
37625
38413
|
required:
|
|
@@ -37630,6 +38418,8 @@ components:
|
|
|
37630
38418
|
- limit
|
|
37631
38419
|
- enabled
|
|
37632
38420
|
type: object
|
|
38421
|
+
x-pipeline-types:
|
|
38422
|
+
- logs
|
|
37633
38423
|
ObservabilityPipelineQuotaProcessorLimit:
|
|
37634
38424
|
description: The maximum amount of data or number of events allowed before the
|
|
37635
38425
|
quota is enforced. Can be specified in bytes or events.
|
|
@@ -37657,7 +38447,8 @@ components:
|
|
|
37657
38447
|
- BYTES
|
|
37658
38448
|
- EVENTS
|
|
37659
38449
|
ObservabilityPipelineQuotaProcessorOverflowAction:
|
|
37660
|
-
description: 'The action to take when the quota is exceeded.
|
|
38450
|
+
description: 'The action to take when the quota or bucket limit is exceeded.
|
|
38451
|
+
Options:
|
|
37661
38452
|
|
|
37662
38453
|
- `drop`: Drop the event.
|
|
37663
38454
|
|
|
@@ -37701,13 +38492,16 @@ components:
|
|
|
37701
38492
|
x-enum-varnames:
|
|
37702
38493
|
- QUOTA
|
|
37703
38494
|
ObservabilityPipelineReduceProcessor:
|
|
37704
|
-
description: The `reduce` processor aggregates and merges logs based on matching
|
|
38495
|
+
description: 'The `reduce` processor aggregates and merges logs based on matching
|
|
37705
38496
|
keys and merge strategies.
|
|
38497
|
+
|
|
38498
|
+
|
|
38499
|
+
**Supported pipeline types:** logs'
|
|
37706
38500
|
properties:
|
|
37707
38501
|
display_name:
|
|
37708
38502
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37709
38503
|
enabled:
|
|
37710
|
-
description:
|
|
38504
|
+
description: Indicates whether the processor is enabled.
|
|
37711
38505
|
example: true
|
|
37712
38506
|
type: boolean
|
|
37713
38507
|
group_by:
|
|
@@ -37743,6 +38537,8 @@ components:
|
|
|
37743
38537
|
- merge_strategies
|
|
37744
38538
|
- enabled
|
|
37745
38539
|
type: object
|
|
38540
|
+
x-pipeline-types:
|
|
38541
|
+
- logs
|
|
37746
38542
|
ObservabilityPipelineReduceProcessorMergeStrategy:
|
|
37747
38543
|
description: Defines how a specific field should be merged across grouped events.
|
|
37748
38544
|
properties:
|
|
@@ -37796,12 +38592,15 @@ components:
|
|
|
37796
38592
|
x-enum-varnames:
|
|
37797
38593
|
- REDUCE
|
|
37798
38594
|
ObservabilityPipelineRemoveFieldsProcessor:
|
|
37799
|
-
description: The `remove_fields` processor deletes specified fields from logs.
|
|
38595
|
+
description: 'The `remove_fields` processor deletes specified fields from logs.
|
|
38596
|
+
|
|
38597
|
+
|
|
38598
|
+
**Supported pipeline types:** logs'
|
|
37800
38599
|
properties:
|
|
37801
38600
|
display_name:
|
|
37802
38601
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37803
38602
|
enabled:
|
|
37804
|
-
description:
|
|
38603
|
+
description: Indicates whether the processor is enabled.
|
|
37805
38604
|
example: true
|
|
37806
38605
|
type: boolean
|
|
37807
38606
|
fields:
|
|
@@ -37813,9 +38612,9 @@ components:
|
|
|
37813
38612
|
type: string
|
|
37814
38613
|
type: array
|
|
37815
38614
|
id:
|
|
37816
|
-
description: The unique identifier for this component. Used
|
|
37817
|
-
|
|
37818
|
-
components).
|
|
38615
|
+
description: The unique identifier for this component. Used in other parts
|
|
38616
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
38617
|
+
to downstream components).
|
|
37819
38618
|
example: remove-fields-processor
|
|
37820
38619
|
type: string
|
|
37821
38620
|
include:
|
|
@@ -37832,6 +38631,8 @@ components:
|
|
|
37832
38631
|
- fields
|
|
37833
38632
|
- enabled
|
|
37834
38633
|
type: object
|
|
38634
|
+
x-pipeline-types:
|
|
38635
|
+
- logs
|
|
37835
38636
|
ObservabilityPipelineRemoveFieldsProcessorType:
|
|
37836
38637
|
default: remove_fields
|
|
37837
38638
|
description: The processor type. The value should always be `remove_fields`.
|
|
@@ -37842,12 +38643,15 @@ components:
|
|
|
37842
38643
|
x-enum-varnames:
|
|
37843
38644
|
- REMOVE_FIELDS
|
|
37844
38645
|
ObservabilityPipelineRenameFieldsProcessor:
|
|
37845
|
-
description: The `rename_fields` processor changes field names.
|
|
38646
|
+
description: 'The `rename_fields` processor changes field names.
|
|
38647
|
+
|
|
38648
|
+
|
|
38649
|
+
**Supported pipeline types:** logs'
|
|
37846
38650
|
properties:
|
|
37847
38651
|
display_name:
|
|
37848
38652
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37849
38653
|
enabled:
|
|
37850
|
-
description:
|
|
38654
|
+
description: Indicates whether the processor is enabled.
|
|
37851
38655
|
example: true
|
|
37852
38656
|
type: boolean
|
|
37853
38657
|
fields:
|
|
@@ -37877,6 +38681,8 @@ components:
|
|
|
37877
38681
|
- fields
|
|
37878
38682
|
- enabled
|
|
37879
38683
|
type: object
|
|
38684
|
+
x-pipeline-types:
|
|
38685
|
+
- logs
|
|
37880
38686
|
ObservabilityPipelineRenameFieldsProcessorField:
|
|
37881
38687
|
description: Defines how to rename a field in log events.
|
|
37882
38688
|
properties:
|
|
@@ -37908,8 +38714,11 @@ components:
|
|
|
37908
38714
|
x-enum-varnames:
|
|
37909
38715
|
- RENAME_FIELDS
|
|
37910
38716
|
ObservabilityPipelineRsyslogDestination:
|
|
37911
|
-
description: The `rsyslog` destination forwards logs to an external `rsyslog`
|
|
38717
|
+
description: 'The `rsyslog` destination forwards logs to an external `rsyslog`
|
|
37912
38718
|
server over TCP or UDP using the syslog protocol.
|
|
38719
|
+
|
|
38720
|
+
|
|
38721
|
+
**Supported pipeline types:** logs'
|
|
37913
38722
|
properties:
|
|
37914
38723
|
id:
|
|
37915
38724
|
description: The unique identifier for this component.
|
|
@@ -37938,6 +38747,8 @@ components:
|
|
|
37938
38747
|
- type
|
|
37939
38748
|
- inputs
|
|
37940
38749
|
type: object
|
|
38750
|
+
x-pipeline-types:
|
|
38751
|
+
- logs
|
|
37941
38752
|
ObservabilityPipelineRsyslogDestinationType:
|
|
37942
38753
|
default: rsyslog
|
|
37943
38754
|
description: The destination type. The value should always be `rsyslog`.
|
|
@@ -37948,13 +38759,16 @@ components:
|
|
|
37948
38759
|
x-enum-varnames:
|
|
37949
38760
|
- RSYSLOG
|
|
37950
38761
|
ObservabilityPipelineRsyslogSource:
|
|
37951
|
-
description: The `rsyslog` source listens for logs over TCP or UDP from an
|
|
37952
|
-
server using the syslog protocol.
|
|
38762
|
+
description: 'The `rsyslog` source listens for logs over TCP or UDP from an
|
|
38763
|
+
`rsyslog` server using the syslog protocol.
|
|
38764
|
+
|
|
38765
|
+
|
|
38766
|
+
**Supported pipeline types:** logs'
|
|
37953
38767
|
properties:
|
|
37954
38768
|
id:
|
|
37955
|
-
description: The unique identifier for this component. Used
|
|
37956
|
-
|
|
37957
|
-
components).
|
|
38769
|
+
description: The unique identifier for this component. Used in other parts
|
|
38770
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
38771
|
+
to downstream components).
|
|
37958
38772
|
example: rsyslog-source
|
|
37959
38773
|
type: string
|
|
37960
38774
|
mode:
|
|
@@ -37968,6 +38782,8 @@ components:
|
|
|
37968
38782
|
- type
|
|
37969
38783
|
- mode
|
|
37970
38784
|
type: object
|
|
38785
|
+
x-pipeline-types:
|
|
38786
|
+
- logs
|
|
37971
38787
|
ObservabilityPipelineRsyslogSourceType:
|
|
37972
38788
|
default: rsyslog
|
|
37973
38789
|
description: The source type. The value should always be `rsyslog`.
|
|
@@ -37978,18 +38794,31 @@ components:
|
|
|
37978
38794
|
x-enum-varnames:
|
|
37979
38795
|
- RSYSLOG
|
|
37980
38796
|
ObservabilityPipelineSampleProcessor:
|
|
37981
|
-
description: The `sample` processor allows probabilistic sampling of logs at
|
|
38797
|
+
description: 'The `sample` processor allows probabilistic sampling of logs at
|
|
37982
38798
|
a fixed rate.
|
|
38799
|
+
|
|
38800
|
+
|
|
38801
|
+
**Supported pipeline types:** logs'
|
|
37983
38802
|
properties:
|
|
37984
38803
|
display_name:
|
|
37985
38804
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37986
38805
|
enabled:
|
|
37987
|
-
description:
|
|
38806
|
+
description: Indicates whether the processor is enabled.
|
|
37988
38807
|
example: true
|
|
37989
38808
|
type: boolean
|
|
38809
|
+
group_by:
|
|
38810
|
+
description: Optional list of fields to group events by. Each group is sampled
|
|
38811
|
+
independently.
|
|
38812
|
+
example:
|
|
38813
|
+
- service
|
|
38814
|
+
- host
|
|
38815
|
+
items:
|
|
38816
|
+
type: string
|
|
38817
|
+
minItems: 1
|
|
38818
|
+
type: array
|
|
37990
38819
|
id:
|
|
37991
|
-
description: The unique identifier for this component. Used
|
|
37992
|
-
|
|
38820
|
+
description: The unique identifier for this component. Used in other parts
|
|
38821
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
37993
38822
|
to downstream components).
|
|
37994
38823
|
example: sample-processor
|
|
37995
38824
|
type: string
|
|
@@ -38003,20 +38832,17 @@ components:
|
|
|
38003
38832
|
example: 10.0
|
|
38004
38833
|
format: double
|
|
38005
38834
|
type: number
|
|
38006
|
-
rate:
|
|
38007
|
-
description: Number of events to sample (1 in N).
|
|
38008
|
-
example: 10
|
|
38009
|
-
format: int64
|
|
38010
|
-
minimum: 1
|
|
38011
|
-
type: integer
|
|
38012
38835
|
type:
|
|
38013
38836
|
$ref: '#/components/schemas/ObservabilityPipelineSampleProcessorType'
|
|
38014
38837
|
required:
|
|
38015
38838
|
- id
|
|
38016
38839
|
- type
|
|
38017
38840
|
- include
|
|
38841
|
+
- percentage
|
|
38018
38842
|
- enabled
|
|
38019
38843
|
type: object
|
|
38844
|
+
x-pipeline-types:
|
|
38845
|
+
- logs
|
|
38020
38846
|
ObservabilityPipelineSampleProcessorType:
|
|
38021
38847
|
default: sample
|
|
38022
38848
|
description: The processor type. The value should always be `sample`.
|
|
@@ -38027,19 +38853,22 @@ components:
|
|
|
38027
38853
|
x-enum-varnames:
|
|
38028
38854
|
- SAMPLE
|
|
38029
38855
|
ObservabilityPipelineSensitiveDataScannerProcessor:
|
|
38030
|
-
description: The `sensitive_data_scanner` processor detects and optionally
|
|
38031
|
-
sensitive data in log events.
|
|
38856
|
+
description: 'The `sensitive_data_scanner` processor detects and optionally
|
|
38857
|
+
redacts sensitive data in log events.
|
|
38858
|
+
|
|
38859
|
+
|
|
38860
|
+
**Supported pipeline types:** logs'
|
|
38032
38861
|
properties:
|
|
38033
38862
|
display_name:
|
|
38034
38863
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
38035
38864
|
enabled:
|
|
38036
|
-
description:
|
|
38865
|
+
description: Indicates whether the processor is enabled.
|
|
38037
38866
|
example: true
|
|
38038
38867
|
type: boolean
|
|
38039
38868
|
id:
|
|
38040
|
-
description: The unique identifier for this component. Used
|
|
38041
|
-
|
|
38042
|
-
components).
|
|
38869
|
+
description: The unique identifier for this component. Used in other parts
|
|
38870
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
38871
|
+
to downstream components).
|
|
38043
38872
|
example: sensitive-scanner
|
|
38044
38873
|
type: string
|
|
38045
38874
|
include:
|
|
@@ -38062,6 +38891,8 @@ components:
|
|
|
38062
38891
|
- rules
|
|
38063
38892
|
- enabled
|
|
38064
38893
|
type: object
|
|
38894
|
+
x-pipeline-types:
|
|
38895
|
+
- logs
|
|
38065
38896
|
ObservabilityPipelineSensitiveDataScannerProcessorAction:
|
|
38066
38897
|
description: Defines what action to take when sensitive data is matched.
|
|
38067
38898
|
oneOf:
|
|
@@ -38183,6 +39014,11 @@ components:
|
|
|
38183
39014
|
ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions:
|
|
38184
39015
|
description: Options for defining a custom regex pattern.
|
|
38185
39016
|
properties:
|
|
39017
|
+
description:
|
|
39018
|
+
description: Human-readable description providing context about a sensitive
|
|
39019
|
+
data scanner rule
|
|
39020
|
+
example: "Custom regex for internal API\u202Fkeys"
|
|
39021
|
+
type: string
|
|
38186
39022
|
rule:
|
|
38187
39023
|
description: A regular expression used to detect sensitive values. Must
|
|
38188
39024
|
be a valid regex.
|
|
@@ -38238,6 +39074,11 @@ components:
|
|
|
38238
39074
|
description: Options for selecting a predefined library pattern and enabling
|
|
38239
39075
|
keyword support.
|
|
38240
39076
|
properties:
|
|
39077
|
+
description:
|
|
39078
|
+
description: Human-readable description providing context about a sensitive
|
|
39079
|
+
data scanner rule
|
|
39080
|
+
example: Credit card pattern
|
|
39081
|
+
type: string
|
|
38241
39082
|
id:
|
|
38242
39083
|
description: Identifier for a predefined pattern from the sensitive data
|
|
38243
39084
|
scanner pattern library.
|
|
@@ -38379,7 +39220,10 @@ components:
|
|
|
38379
39220
|
x-enum-varnames:
|
|
38380
39221
|
- SENSITIVE_DATA_SCANNER
|
|
38381
39222
|
ObservabilityPipelineSentinelOneDestination:
|
|
38382
|
-
description: The `sentinel_one` destination sends logs to SentinelOne.
|
|
39223
|
+
description: 'The `sentinel_one` destination sends logs to SentinelOne.
|
|
39224
|
+
|
|
39225
|
+
|
|
39226
|
+
**Supported pipeline types:** logs'
|
|
38383
39227
|
properties:
|
|
38384
39228
|
id:
|
|
38385
39229
|
description: The unique identifier for this component.
|
|
@@ -38403,6 +39247,8 @@ components:
|
|
|
38403
39247
|
- inputs
|
|
38404
39248
|
- region
|
|
38405
39249
|
type: object
|
|
39250
|
+
x-pipeline-types:
|
|
39251
|
+
- logs
|
|
38406
39252
|
ObservabilityPipelineSentinelOneDestinationRegion:
|
|
38407
39253
|
description: The SentinelOne region to send logs to.
|
|
38408
39254
|
enum:
|
|
@@ -38427,8 +39273,11 @@ components:
|
|
|
38427
39273
|
x-enum-varnames:
|
|
38428
39274
|
- SENTINEL_ONE
|
|
38429
39275
|
ObservabilityPipelineSocketDestination:
|
|
38430
|
-
description: The `socket` destination sends logs over TCP or UDP to a remote
|
|
39276
|
+
description: 'The `socket` destination sends logs over TCP or UDP to a remote
|
|
38431
39277
|
server.
|
|
39278
|
+
|
|
39279
|
+
|
|
39280
|
+
**Supported pipeline types:** logs'
|
|
38432
39281
|
properties:
|
|
38433
39282
|
encoding:
|
|
38434
39283
|
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
|
|
@@ -38461,6 +39310,8 @@ components:
|
|
|
38461
39310
|
- framing
|
|
38462
39311
|
- mode
|
|
38463
39312
|
type: object
|
|
39313
|
+
x-pipeline-types:
|
|
39314
|
+
- logs
|
|
38464
39315
|
ObservabilityPipelineSocketDestinationEncoding:
|
|
38465
39316
|
description: Encoding format for log events.
|
|
38466
39317
|
enum:
|
|
@@ -38555,14 +39406,17 @@ components:
|
|
|
38555
39406
|
x-enum-varnames:
|
|
38556
39407
|
- SOCKET
|
|
38557
39408
|
ObservabilityPipelineSocketSource:
|
|
38558
|
-
description: The `socket` source ingests logs over TCP or UDP.
|
|
39409
|
+
description: 'The `socket` source ingests logs over TCP or UDP.
|
|
39410
|
+
|
|
39411
|
+
|
|
39412
|
+
**Supported pipeline types:** logs'
|
|
38559
39413
|
properties:
|
|
38560
39414
|
framing:
|
|
38561
39415
|
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
|
|
38562
39416
|
id:
|
|
38563
|
-
description: The unique identifier for this component. Used
|
|
38564
|
-
|
|
38565
|
-
components).
|
|
39417
|
+
description: The unique identifier for this component. Used in other parts
|
|
39418
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
39419
|
+
to downstream components).
|
|
38566
39420
|
example: socket-source
|
|
38567
39421
|
type: string
|
|
38568
39422
|
mode:
|
|
@@ -38578,6 +39432,8 @@ components:
|
|
|
38578
39432
|
- mode
|
|
38579
39433
|
- framing
|
|
38580
39434
|
type: object
|
|
39435
|
+
x-pipeline-types:
|
|
39436
|
+
- logs
|
|
38581
39437
|
ObservabilityPipelineSocketSourceFraming:
|
|
38582
39438
|
description: Framing method configuration for the socket source.
|
|
38583
39439
|
oneOf:
|
|
@@ -38718,9 +39574,79 @@ components:
|
|
|
38718
39574
|
- type
|
|
38719
39575
|
- attributes
|
|
38720
39576
|
type: object
|
|
39577
|
+
ObservabilityPipelineSplitArrayProcessor:
|
|
39578
|
+
description: 'The `split_array` processor splits array fields into separate
|
|
39579
|
+
events based on configured rules.
|
|
39580
|
+
|
|
39581
|
+
|
|
39582
|
+
**Supported pipeline types:** logs'
|
|
39583
|
+
properties:
|
|
39584
|
+
arrays:
|
|
39585
|
+
description: A list of array split configurations.
|
|
39586
|
+
items:
|
|
39587
|
+
$ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorArrayConfig'
|
|
39588
|
+
maxItems: 15
|
|
39589
|
+
minItems: 1
|
|
39590
|
+
type: array
|
|
39591
|
+
display_name:
|
|
39592
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
39593
|
+
enabled:
|
|
39594
|
+
description: Indicates whether the processor is enabled.
|
|
39595
|
+
example: true
|
|
39596
|
+
type: boolean
|
|
39597
|
+
id:
|
|
39598
|
+
description: The unique identifier for this component. Used in other parts
|
|
39599
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
39600
|
+
to downstream components).
|
|
39601
|
+
example: split-array-processor
|
|
39602
|
+
type: string
|
|
39603
|
+
include:
|
|
39604
|
+
description: A Datadog search query used to determine which logs this processor
|
|
39605
|
+
targets. For split_array, this should typically be `*`.
|
|
39606
|
+
example: '*'
|
|
39607
|
+
type: string
|
|
39608
|
+
type:
|
|
39609
|
+
$ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorType'
|
|
39610
|
+
required:
|
|
39611
|
+
- id
|
|
39612
|
+
- type
|
|
39613
|
+
- include
|
|
39614
|
+
- arrays
|
|
39615
|
+
- enabled
|
|
39616
|
+
type: object
|
|
39617
|
+
x-pipeline-types:
|
|
39618
|
+
- logs
|
|
39619
|
+
ObservabilityPipelineSplitArrayProcessorArrayConfig:
|
|
39620
|
+
description: Configuration for a single array split operation.
|
|
39621
|
+
properties:
|
|
39622
|
+
field:
|
|
39623
|
+
description: The path to the array field to split.
|
|
39624
|
+
example: tags
|
|
39625
|
+
type: string
|
|
39626
|
+
include:
|
|
39627
|
+
description: A Datadog search query used to determine which logs this array
|
|
39628
|
+
split operation targets.
|
|
39629
|
+
example: '*'
|
|
39630
|
+
type: string
|
|
39631
|
+
required:
|
|
39632
|
+
- include
|
|
39633
|
+
- field
|
|
39634
|
+
type: object
|
|
39635
|
+
ObservabilityPipelineSplitArrayProcessorType:
|
|
39636
|
+
default: split_array
|
|
39637
|
+
description: The processor type. The value should always be `split_array`.
|
|
39638
|
+
enum:
|
|
39639
|
+
- split_array
|
|
39640
|
+
example: split_array
|
|
39641
|
+
type: string
|
|
39642
|
+
x-enum-varnames:
|
|
39643
|
+
- SPLIT_ARRAY
|
|
38721
39644
|
ObservabilityPipelineSplunkHecDestination:
|
|
38722
|
-
description: The `splunk_hec` destination forwards logs to Splunk using the
|
|
39645
|
+
description: 'The `splunk_hec` destination forwards logs to Splunk using the
|
|
38723
39646
|
HTTP Event Collector (HEC).
|
|
39647
|
+
|
|
39648
|
+
|
|
39649
|
+
**Supported pipeline types:** logs'
|
|
38724
39650
|
properties:
|
|
38725
39651
|
auto_extract_timestamp:
|
|
38726
39652
|
description: 'If `true`, Splunk tries to extract timestamps from incoming
|
|
@@ -38732,9 +39658,9 @@ components:
|
|
|
38732
39658
|
encoding:
|
|
38733
39659
|
$ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding'
|
|
38734
39660
|
id:
|
|
38735
|
-
description: The unique identifier for this component. Used
|
|
38736
|
-
|
|
38737
|
-
components).
|
|
39661
|
+
description: The unique identifier for this component. Used in other parts
|
|
39662
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
39663
|
+
to downstream components).
|
|
38738
39664
|
example: splunk-hec-destination
|
|
38739
39665
|
type: string
|
|
38740
39666
|
index:
|
|
@@ -38760,6 +39686,8 @@ components:
|
|
|
38760
39686
|
- type
|
|
38761
39687
|
- inputs
|
|
38762
39688
|
type: object
|
|
39689
|
+
x-pipeline-types:
|
|
39690
|
+
- logs
|
|
38763
39691
|
ObservabilityPipelineSplunkHecDestinationEncoding:
|
|
38764
39692
|
description: Encoding format for log events.
|
|
38765
39693
|
enum:
|
|
@@ -38780,13 +39708,16 @@ components:
|
|
|
38780
39708
|
x-enum-varnames:
|
|
38781
39709
|
- SPLUNK_HEC
|
|
38782
39710
|
ObservabilityPipelineSplunkHecSource:
|
|
38783
|
-
description: The `splunk_hec` source implements the Splunk HTTP Event Collector
|
|
39711
|
+
description: 'The `splunk_hec` source implements the Splunk HTTP Event Collector
|
|
38784
39712
|
(HEC) API.
|
|
39713
|
+
|
|
39714
|
+
|
|
39715
|
+
**Supported pipeline types:** logs'
|
|
38785
39716
|
properties:
|
|
38786
39717
|
id:
|
|
38787
|
-
description: The unique identifier for this component. Used
|
|
38788
|
-
|
|
38789
|
-
components).
|
|
39718
|
+
description: The unique identifier for this component. Used in other parts
|
|
39719
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
39720
|
+
to downstream components).
|
|
38790
39721
|
example: splunk-hec-source
|
|
38791
39722
|
type: string
|
|
38792
39723
|
tls:
|
|
@@ -38797,6 +39728,8 @@ components:
|
|
|
38797
39728
|
- id
|
|
38798
39729
|
- type
|
|
38799
39730
|
type: object
|
|
39731
|
+
x-pipeline-types:
|
|
39732
|
+
- logs
|
|
38800
39733
|
ObservabilityPipelineSplunkHecSourceType:
|
|
38801
39734
|
default: splunk_hec
|
|
38802
39735
|
description: The source type. Always `splunk_hec`.
|
|
@@ -38810,12 +39743,15 @@ components:
|
|
|
38810
39743
|
description: 'The `splunk_tcp` source receives logs from a Splunk Universal
|
|
38811
39744
|
Forwarder over TCP.
|
|
38812
39745
|
|
|
38813
|
-
TLS is supported for secure transmission.
|
|
39746
|
+
TLS is supported for secure transmission.
|
|
39747
|
+
|
|
39748
|
+
|
|
39749
|
+
**Supported pipeline types:** logs'
|
|
38814
39750
|
properties:
|
|
38815
39751
|
id:
|
|
38816
|
-
description: The unique identifier for this component. Used
|
|
38817
|
-
|
|
38818
|
-
components).
|
|
39752
|
+
description: The unique identifier for this component. Used in other parts
|
|
39753
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
39754
|
+
to downstream components).
|
|
38819
39755
|
example: splunk-tcp-source
|
|
38820
39756
|
type: string
|
|
38821
39757
|
tls:
|
|
@@ -38826,6 +39762,8 @@ components:
|
|
|
38826
39762
|
- id
|
|
38827
39763
|
- type
|
|
38828
39764
|
type: object
|
|
39765
|
+
x-pipeline-types:
|
|
39766
|
+
- logs
|
|
38829
39767
|
ObservabilityPipelineSplunkTcpSourceType:
|
|
38830
39768
|
default: splunk_tcp
|
|
38831
39769
|
description: The source type. Always `splunk_tcp`.
|
|
@@ -38836,7 +39774,10 @@ components:
|
|
|
38836
39774
|
x-enum-varnames:
|
|
38837
39775
|
- SPLUNK_TCP
|
|
38838
39776
|
ObservabilityPipelineSumoLogicDestination:
|
|
38839
|
-
description: The `sumo_logic` destination forwards logs to Sumo Logic.
|
|
39777
|
+
description: 'The `sumo_logic` destination forwards logs to Sumo Logic.
|
|
39778
|
+
|
|
39779
|
+
|
|
39780
|
+
**Supported pipeline types:** logs'
|
|
38840
39781
|
properties:
|
|
38841
39782
|
encoding:
|
|
38842
39783
|
$ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding'
|
|
@@ -38877,6 +39818,8 @@ components:
|
|
|
38877
39818
|
- type
|
|
38878
39819
|
- inputs
|
|
38879
39820
|
type: object
|
|
39821
|
+
x-pipeline-types:
|
|
39822
|
+
- logs
|
|
38880
39823
|
ObservabilityPipelineSumoLogicDestinationEncoding:
|
|
38881
39824
|
description: The output encoding format.
|
|
38882
39825
|
enum:
|
|
@@ -38914,12 +39857,15 @@ components:
|
|
|
38914
39857
|
x-enum-varnames:
|
|
38915
39858
|
- SUMO_LOGIC
|
|
38916
39859
|
ObservabilityPipelineSumoLogicSource:
|
|
38917
|
-
description: The `sumo_logic` source receives logs from Sumo Logic collectors.
|
|
39860
|
+
description: 'The `sumo_logic` source receives logs from Sumo Logic collectors.
|
|
39861
|
+
|
|
39862
|
+
|
|
39863
|
+
**Supported pipeline types:** logs'
|
|
38918
39864
|
properties:
|
|
38919
39865
|
id:
|
|
38920
|
-
description: The unique identifier for this component. Used
|
|
38921
|
-
|
|
38922
|
-
components).
|
|
39866
|
+
description: The unique identifier for this component. Used in other parts
|
|
39867
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
39868
|
+
to downstream components).
|
|
38923
39869
|
example: sumo-logic-source
|
|
38924
39870
|
type: string
|
|
38925
39871
|
type:
|
|
@@ -38928,6 +39874,8 @@ components:
|
|
|
38928
39874
|
- id
|
|
38929
39875
|
- type
|
|
38930
39876
|
type: object
|
|
39877
|
+
x-pipeline-types:
|
|
39878
|
+
- logs
|
|
38931
39879
|
ObservabilityPipelineSumoLogicSourceType:
|
|
38932
39880
|
default: sumo_logic
|
|
38933
39881
|
description: The source type. The value should always be `sumo_logic`.
|
|
@@ -38938,8 +39886,11 @@ components:
|
|
|
38938
39886
|
x-enum-varnames:
|
|
38939
39887
|
- SUMO_LOGIC
|
|
38940
39888
|
ObservabilityPipelineSyslogNgDestination:
|
|
38941
|
-
description: The `syslog_ng` destination forwards logs to an external `syslog-ng`
|
|
39889
|
+
description: 'The `syslog_ng` destination forwards logs to an external `syslog-ng`
|
|
38942
39890
|
server over TCP or UDP using the syslog protocol.
|
|
39891
|
+
|
|
39892
|
+
|
|
39893
|
+
**Supported pipeline types:** logs'
|
|
38943
39894
|
properties:
|
|
38944
39895
|
id:
|
|
38945
39896
|
description: The unique identifier for this component.
|
|
@@ -38968,6 +39919,8 @@ components:
|
|
|
38968
39919
|
- type
|
|
38969
39920
|
- inputs
|
|
38970
39921
|
type: object
|
|
39922
|
+
x-pipeline-types:
|
|
39923
|
+
- logs
|
|
38971
39924
|
ObservabilityPipelineSyslogNgDestinationType:
|
|
38972
39925
|
default: syslog_ng
|
|
38973
39926
|
description: The destination type. The value should always be `syslog_ng`.
|
|
@@ -38978,13 +39931,16 @@ components:
|
|
|
38978
39931
|
x-enum-varnames:
|
|
38979
39932
|
- SYSLOG_NG
|
|
38980
39933
|
ObservabilityPipelineSyslogNgSource:
|
|
38981
|
-
description: The `syslog_ng` source listens for logs over TCP or UDP from a
|
|
39934
|
+
description: 'The `syslog_ng` source listens for logs over TCP or UDP from a
|
|
38982
39935
|
`syslog-ng` server using the syslog protocol.
|
|
39936
|
+
|
|
39937
|
+
|
|
39938
|
+
**Supported pipeline types:** logs'
|
|
38983
39939
|
properties:
|
|
38984
39940
|
id:
|
|
38985
|
-
description: The unique identifier for this component. Used
|
|
38986
|
-
|
|
38987
|
-
components).
|
|
39941
|
+
description: The unique identifier for this component. Used in other parts
|
|
39942
|
+
of the pipeline to reference this component (for example, as the `input`
|
|
39943
|
+
to downstream components).
|
|
38988
39944
|
example: syslog-ng-source
|
|
38989
39945
|
type: string
|
|
38990
39946
|
mode:
|
|
@@ -38998,6 +39954,8 @@ components:
|
|
|
38998
39954
|
- type
|
|
38999
39955
|
- mode
|
|
39000
39956
|
type: object
|
|
39957
|
+
x-pipeline-types:
|
|
39958
|
+
- logs
|
|
39001
39959
|
ObservabilityPipelineSyslogNgSourceType:
|
|
39002
39960
|
default: syslog_ng
|
|
39003
39961
|
description: The source type. The value should always be `syslog_ng`.
|
|
@@ -39018,13 +39976,16 @@ components:
|
|
|
39018
39976
|
- TCP
|
|
39019
39977
|
- UDP
|
|
39020
39978
|
ObservabilityPipelineThrottleProcessor:
|
|
39021
|
-
description: The `throttle` processor limits the number of events that pass
|
|
39979
|
+
description: 'The `throttle` processor limits the number of events that pass
|
|
39022
39980
|
through over a given time window.
|
|
39981
|
+
|
|
39982
|
+
|
|
39983
|
+
**Supported pipeline types:** logs'
|
|
39023
39984
|
properties:
|
|
39024
39985
|
display_name:
|
|
39025
39986
|
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
39026
39987
|
enabled:
|
|
39027
|
-
description:
|
|
39988
|
+
description: Indicates whether the processor is enabled.
|
|
39028
39989
|
example: true
|
|
39029
39990
|
type: boolean
|
|
39030
39991
|
group_by:
|
|
@@ -39065,6 +40026,8 @@ components:
|
|
|
39065
40026
|
- window
|
|
39066
40027
|
- enabled
|
|
39067
40028
|
type: object
|
|
40029
|
+
x-pipeline-types:
|
|
40030
|
+
- logs
|
|
39068
40031
|
ObservabilityPipelineThrottleProcessorType:
|
|
39069
40032
|
default: throttle
|
|
39070
40033
|
description: The processor type. The value should always be `throttle`.
|
|
@@ -40664,7 +41627,6 @@ components:
|
|
|
40664
41627
|
type: STRING
|
|
40665
41628
|
primary_keys:
|
|
40666
41629
|
- id
|
|
40667
|
-
sync_enabled: false
|
|
40668
41630
|
tags:
|
|
40669
41631
|
- test_tag
|
|
40670
41632
|
type: reference_table
|
|
@@ -40696,10 +41658,6 @@ components:
|
|
|
40696
41658
|
$ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadata'
|
|
40697
41659
|
schema:
|
|
40698
41660
|
$ref: '#/components/schemas/PatchTableRequestDataAttributesSchema'
|
|
40699
|
-
sync_enabled:
|
|
40700
|
-
description: Whether this table is synced automatically.
|
|
40701
|
-
example: false
|
|
40702
|
-
type: boolean
|
|
40703
41661
|
tags:
|
|
40704
41662
|
description: Tags for organizing and filtering reference tables.
|
|
40705
41663
|
example:
|
|
@@ -42851,6 +43809,9 @@ components:
|
|
|
42851
43809
|
description: Attributes of the SPA Recommendation resource. Contains recommendations
|
|
42852
43810
|
for both driver and executor components.
|
|
42853
43811
|
properties:
|
|
43812
|
+
confidence_level:
|
|
43813
|
+
format: double
|
|
43814
|
+
type: number
|
|
42854
43815
|
driver:
|
|
42855
43816
|
$ref: '#/components/schemas/ComponentRecommendation'
|
|
42856
43817
|
executor:
|
|
@@ -47816,6 +48777,379 @@ components:
|
|
|
47816
48777
|
meta:
|
|
47817
48778
|
$ref: '#/components/schemas/SecurityFilterMeta'
|
|
47818
48779
|
type: object
|
|
48780
|
+
SecurityFindingsAttributes:
|
|
48781
|
+
description: The JSON object containing all attributes of the security finding.
|
|
48782
|
+
properties:
|
|
48783
|
+
attributes:
|
|
48784
|
+
additionalProperties: {}
|
|
48785
|
+
description: The custom attributes of the security finding.
|
|
48786
|
+
example:
|
|
48787
|
+
severity: high
|
|
48788
|
+
status: open
|
|
48789
|
+
type: object
|
|
48790
|
+
tags:
|
|
48791
|
+
description: List of tags associated with the security finding.
|
|
48792
|
+
example:
|
|
48793
|
+
- team:platform
|
|
48794
|
+
- env:prod
|
|
48795
|
+
items:
|
|
48796
|
+
type: string
|
|
48797
|
+
type: array
|
|
48798
|
+
timestamp:
|
|
48799
|
+
description: The Unix timestamp at which the detection changed for the resource.
|
|
48800
|
+
Same value as @detection_changed_at.
|
|
48801
|
+
example: 1765901760
|
|
48802
|
+
format: int64
|
|
48803
|
+
type: integer
|
|
48804
|
+
type: object
|
|
48805
|
+
SecurityFindingsData:
|
|
48806
|
+
description: A single security finding.
|
|
48807
|
+
properties:
|
|
48808
|
+
attributes:
|
|
48809
|
+
$ref: '#/components/schemas/SecurityFindingsAttributes'
|
|
48810
|
+
id:
|
|
48811
|
+
description: The unique ID of the security finding.
|
|
48812
|
+
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
|
48813
|
+
type: string
|
|
48814
|
+
type:
|
|
48815
|
+
$ref: '#/components/schemas/SecurityFindingsDataType'
|
|
48816
|
+
type: object
|
|
48817
|
+
SecurityFindingsDataType:
|
|
48818
|
+
default: finding
|
|
48819
|
+
description: The type of the security finding resource.
|
|
48820
|
+
enum:
|
|
48821
|
+
- finding
|
|
48822
|
+
example: finding
|
|
48823
|
+
type: string
|
|
48824
|
+
x-enum-varnames:
|
|
48825
|
+
- FINDING
|
|
48826
|
+
SecurityFindingsLinks:
|
|
48827
|
+
description: Links for pagination.
|
|
48828
|
+
properties:
|
|
48829
|
+
next:
|
|
48830
|
+
description: Link for the next page of results. Note that paginated requests
|
|
48831
|
+
can also be made using the POST endpoint.
|
|
48832
|
+
example: https://app.datadoghq.com/api/v2/security/findings?page[cursor]=eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ==&page[limit]=25
|
|
48833
|
+
type: string
|
|
48834
|
+
type: object
|
|
48835
|
+
SecurityFindingsMeta:
|
|
48836
|
+
description: Metadata about the response.
|
|
48837
|
+
properties:
|
|
48838
|
+
elapsed:
|
|
48839
|
+
description: The time elapsed in milliseconds.
|
|
48840
|
+
example: 548
|
|
48841
|
+
format: int64
|
|
48842
|
+
type: integer
|
|
48843
|
+
page:
|
|
48844
|
+
$ref: '#/components/schemas/SecurityFindingsPage'
|
|
48845
|
+
request_id:
|
|
48846
|
+
description: The identifier of the request.
|
|
48847
|
+
example: pddv1ChZwVlMxMUdYRFRMQ1lyb3B4MGNYbFlnIi0KHQu35LDbucx
|
|
48848
|
+
type: string
|
|
48849
|
+
status:
|
|
48850
|
+
$ref: '#/components/schemas/SecurityFindingsStatus'
|
|
48851
|
+
type: object
|
|
48852
|
+
SecurityFindingsPage:
|
|
48853
|
+
description: Pagination information.
|
|
48854
|
+
properties:
|
|
48855
|
+
after:
|
|
48856
|
+
description: The cursor used to get the next page of results.
|
|
48857
|
+
example: eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=
|
|
48858
|
+
type: string
|
|
48859
|
+
type: object
|
|
48860
|
+
SecurityFindingsSearchRequest:
|
|
48861
|
+
description: The request body for searching security findings.
|
|
48862
|
+
properties:
|
|
48863
|
+
data:
|
|
48864
|
+
$ref: '#/components/schemas/SecurityFindingsSearchRequestData'
|
|
48865
|
+
type: object
|
|
48866
|
+
SecurityFindingsSearchRequestData:
|
|
48867
|
+
description: Request data for searching security findings.
|
|
48868
|
+
properties:
|
|
48869
|
+
attributes:
|
|
48870
|
+
$ref: '#/components/schemas/SecurityFindingsSearchRequestDataAttributes'
|
|
48871
|
+
type: object
|
|
48872
|
+
SecurityFindingsSearchRequestDataAttributes:
|
|
48873
|
+
description: Request attributes for searching security findings.
|
|
48874
|
+
properties:
|
|
48875
|
+
filter:
|
|
48876
|
+
default: '*'
|
|
48877
|
+
description: The search query following log search syntax.
|
|
48878
|
+
example: '@severity:(critical OR high) @status:open team:platform'
|
|
48879
|
+
type: string
|
|
48880
|
+
page:
|
|
48881
|
+
$ref: '#/components/schemas/SecurityFindingsSearchRequestPage'
|
|
48882
|
+
sort:
|
|
48883
|
+
$ref: '#/components/schemas/SecurityFindingsSort'
|
|
48884
|
+
type: object
|
|
48885
|
+
SecurityFindingsSearchRequestPage:
|
|
48886
|
+
description: Pagination attributes for the search request.
|
|
48887
|
+
properties:
|
|
48888
|
+
cursor:
|
|
48889
|
+
description: Get the next page of results with a cursor provided in the
|
|
48890
|
+
previous query.
|
|
48891
|
+
example: eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ==
|
|
48892
|
+
type: string
|
|
48893
|
+
limit:
|
|
48894
|
+
default: 10
|
|
48895
|
+
description: The maximum number of security findings in the response.
|
|
48896
|
+
example: 25
|
|
48897
|
+
format: int64
|
|
48898
|
+
maximum: 150
|
|
48899
|
+
minimum: 1
|
|
48900
|
+
type: integer
|
|
48901
|
+
type: object
|
|
48902
|
+
SecurityFindingsSort:
|
|
48903
|
+
default: -@detection_changed_at
|
|
48904
|
+
description: The sort parameters when querying security findings.
|
|
48905
|
+
enum:
|
|
48906
|
+
- '@detection_changed_at'
|
|
48907
|
+
- -@detection_changed_at
|
|
48908
|
+
type: string
|
|
48909
|
+
x-enum-varnames:
|
|
48910
|
+
- DETECTION_CHANGED_AT_ASC
|
|
48911
|
+
- DETECTION_CHANGED_AT_DESC
|
|
48912
|
+
SecurityFindingsStatus:
|
|
48913
|
+
description: The status of the response.
|
|
48914
|
+
enum:
|
|
48915
|
+
- done
|
|
48916
|
+
- timeout
|
|
48917
|
+
example: done
|
|
48918
|
+
type: string
|
|
48919
|
+
x-enum-varnames:
|
|
48920
|
+
- DONE
|
|
48921
|
+
- TIMEOUT
|
|
48922
|
+
SecurityMonitoringCriticalAsset:
|
|
48923
|
+
description: The critical asset's properties.
|
|
48924
|
+
properties:
|
|
48925
|
+
attributes:
|
|
48926
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetAttributes'
|
|
48927
|
+
id:
|
|
48928
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetID'
|
|
48929
|
+
type:
|
|
48930
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetType'
|
|
48931
|
+
type: object
|
|
48932
|
+
SecurityMonitoringCriticalAssetAttributes:
|
|
48933
|
+
description: The attributes of the critical asset.
|
|
48934
|
+
properties:
|
|
48935
|
+
creation_author_id:
|
|
48936
|
+
description: ID of user who created the critical asset.
|
|
48937
|
+
example: 367742
|
|
48938
|
+
format: int64
|
|
48939
|
+
type: integer
|
|
48940
|
+
creation_date:
|
|
48941
|
+
description: A Unix millisecond timestamp given the creation date of the
|
|
48942
|
+
critical asset.
|
|
48943
|
+
format: int64
|
|
48944
|
+
type: integer
|
|
48945
|
+
creator:
|
|
48946
|
+
$ref: '#/components/schemas/SecurityMonitoringUser'
|
|
48947
|
+
enabled:
|
|
48948
|
+
description: Whether the critical asset is enabled.
|
|
48949
|
+
example: true
|
|
48950
|
+
type: boolean
|
|
48951
|
+
query:
|
|
48952
|
+
description: The query for the critical asset. It uses the same syntax as
|
|
48953
|
+
the queries to search signals in the Signals Explorer.
|
|
48954
|
+
example: security:monitoring
|
|
48955
|
+
type: string
|
|
48956
|
+
rule_query:
|
|
48957
|
+
description: The rule query of the critical asset, with the same syntax
|
|
48958
|
+
as the search bar for detection rules. This determines which rules this
|
|
48959
|
+
critical asset will apply to.
|
|
48960
|
+
example: type:log_detection source:cloudtrail
|
|
48961
|
+
type: string
|
|
48962
|
+
severity:
|
|
48963
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity'
|
|
48964
|
+
tags:
|
|
48965
|
+
description: List of tags associated with the critical asset.
|
|
48966
|
+
example:
|
|
48967
|
+
- team:database
|
|
48968
|
+
- source:cloudtrail
|
|
48969
|
+
items:
|
|
48970
|
+
type: string
|
|
48971
|
+
type: array
|
|
48972
|
+
update_author_id:
|
|
48973
|
+
description: ID of user who updated the critical asset.
|
|
48974
|
+
example: 367743
|
|
48975
|
+
format: int64
|
|
48976
|
+
type: integer
|
|
48977
|
+
update_date:
|
|
48978
|
+
description: A Unix millisecond timestamp given the update date of the critical
|
|
48979
|
+
asset.
|
|
48980
|
+
format: int64
|
|
48981
|
+
type: integer
|
|
48982
|
+
updater:
|
|
48983
|
+
$ref: '#/components/schemas/SecurityMonitoringUser'
|
|
48984
|
+
version:
|
|
48985
|
+
description: The version of the critical asset; it starts at 1, and is incremented
|
|
48986
|
+
at each update.
|
|
48987
|
+
example: 2
|
|
48988
|
+
format: int32
|
|
48989
|
+
maximum: 2147483647
|
|
48990
|
+
type: integer
|
|
48991
|
+
type: object
|
|
48992
|
+
SecurityMonitoringCriticalAssetCreateAttributes:
|
|
48993
|
+
description: Object containing the attributes of the critical asset to be created.
|
|
48994
|
+
properties:
|
|
48995
|
+
enabled:
|
|
48996
|
+
default: true
|
|
48997
|
+
description: Whether the critical asset is enabled. Defaults to `true` if
|
|
48998
|
+
not specified.
|
|
48999
|
+
example: true
|
|
49000
|
+
type: boolean
|
|
49001
|
+
query:
|
|
49002
|
+
description: The query for the critical asset. It uses the same syntax as
|
|
49003
|
+
the queries to search signals in the Signals Explorer.
|
|
49004
|
+
example: security:monitoring
|
|
49005
|
+
type: string
|
|
49006
|
+
rule_query:
|
|
49007
|
+
description: The rule query of the critical asset, with the same syntax
|
|
49008
|
+
as the search bar for detection rules. This determines which rules this
|
|
49009
|
+
critical asset will apply to.
|
|
49010
|
+
example: type:(log_detection OR signal_correlation OR workload_security
|
|
49011
|
+
OR application_security) source:cloudtrail
|
|
49012
|
+
type: string
|
|
49013
|
+
severity:
|
|
49014
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity'
|
|
49015
|
+
tags:
|
|
49016
|
+
description: List of tags associated with the critical asset.
|
|
49017
|
+
example:
|
|
49018
|
+
- team:database
|
|
49019
|
+
- source:cloudtrail
|
|
49020
|
+
items:
|
|
49021
|
+
type: string
|
|
49022
|
+
type: array
|
|
49023
|
+
required:
|
|
49024
|
+
- query
|
|
49025
|
+
- severity
|
|
49026
|
+
- rule_query
|
|
49027
|
+
type: object
|
|
49028
|
+
SecurityMonitoringCriticalAssetCreateData:
|
|
49029
|
+
description: Object for a single critical asset.
|
|
49030
|
+
properties:
|
|
49031
|
+
attributes:
|
|
49032
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateAttributes'
|
|
49033
|
+
type:
|
|
49034
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetType'
|
|
49035
|
+
required:
|
|
49036
|
+
- type
|
|
49037
|
+
- attributes
|
|
49038
|
+
type: object
|
|
49039
|
+
SecurityMonitoringCriticalAssetCreateRequest:
|
|
49040
|
+
description: Request object that includes the critical asset that you would
|
|
49041
|
+
like to create.
|
|
49042
|
+
properties:
|
|
49043
|
+
data:
|
|
49044
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateData'
|
|
49045
|
+
required:
|
|
49046
|
+
- data
|
|
49047
|
+
type: object
|
|
49048
|
+
SecurityMonitoringCriticalAssetID:
|
|
49049
|
+
description: The ID of the critical asset.
|
|
49050
|
+
example: 4e2435a5-6670-4b8f-baff-46083cd1c250
|
|
49051
|
+
type: string
|
|
49052
|
+
SecurityMonitoringCriticalAssetResponse:
|
|
49053
|
+
description: Response object containing a single critical asset.
|
|
49054
|
+
properties:
|
|
49055
|
+
data:
|
|
49056
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAsset'
|
|
49057
|
+
type: object
|
|
49058
|
+
SecurityMonitoringCriticalAssetSeverity:
|
|
49059
|
+
description: Severity associated with this critical asset. Either an explicit
|
|
49060
|
+
severity can be set, or the severity can be increased or decreased.
|
|
49061
|
+
enum:
|
|
49062
|
+
- info
|
|
49063
|
+
- low
|
|
49064
|
+
- medium
|
|
49065
|
+
- high
|
|
49066
|
+
- critical
|
|
49067
|
+
- increase
|
|
49068
|
+
- decrease
|
|
49069
|
+
example: increase
|
|
49070
|
+
type: string
|
|
49071
|
+
x-enum-varnames:
|
|
49072
|
+
- INFO
|
|
49073
|
+
- LOW
|
|
49074
|
+
- MEDIUM
|
|
49075
|
+
- HIGH
|
|
49076
|
+
- CRITICAL
|
|
49077
|
+
- INCREASE
|
|
49078
|
+
- DECREASE
|
|
49079
|
+
SecurityMonitoringCriticalAssetType:
|
|
49080
|
+
default: critical_assets
|
|
49081
|
+
description: The type of the resource. The value should always be `critical_assets`.
|
|
49082
|
+
enum:
|
|
49083
|
+
- critical_assets
|
|
49084
|
+
example: critical_assets
|
|
49085
|
+
type: string
|
|
49086
|
+
x-enum-varnames:
|
|
49087
|
+
- CRITICAL_ASSETS
|
|
49088
|
+
SecurityMonitoringCriticalAssetUpdateAttributes:
|
|
49089
|
+
description: The critical asset properties to be updated.
|
|
49090
|
+
properties:
|
|
49091
|
+
enabled:
|
|
49092
|
+
description: Whether the critical asset is enabled.
|
|
49093
|
+
example: true
|
|
49094
|
+
type: boolean
|
|
49095
|
+
query:
|
|
49096
|
+
description: The query for the critical asset. It uses the same syntax as
|
|
49097
|
+
the queries to search signals in the Signals Explorer.
|
|
49098
|
+
example: security:monitoring
|
|
49099
|
+
type: string
|
|
49100
|
+
rule_query:
|
|
49101
|
+
description: The rule query of the critical asset, with the same syntax
|
|
49102
|
+
as the search bar for detection rules. This determines which rules this
|
|
49103
|
+
critical asset will apply to.
|
|
49104
|
+
example: type:log_detection source:cloudtrail
|
|
49105
|
+
type: string
|
|
49106
|
+
severity:
|
|
49107
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity'
|
|
49108
|
+
tags:
|
|
49109
|
+
description: List of tags associated with the critical asset.
|
|
49110
|
+
example:
|
|
49111
|
+
- technique:T1110-brute-force
|
|
49112
|
+
- source:cloudtrail
|
|
49113
|
+
items:
|
|
49114
|
+
type: string
|
|
49115
|
+
type: array
|
|
49116
|
+
version:
|
|
49117
|
+
description: The version of the critical asset being updated. Used for optimistic
|
|
49118
|
+
locking to prevent concurrent modifications.
|
|
49119
|
+
example: 1
|
|
49120
|
+
format: int32
|
|
49121
|
+
maximum: 2147483647
|
|
49122
|
+
type: integer
|
|
49123
|
+
type: object
|
|
49124
|
+
SecurityMonitoringCriticalAssetUpdateData:
|
|
49125
|
+
description: The new critical asset properties; partial updates are supported.
|
|
49126
|
+
properties:
|
|
49127
|
+
attributes:
|
|
49128
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateAttributes'
|
|
49129
|
+
type:
|
|
49130
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetType'
|
|
49131
|
+
required:
|
|
49132
|
+
- type
|
|
49133
|
+
- attributes
|
|
49134
|
+
type: object
|
|
49135
|
+
SecurityMonitoringCriticalAssetUpdateRequest:
|
|
49136
|
+
description: Request object containing the fields to update on the critical
|
|
49137
|
+
asset.
|
|
49138
|
+
properties:
|
|
49139
|
+
data:
|
|
49140
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateData'
|
|
49141
|
+
required:
|
|
49142
|
+
- data
|
|
49143
|
+
type: object
|
|
49144
|
+
SecurityMonitoringCriticalAssetsResponse:
|
|
49145
|
+
description: Response object containing the available critical assets.
|
|
49146
|
+
properties:
|
|
49147
|
+
data:
|
|
49148
|
+
description: A list of critical assets objects.
|
|
49149
|
+
items:
|
|
49150
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAsset'
|
|
49151
|
+
type: array
|
|
49152
|
+
type: object
|
|
47819
49153
|
SecurityMonitoringFilter:
|
|
47820
49154
|
description: The rule's suppression filter.
|
|
47821
49155
|
properties:
|
|
@@ -59416,6 +60750,8 @@ components:
|
|
|
59416
60750
|
apm_service_catalog_read: View service catalog and service definitions.
|
|
59417
60751
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
|
59418
60752
|
when those definitions are maintained by Datadog.
|
|
60753
|
+
appsec_vm_read: View infrastructure, application code, and library vulnerability
|
|
60754
|
+
findings.
|
|
59419
60755
|
billing_read: View your organization's billing information.
|
|
59420
60756
|
cases_read: View Cases.
|
|
59421
60757
|
cases_write: Create and update cases.
|
|
@@ -59470,6 +60806,8 @@ components:
|
|
|
59470
60806
|
& unsubscribing from apps in the marketplace, and enabling & disabling
|
|
59471
60807
|
Remote Configuration for the entire organization.
|
|
59472
60808
|
security_comments_read: Read comments of vulnerabilities.
|
|
60809
|
+
security_monitoring_critical_assets_read: Read Critical Assets.
|
|
60810
|
+
security_monitoring_critical_assets_write: Write Critical Assets.
|
|
59473
60811
|
security_monitoring_filters_read: Read Security Filters.
|
|
59474
60812
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
|
59475
60813
|
security_monitoring_findings_read: View a list of findings that include
|
|
@@ -59593,13 +60931,14 @@ paths:
|
|
|
59593
60931
|
results.'
|
|
59594
60932
|
operationId: ListFleetAgents
|
|
59595
60933
|
parameters:
|
|
59596
|
-
- description: Page number for pagination (
|
|
60934
|
+
- description: Page number for pagination (starts at 0).
|
|
59597
60935
|
in: query
|
|
59598
60936
|
name: page_number
|
|
59599
60937
|
required: false
|
|
59600
60938
|
schema:
|
|
60939
|
+
default: 0
|
|
59601
60940
|
format: int64
|
|
59602
|
-
minimum:
|
|
60941
|
+
minimum: 0
|
|
59603
60942
|
type: integer
|
|
59604
60943
|
- description: Number of results per page (must be greater than 0 and less than
|
|
59605
60944
|
or equal to 100).
|
|
@@ -69191,15 +70530,49 @@ paths:
|
|
|
69191
70530
|
events with the `change` or `alert` category** are in General Availability.
|
|
69192
70531
|
For change events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
|
|
69193
70532
|
for more details.\n\n\u274C For use cases involving other event categories,
|
|
69194
|
-
use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/)
|
|
69195
|
-
Notifications are not yet supported for events sent to this endpoint. Use
|
|
69196
|
-
the V1 endpoint for notification functionality."
|
|
70533
|
+
use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/)."
|
|
69197
70534
|
operationId: CreateEvent
|
|
69198
70535
|
requestBody:
|
|
69199
70536
|
content:
|
|
69200
70537
|
application/json:
|
|
69201
70538
|
examples:
|
|
69202
|
-
|
|
70539
|
+
alert-event:
|
|
70540
|
+
description: Example of an alert event for tracking alerts and monitoring
|
|
70541
|
+
events.
|
|
70542
|
+
summary: Alert Event
|
|
70543
|
+
value:
|
|
70544
|
+
data:
|
|
70545
|
+
attributes:
|
|
70546
|
+
aggregation_key: deduplication_key_here
|
|
70547
|
+
attributes:
|
|
70548
|
+
custom:
|
|
70549
|
+
my-object-attribute:
|
|
70550
|
+
my-array-attribute:
|
|
70551
|
+
- 1
|
|
70552
|
+
- 2
|
|
70553
|
+
- 3
|
|
70554
|
+
my-array-object-attribute:
|
|
70555
|
+
- name: test-object-1
|
|
70556
|
+
- name: test-object-2
|
|
70557
|
+
my-integer-attribute: 1
|
|
70558
|
+
my-string-attribute: my-custom-value
|
|
70559
|
+
links:
|
|
70560
|
+
- category: runbook
|
|
70561
|
+
title: Datadog website
|
|
70562
|
+
url: https://datadoghq.com
|
|
70563
|
+
priority: '1'
|
|
70564
|
+
status: error
|
|
70565
|
+
category: alert
|
|
70566
|
+
message: Something is broken!
|
|
70567
|
+
tags:
|
|
70568
|
+
- service:my-test-service
|
|
70569
|
+
- datacenter:primary
|
|
70570
|
+
title: My Alerting Event
|
|
70571
|
+
type: event
|
|
70572
|
+
change-event:
|
|
70573
|
+
description: Example of a change event for tracking configuration
|
|
70574
|
+
or feature flag changes.
|
|
70575
|
+
summary: Change Event
|
|
69203
70576
|
value:
|
|
69204
70577
|
data:
|
|
69205
70578
|
attributes:
|
|
@@ -76339,6 +77712,222 @@ paths:
|
|
|
76339
77712
|
summary: Get all aggregated DNS traffic
|
|
76340
77713
|
tags:
|
|
76341
77714
|
- Cloud Network Monitoring
|
|
77715
|
+
/api/v2/obs-pipelines/pipelines:
|
|
77716
|
+
get:
|
|
77717
|
+
description: Retrieve a list of pipelines.
|
|
77718
|
+
operationId: ListPipelines
|
|
77719
|
+
parameters:
|
|
77720
|
+
- $ref: '#/components/parameters/PageSize'
|
|
77721
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
77722
|
+
responses:
|
|
77723
|
+
'200':
|
|
77724
|
+
content:
|
|
77725
|
+
application/json:
|
|
77726
|
+
schema:
|
|
77727
|
+
$ref: '#/components/schemas/ListPipelinesResponse'
|
|
77728
|
+
description: OK
|
|
77729
|
+
'400':
|
|
77730
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77731
|
+
'403':
|
|
77732
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
77733
|
+
'429':
|
|
77734
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77735
|
+
summary: List pipelines
|
|
77736
|
+
tags:
|
|
77737
|
+
- Observability Pipelines
|
|
77738
|
+
x-permission:
|
|
77739
|
+
operator: OR
|
|
77740
|
+
permissions:
|
|
77741
|
+
- observability_pipelines_read
|
|
77742
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
77743
|
+
to request access.'
|
|
77744
|
+
post:
|
|
77745
|
+
description: Create a new pipeline.
|
|
77746
|
+
operationId: CreatePipeline
|
|
77747
|
+
requestBody:
|
|
77748
|
+
content:
|
|
77749
|
+
application/json:
|
|
77750
|
+
schema:
|
|
77751
|
+
$ref: '#/components/schemas/ObservabilityPipelineSpec'
|
|
77752
|
+
required: true
|
|
77753
|
+
responses:
|
|
77754
|
+
'201':
|
|
77755
|
+
content:
|
|
77756
|
+
application/json:
|
|
77757
|
+
schema:
|
|
77758
|
+
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
77759
|
+
description: OK
|
|
77760
|
+
'400':
|
|
77761
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77762
|
+
'403':
|
|
77763
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
77764
|
+
'409':
|
|
77765
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
77766
|
+
'429':
|
|
77767
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77768
|
+
summary: Create a new pipeline
|
|
77769
|
+
tags:
|
|
77770
|
+
- Observability Pipelines
|
|
77771
|
+
x-permission:
|
|
77772
|
+
operator: OR
|
|
77773
|
+
permissions:
|
|
77774
|
+
- observability_pipelines_deploy
|
|
77775
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
77776
|
+
to request access.'
|
|
77777
|
+
/api/v2/obs-pipelines/pipelines/validate:
|
|
77778
|
+
post:
|
|
77779
|
+
description: 'Validates a pipeline configuration without creating or updating
|
|
77780
|
+
any resources.
|
|
77781
|
+
|
|
77782
|
+
Returns a list of validation errors, if any.'
|
|
77783
|
+
operationId: ValidatePipeline
|
|
77784
|
+
requestBody:
|
|
77785
|
+
content:
|
|
77786
|
+
application/json:
|
|
77787
|
+
schema:
|
|
77788
|
+
$ref: '#/components/schemas/ObservabilityPipelineSpec'
|
|
77789
|
+
required: true
|
|
77790
|
+
responses:
|
|
77791
|
+
'200':
|
|
77792
|
+
content:
|
|
77793
|
+
application/json:
|
|
77794
|
+
schema:
|
|
77795
|
+
$ref: '#/components/schemas/ValidationResponse'
|
|
77796
|
+
description: OK
|
|
77797
|
+
'400':
|
|
77798
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77799
|
+
'403':
|
|
77800
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
77801
|
+
'429':
|
|
77802
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77803
|
+
summary: Validate an observability pipeline
|
|
77804
|
+
tags:
|
|
77805
|
+
- Observability Pipelines
|
|
77806
|
+
x-permission:
|
|
77807
|
+
operator: OR
|
|
77808
|
+
permissions:
|
|
77809
|
+
- observability_pipelines_read
|
|
77810
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
77811
|
+
to request access.'
|
|
77812
|
+
/api/v2/obs-pipelines/pipelines/{pipeline_id}:
|
|
77813
|
+
delete:
|
|
77814
|
+
description: Delete a pipeline.
|
|
77815
|
+
operationId: DeletePipeline
|
|
77816
|
+
parameters:
|
|
77817
|
+
- description: The ID of the pipeline to delete.
|
|
77818
|
+
in: path
|
|
77819
|
+
name: pipeline_id
|
|
77820
|
+
required: true
|
|
77821
|
+
schema:
|
|
77822
|
+
type: string
|
|
77823
|
+
responses:
|
|
77824
|
+
'204':
|
|
77825
|
+
description: OK
|
|
77826
|
+
'403':
|
|
77827
|
+
content:
|
|
77828
|
+
application/json:
|
|
77829
|
+
schema:
|
|
77830
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
77831
|
+
description: Forbidden
|
|
77832
|
+
'404':
|
|
77833
|
+
content:
|
|
77834
|
+
application/json:
|
|
77835
|
+
schema:
|
|
77836
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
77837
|
+
description: Not Found
|
|
77838
|
+
'409':
|
|
77839
|
+
content:
|
|
77840
|
+
application/json:
|
|
77841
|
+
schema:
|
|
77842
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
77843
|
+
description: Conflict
|
|
77844
|
+
'429':
|
|
77845
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77846
|
+
summary: Delete a pipeline
|
|
77847
|
+
tags:
|
|
77848
|
+
- Observability Pipelines
|
|
77849
|
+
x-permission:
|
|
77850
|
+
operator: OR
|
|
77851
|
+
permissions:
|
|
77852
|
+
- observability_pipelines_delete
|
|
77853
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
77854
|
+
to request access.'
|
|
77855
|
+
get:
|
|
77856
|
+
description: Get a specific pipeline by its ID.
|
|
77857
|
+
operationId: GetPipeline
|
|
77858
|
+
parameters:
|
|
77859
|
+
- description: The ID of the pipeline to retrieve.
|
|
77860
|
+
in: path
|
|
77861
|
+
name: pipeline_id
|
|
77862
|
+
required: true
|
|
77863
|
+
schema:
|
|
77864
|
+
type: string
|
|
77865
|
+
responses:
|
|
77866
|
+
'200':
|
|
77867
|
+
content:
|
|
77868
|
+
application/json:
|
|
77869
|
+
schema:
|
|
77870
|
+
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
77871
|
+
description: OK
|
|
77872
|
+
'403':
|
|
77873
|
+
content:
|
|
77874
|
+
application/json:
|
|
77875
|
+
schema:
|
|
77876
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
77877
|
+
description: Forbidden
|
|
77878
|
+
'429':
|
|
77879
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77880
|
+
summary: Get a specific pipeline
|
|
77881
|
+
tags:
|
|
77882
|
+
- Observability Pipelines
|
|
77883
|
+
x-permission:
|
|
77884
|
+
operator: OR
|
|
77885
|
+
permissions:
|
|
77886
|
+
- observability_pipelines_read
|
|
77887
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
77888
|
+
to request access.'
|
|
77889
|
+
put:
|
|
77890
|
+
description: Update a pipeline.
|
|
77891
|
+
operationId: UpdatePipeline
|
|
77892
|
+
parameters:
|
|
77893
|
+
- description: The ID of the pipeline to update.
|
|
77894
|
+
in: path
|
|
77895
|
+
name: pipeline_id
|
|
77896
|
+
required: true
|
|
77897
|
+
schema:
|
|
77898
|
+
type: string
|
|
77899
|
+
requestBody:
|
|
77900
|
+
content:
|
|
77901
|
+
application/json:
|
|
77902
|
+
schema:
|
|
77903
|
+
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
77904
|
+
required: true
|
|
77905
|
+
responses:
|
|
77906
|
+
'200':
|
|
77907
|
+
content:
|
|
77908
|
+
application/json:
|
|
77909
|
+
schema:
|
|
77910
|
+
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
77911
|
+
description: OK
|
|
77912
|
+
'400':
|
|
77913
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77914
|
+
'403':
|
|
77915
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
77916
|
+
'404':
|
|
77917
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
77918
|
+
'409':
|
|
77919
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
77920
|
+
'429':
|
|
77921
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77922
|
+
summary: Update a pipeline
|
|
77923
|
+
tags:
|
|
77924
|
+
- Observability Pipelines
|
|
77925
|
+
x-permission:
|
|
77926
|
+
operator: OR
|
|
77927
|
+
permissions:
|
|
77928
|
+
- observability_pipelines_deploy
|
|
77929
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
77930
|
+
to request access.'
|
|
76342
77931
|
/api/v2/on-call/escalation-policies:
|
|
76343
77932
|
post:
|
|
76344
77933
|
description: Create a new On-Call escalation policy
|
|
@@ -77986,7 +79575,13 @@ paths:
|
|
|
77986
79575
|
cursorPath: meta.page.cursor
|
|
77987
79576
|
limitParam: page[limit]
|
|
77988
79577
|
resultsPath: data
|
|
77989
|
-
x-unstable: '**Note**: This endpoint
|
|
79578
|
+
x-unstable: '**Note**: This endpoint uses the legacy security findings data
|
|
79579
|
+
model and is planned for deprecation.
|
|
79580
|
+
|
|
79581
|
+
Use the [search security findings endpoint](https://docs.datadoghq.com/api/latest/security-monitoring/#search-security-findings),
|
|
79582
|
+
|
|
79583
|
+
which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/),
|
|
79584
|
+
to search security findings.
|
|
77990
79585
|
|
|
77991
79586
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
77992
79587
|
patch:
|
|
@@ -78086,7 +79681,13 @@ paths:
|
|
|
78086
79681
|
summary: Get a finding
|
|
78087
79682
|
tags:
|
|
78088
79683
|
- Security Monitoring
|
|
78089
|
-
x-unstable: '**Note**: This endpoint
|
|
79684
|
+
x-unstable: '**Note**: This endpoint uses the legacy security findings data
|
|
79685
|
+
model and is planned for deprecation.
|
|
79686
|
+
|
|
79687
|
+
Use the [search security findings endpoint](https://docs.datadoghq.com/api/latest/security-monitoring/#search-security-findings),
|
|
79688
|
+
|
|
79689
|
+
which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/),
|
|
79690
|
+
to search security findings.
|
|
78090
79691
|
|
|
78091
79692
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
78092
79693
|
/api/v2/powerpacks:
|
|
@@ -79331,6 +80932,18 @@ paths:
|
|
|
79331
80932
|
requestBody:
|
|
79332
80933
|
content:
|
|
79333
80934
|
application/json:
|
|
80935
|
+
examples:
|
|
80936
|
+
happy_path:
|
|
80937
|
+
summary: Upsert a row with mixed string and int values
|
|
80938
|
+
value:
|
|
80939
|
+
data:
|
|
80940
|
+
- attributes:
|
|
80941
|
+
values:
|
|
80942
|
+
age: 25
|
|
80943
|
+
example_key_value: primary_key_value
|
|
80944
|
+
name: row_name
|
|
80945
|
+
id: primary_key_value
|
|
80946
|
+
type: row
|
|
79334
80947
|
schema:
|
|
79335
80948
|
$ref: '#/components/schemas/BatchUpsertRowsRequestArray'
|
|
79336
80949
|
required: true
|
|
@@ -79985,222 +81598,6 @@ paths:
|
|
|
79985
81598
|
tags:
|
|
79986
81599
|
- CSM Threats
|
|
79987
81600
|
x-codegen-request-body-name: body
|
|
79988
|
-
/api/v2/remote_config/products/obs_pipelines/pipelines:
|
|
79989
|
-
get:
|
|
79990
|
-
description: Retrieve a list of pipelines.
|
|
79991
|
-
operationId: ListPipelines
|
|
79992
|
-
parameters:
|
|
79993
|
-
- $ref: '#/components/parameters/PageSize'
|
|
79994
|
-
- $ref: '#/components/parameters/PageNumber'
|
|
79995
|
-
responses:
|
|
79996
|
-
'200':
|
|
79997
|
-
content:
|
|
79998
|
-
application/json:
|
|
79999
|
-
schema:
|
|
80000
|
-
$ref: '#/components/schemas/ListPipelinesResponse'
|
|
80001
|
-
description: OK
|
|
80002
|
-
'400':
|
|
80003
|
-
$ref: '#/components/responses/BadRequestResponse'
|
|
80004
|
-
'403':
|
|
80005
|
-
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
80006
|
-
'429':
|
|
80007
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
80008
|
-
summary: List pipelines
|
|
80009
|
-
tags:
|
|
80010
|
-
- Observability Pipelines
|
|
80011
|
-
x-permission:
|
|
80012
|
-
operator: OR
|
|
80013
|
-
permissions:
|
|
80014
|
-
- observability_pipelines_read
|
|
80015
|
-
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
80016
|
-
to request access.'
|
|
80017
|
-
post:
|
|
80018
|
-
description: Create a new pipeline.
|
|
80019
|
-
operationId: CreatePipeline
|
|
80020
|
-
requestBody:
|
|
80021
|
-
content:
|
|
80022
|
-
application/json:
|
|
80023
|
-
schema:
|
|
80024
|
-
$ref: '#/components/schemas/ObservabilityPipelineSpec'
|
|
80025
|
-
required: true
|
|
80026
|
-
responses:
|
|
80027
|
-
'201':
|
|
80028
|
-
content:
|
|
80029
|
-
application/json:
|
|
80030
|
-
schema:
|
|
80031
|
-
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
80032
|
-
description: OK
|
|
80033
|
-
'400':
|
|
80034
|
-
$ref: '#/components/responses/BadRequestResponse'
|
|
80035
|
-
'403':
|
|
80036
|
-
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
80037
|
-
'409':
|
|
80038
|
-
$ref: '#/components/responses/ConflictResponse'
|
|
80039
|
-
'429':
|
|
80040
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
80041
|
-
summary: Create a new pipeline
|
|
80042
|
-
tags:
|
|
80043
|
-
- Observability Pipelines
|
|
80044
|
-
x-permission:
|
|
80045
|
-
operator: OR
|
|
80046
|
-
permissions:
|
|
80047
|
-
- observability_pipelines_deploy
|
|
80048
|
-
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
80049
|
-
to request access.'
|
|
80050
|
-
/api/v2/remote_config/products/obs_pipelines/pipelines/validate:
|
|
80051
|
-
post:
|
|
80052
|
-
description: 'Validates a pipeline configuration without creating or updating
|
|
80053
|
-
any resources.
|
|
80054
|
-
|
|
80055
|
-
Returns a list of validation errors, if any.'
|
|
80056
|
-
operationId: ValidatePipeline
|
|
80057
|
-
requestBody:
|
|
80058
|
-
content:
|
|
80059
|
-
application/json:
|
|
80060
|
-
schema:
|
|
80061
|
-
$ref: '#/components/schemas/ObservabilityPipelineSpec'
|
|
80062
|
-
required: true
|
|
80063
|
-
responses:
|
|
80064
|
-
'200':
|
|
80065
|
-
content:
|
|
80066
|
-
application/json:
|
|
80067
|
-
schema:
|
|
80068
|
-
$ref: '#/components/schemas/ValidationResponse'
|
|
80069
|
-
description: OK
|
|
80070
|
-
'400':
|
|
80071
|
-
$ref: '#/components/responses/BadRequestResponse'
|
|
80072
|
-
'403':
|
|
80073
|
-
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
80074
|
-
'429':
|
|
80075
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
80076
|
-
summary: Validate an observability pipeline
|
|
80077
|
-
tags:
|
|
80078
|
-
- Observability Pipelines
|
|
80079
|
-
x-permission:
|
|
80080
|
-
operator: OR
|
|
80081
|
-
permissions:
|
|
80082
|
-
- observability_pipelines_read
|
|
80083
|
-
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
80084
|
-
to request access.'
|
|
80085
|
-
/api/v2/remote_config/products/obs_pipelines/pipelines/{pipeline_id}:
|
|
80086
|
-
delete:
|
|
80087
|
-
description: Delete a pipeline.
|
|
80088
|
-
operationId: DeletePipeline
|
|
80089
|
-
parameters:
|
|
80090
|
-
- description: The ID of the pipeline to delete.
|
|
80091
|
-
in: path
|
|
80092
|
-
name: pipeline_id
|
|
80093
|
-
required: true
|
|
80094
|
-
schema:
|
|
80095
|
-
type: string
|
|
80096
|
-
responses:
|
|
80097
|
-
'204':
|
|
80098
|
-
description: OK
|
|
80099
|
-
'403':
|
|
80100
|
-
content:
|
|
80101
|
-
application/json:
|
|
80102
|
-
schema:
|
|
80103
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
80104
|
-
description: Forbidden
|
|
80105
|
-
'404':
|
|
80106
|
-
content:
|
|
80107
|
-
application/json:
|
|
80108
|
-
schema:
|
|
80109
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
80110
|
-
description: Not Found
|
|
80111
|
-
'409':
|
|
80112
|
-
content:
|
|
80113
|
-
application/json:
|
|
80114
|
-
schema:
|
|
80115
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
80116
|
-
description: Conflict
|
|
80117
|
-
'429':
|
|
80118
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
80119
|
-
summary: Delete a pipeline
|
|
80120
|
-
tags:
|
|
80121
|
-
- Observability Pipelines
|
|
80122
|
-
x-permission:
|
|
80123
|
-
operator: OR
|
|
80124
|
-
permissions:
|
|
80125
|
-
- observability_pipelines_delete
|
|
80126
|
-
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
80127
|
-
to request access.'
|
|
80128
|
-
get:
|
|
80129
|
-
description: Get a specific pipeline by its ID.
|
|
80130
|
-
operationId: GetPipeline
|
|
80131
|
-
parameters:
|
|
80132
|
-
- description: The ID of the pipeline to retrieve.
|
|
80133
|
-
in: path
|
|
80134
|
-
name: pipeline_id
|
|
80135
|
-
required: true
|
|
80136
|
-
schema:
|
|
80137
|
-
type: string
|
|
80138
|
-
responses:
|
|
80139
|
-
'200':
|
|
80140
|
-
content:
|
|
80141
|
-
application/json:
|
|
80142
|
-
schema:
|
|
80143
|
-
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
80144
|
-
description: OK
|
|
80145
|
-
'403':
|
|
80146
|
-
content:
|
|
80147
|
-
application/json:
|
|
80148
|
-
schema:
|
|
80149
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
80150
|
-
description: Forbidden
|
|
80151
|
-
'429':
|
|
80152
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
80153
|
-
summary: Get a specific pipeline
|
|
80154
|
-
tags:
|
|
80155
|
-
- Observability Pipelines
|
|
80156
|
-
x-permission:
|
|
80157
|
-
operator: OR
|
|
80158
|
-
permissions:
|
|
80159
|
-
- observability_pipelines_read
|
|
80160
|
-
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
80161
|
-
to request access.'
|
|
80162
|
-
put:
|
|
80163
|
-
description: Update a pipeline.
|
|
80164
|
-
operationId: UpdatePipeline
|
|
80165
|
-
parameters:
|
|
80166
|
-
- description: The ID of the pipeline to update.
|
|
80167
|
-
in: path
|
|
80168
|
-
name: pipeline_id
|
|
80169
|
-
required: true
|
|
80170
|
-
schema:
|
|
80171
|
-
type: string
|
|
80172
|
-
requestBody:
|
|
80173
|
-
content:
|
|
80174
|
-
application/json:
|
|
80175
|
-
schema:
|
|
80176
|
-
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
80177
|
-
required: true
|
|
80178
|
-
responses:
|
|
80179
|
-
'200':
|
|
80180
|
-
content:
|
|
80181
|
-
application/json:
|
|
80182
|
-
schema:
|
|
80183
|
-
$ref: '#/components/schemas/ObservabilityPipeline'
|
|
80184
|
-
description: OK
|
|
80185
|
-
'400':
|
|
80186
|
-
$ref: '#/components/responses/BadRequestResponse'
|
|
80187
|
-
'403':
|
|
80188
|
-
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
80189
|
-
'404':
|
|
80190
|
-
$ref: '#/components/responses/NotFoundResponse'
|
|
80191
|
-
'409':
|
|
80192
|
-
$ref: '#/components/responses/ConflictResponse'
|
|
80193
|
-
'429':
|
|
80194
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
80195
|
-
summary: Update a pipeline
|
|
80196
|
-
tags:
|
|
80197
|
-
- Observability Pipelines
|
|
80198
|
-
x-permission:
|
|
80199
|
-
operator: OR
|
|
80200
|
-
permissions:
|
|
80201
|
-
- observability_pipelines_deploy
|
|
80202
|
-
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
|
80203
|
-
to request access.'
|
|
80204
81601
|
/api/v2/restriction_policy/{resource_id}:
|
|
80205
81602
|
delete:
|
|
80206
81603
|
description: Deletes the restriction policy associated with a specified resource.
|
|
@@ -82018,6 +83415,87 @@ paths:
|
|
|
82018
83415
|
operator: OR
|
|
82019
83416
|
permissions:
|
|
82020
83417
|
- security_monitoring_cws_agent_rules_read
|
|
83418
|
+
/api/v2/security/findings:
|
|
83419
|
+
get:
|
|
83420
|
+
description: 'Get a list of security findings that match a search query. [See
|
|
83421
|
+
the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/).
|
|
83422
|
+
|
|
83423
|
+
|
|
83424
|
+
### Query Syntax
|
|
83425
|
+
|
|
83426
|
+
|
|
83427
|
+
This endpoint uses the logs query syntax. Findings attributes (living in the
|
|
83428
|
+
attributes.attributes. namespace) are prefixed by @ when queried. Tags are
|
|
83429
|
+
queried without a prefix.
|
|
83430
|
+
|
|
83431
|
+
|
|
83432
|
+
Example: `@severity:(critical OR high) @status:open team:platform`'
|
|
83433
|
+
operationId: ListSecurityFindings
|
|
83434
|
+
parameters:
|
|
83435
|
+
- description: The search query following log search syntax.
|
|
83436
|
+
example: '@severity:(critical OR high) @status:open team:platform'
|
|
83437
|
+
in: query
|
|
83438
|
+
name: filter[query]
|
|
83439
|
+
required: false
|
|
83440
|
+
schema:
|
|
83441
|
+
default: '*'
|
|
83442
|
+
type: string
|
|
83443
|
+
- description: Get the next page of results with a cursor provided in the previous
|
|
83444
|
+
query.
|
|
83445
|
+
example: eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ==
|
|
83446
|
+
in: query
|
|
83447
|
+
name: page[cursor]
|
|
83448
|
+
required: false
|
|
83449
|
+
schema:
|
|
83450
|
+
type: string
|
|
83451
|
+
- description: The maximum number of findings in the response.
|
|
83452
|
+
example: 25
|
|
83453
|
+
in: query
|
|
83454
|
+
name: page[limit]
|
|
83455
|
+
required: false
|
|
83456
|
+
schema:
|
|
83457
|
+
default: 10
|
|
83458
|
+
format: int64
|
|
83459
|
+
maximum: 150
|
|
83460
|
+
minimum: 1
|
|
83461
|
+
type: integer
|
|
83462
|
+
- description: Sorts by @detection_changed_at.
|
|
83463
|
+
in: query
|
|
83464
|
+
name: sort
|
|
83465
|
+
required: false
|
|
83466
|
+
schema:
|
|
83467
|
+
$ref: '#/components/schemas/SecurityFindingsSort'
|
|
83468
|
+
responses:
|
|
83469
|
+
'200':
|
|
83470
|
+
content:
|
|
83471
|
+
application/json:
|
|
83472
|
+
schema:
|
|
83473
|
+
$ref: '#/components/schemas/ListSecurityFindingsResponse'
|
|
83474
|
+
description: OK
|
|
83475
|
+
'400':
|
|
83476
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
83477
|
+
'403':
|
|
83478
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
83479
|
+
'429':
|
|
83480
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
83481
|
+
security:
|
|
83482
|
+
- apiKeyAuth: []
|
|
83483
|
+
appKeyAuth: []
|
|
83484
|
+
- AuthZ:
|
|
83485
|
+
- security_monitoring_findings_read
|
|
83486
|
+
summary: List security findings
|
|
83487
|
+
tags:
|
|
83488
|
+
- Security Monitoring
|
|
83489
|
+
x-pagination:
|
|
83490
|
+
cursorParam: page[cursor]
|
|
83491
|
+
cursorPath: meta.page.after
|
|
83492
|
+
limitParam: page[limit]
|
|
83493
|
+
resultsPath: data
|
|
83494
|
+
x-permission:
|
|
83495
|
+
operator: OR
|
|
83496
|
+
permissions:
|
|
83497
|
+
- security_monitoring_findings_read
|
|
83498
|
+
- appsec_vm_read
|
|
82021
83499
|
/api/v2/security/findings/cases:
|
|
82022
83500
|
delete:
|
|
82023
83501
|
description: 'Detach security findings from their case.
|
|
@@ -82237,6 +83715,59 @@ paths:
|
|
|
82237
83715
|
x-unstable: '**Note**: This endpoint is in beta and is subject to change.
|
|
82238
83716
|
|
|
82239
83717
|
Please check the documentation regularly for updates.'
|
|
83718
|
+
/api/v2/security/findings/search:
|
|
83719
|
+
post:
|
|
83720
|
+
description: 'Get a list of security findings that match a search query. [See
|
|
83721
|
+
the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/).
|
|
83722
|
+
|
|
83723
|
+
|
|
83724
|
+
### Query Syntax
|
|
83725
|
+
|
|
83726
|
+
|
|
83727
|
+
The API uses the logs query syntax. Findings attributes (living in the attributes.attributes.
|
|
83728
|
+
namespace) are prefixed by @ when queried. Tags are queried without a prefix.
|
|
83729
|
+
|
|
83730
|
+
|
|
83731
|
+
Example: `@severity:(critical OR high) @status:open team:platform`'
|
|
83732
|
+
operationId: SearchSecurityFindings
|
|
83733
|
+
requestBody:
|
|
83734
|
+
content:
|
|
83735
|
+
application/json:
|
|
83736
|
+
schema:
|
|
83737
|
+
$ref: '#/components/schemas/SecurityFindingsSearchRequest'
|
|
83738
|
+
required: true
|
|
83739
|
+
responses:
|
|
83740
|
+
'200':
|
|
83741
|
+
content:
|
|
83742
|
+
application/json:
|
|
83743
|
+
schema:
|
|
83744
|
+
$ref: '#/components/schemas/ListSecurityFindingsResponse'
|
|
83745
|
+
description: OK
|
|
83746
|
+
'400':
|
|
83747
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
83748
|
+
'403':
|
|
83749
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
83750
|
+
'429':
|
|
83751
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
83752
|
+
security:
|
|
83753
|
+
- apiKeyAuth: []
|
|
83754
|
+
appKeyAuth: []
|
|
83755
|
+
- AuthZ:
|
|
83756
|
+
- security_monitoring_findings_read
|
|
83757
|
+
summary: Search security findings
|
|
83758
|
+
tags:
|
|
83759
|
+
- Security Monitoring
|
|
83760
|
+
x-codegen-request-body-name: body
|
|
83761
|
+
x-pagination:
|
|
83762
|
+
cursorParam: body.data.attributes.page.cursor
|
|
83763
|
+
cursorPath: meta.page.after
|
|
83764
|
+
limitParam: body.data.attributes.page.limit
|
|
83765
|
+
resultsPath: data
|
|
83766
|
+
x-permission:
|
|
83767
|
+
operator: OR
|
|
83768
|
+
permissions:
|
|
83769
|
+
- security_monitoring_findings_read
|
|
83770
|
+
- appsec_vm_read
|
|
82240
83771
|
/api/v2/security/sboms:
|
|
82241
83772
|
get:
|
|
82242
83773
|
description: 'Get a list of assets SBOMs for an organization.
|
|
@@ -83660,6 +85191,184 @@ paths:
|
|
|
83660
85191
|
operator: OR
|
|
83661
85192
|
permissions:
|
|
83662
85193
|
- security_monitoring_cws_agent_rules_write
|
|
85194
|
+
/api/v2/security_monitoring/configuration/critical_assets:
|
|
85195
|
+
get:
|
|
85196
|
+
description: Get the list of all critical assets.
|
|
85197
|
+
operationId: ListSecurityMonitoringCriticalAssets
|
|
85198
|
+
parameters:
|
|
85199
|
+
- description: Query string.
|
|
85200
|
+
in: query
|
|
85201
|
+
name: query
|
|
85202
|
+
required: false
|
|
85203
|
+
schema:
|
|
85204
|
+
type: string
|
|
85205
|
+
responses:
|
|
85206
|
+
'200':
|
|
85207
|
+
content:
|
|
85208
|
+
application/json:
|
|
85209
|
+
schema:
|
|
85210
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetsResponse'
|
|
85211
|
+
description: OK
|
|
85212
|
+
'403':
|
|
85213
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
85214
|
+
'429':
|
|
85215
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
85216
|
+
security:
|
|
85217
|
+
- apiKeyAuth: []
|
|
85218
|
+
appKeyAuth: []
|
|
85219
|
+
- AuthZ:
|
|
85220
|
+
- security_monitoring_critical_assets_read
|
|
85221
|
+
summary: Get all critical assets
|
|
85222
|
+
tags:
|
|
85223
|
+
- Security Monitoring
|
|
85224
|
+
post:
|
|
85225
|
+
description: Create a new critical asset.
|
|
85226
|
+
operationId: CreateSecurityMonitoringCriticalAsset
|
|
85227
|
+
requestBody:
|
|
85228
|
+
content:
|
|
85229
|
+
application/json:
|
|
85230
|
+
schema:
|
|
85231
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateRequest'
|
|
85232
|
+
description: The definition of the new critical asset.
|
|
85233
|
+
required: true
|
|
85234
|
+
responses:
|
|
85235
|
+
'200':
|
|
85236
|
+
content:
|
|
85237
|
+
application/json:
|
|
85238
|
+
schema:
|
|
85239
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse'
|
|
85240
|
+
description: OK
|
|
85241
|
+
'400':
|
|
85242
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
85243
|
+
'403':
|
|
85244
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
85245
|
+
'409':
|
|
85246
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
85247
|
+
'429':
|
|
85248
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
85249
|
+
security:
|
|
85250
|
+
- apiKeyAuth: []
|
|
85251
|
+
appKeyAuth: []
|
|
85252
|
+
- AuthZ:
|
|
85253
|
+
- security_monitoring_critical_assets_write
|
|
85254
|
+
summary: Create a critical asset
|
|
85255
|
+
tags:
|
|
85256
|
+
- Security Monitoring
|
|
85257
|
+
x-codegen-request-body-name: body
|
|
85258
|
+
/api/v2/security_monitoring/configuration/critical_assets/rules/{rule_id}:
|
|
85259
|
+
get:
|
|
85260
|
+
description: Get the list of critical assets that affect a specific existing
|
|
85261
|
+
rule by the rule's ID.
|
|
85262
|
+
operationId: GetCriticalAssetsAffectingRule
|
|
85263
|
+
parameters:
|
|
85264
|
+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
|
|
85265
|
+
responses:
|
|
85266
|
+
'200':
|
|
85267
|
+
content:
|
|
85268
|
+
application/json:
|
|
85269
|
+
schema:
|
|
85270
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetsResponse'
|
|
85271
|
+
description: OK
|
|
85272
|
+
'403':
|
|
85273
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
85274
|
+
'404':
|
|
85275
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
85276
|
+
'429':
|
|
85277
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
85278
|
+
security:
|
|
85279
|
+
- apiKeyAuth: []
|
|
85280
|
+
appKeyAuth: []
|
|
85281
|
+
- AuthZ:
|
|
85282
|
+
- security_monitoring_critical_assets_read
|
|
85283
|
+
summary: Get critical assets affecting a specific rule
|
|
85284
|
+
tags:
|
|
85285
|
+
- Security Monitoring
|
|
85286
|
+
/api/v2/security_monitoring/configuration/critical_assets/{critical_asset_id}:
|
|
85287
|
+
delete:
|
|
85288
|
+
description: Delete a specific critical asset.
|
|
85289
|
+
operationId: DeleteSecurityMonitoringCriticalAsset
|
|
85290
|
+
parameters:
|
|
85291
|
+
- $ref: '#/components/parameters/SecurityMonitoringCriticalAssetID'
|
|
85292
|
+
responses:
|
|
85293
|
+
'204':
|
|
85294
|
+
description: OK
|
|
85295
|
+
'403':
|
|
85296
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
85297
|
+
'404':
|
|
85298
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
85299
|
+
'429':
|
|
85300
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
85301
|
+
security:
|
|
85302
|
+
- apiKeyAuth: []
|
|
85303
|
+
appKeyAuth: []
|
|
85304
|
+
- AuthZ:
|
|
85305
|
+
- security_monitoring_critical_assets_write
|
|
85306
|
+
summary: Delete a critical asset
|
|
85307
|
+
tags:
|
|
85308
|
+
- Security Monitoring
|
|
85309
|
+
get:
|
|
85310
|
+
description: Get the details of a specific critical asset.
|
|
85311
|
+
operationId: GetSecurityMonitoringCriticalAsset
|
|
85312
|
+
parameters:
|
|
85313
|
+
- $ref: '#/components/parameters/SecurityMonitoringCriticalAssetID'
|
|
85314
|
+
responses:
|
|
85315
|
+
'200':
|
|
85316
|
+
content:
|
|
85317
|
+
application/json:
|
|
85318
|
+
schema:
|
|
85319
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse'
|
|
85320
|
+
description: OK
|
|
85321
|
+
'403':
|
|
85322
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
85323
|
+
'404':
|
|
85324
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
85325
|
+
'429':
|
|
85326
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
85327
|
+
security:
|
|
85328
|
+
- apiKeyAuth: []
|
|
85329
|
+
appKeyAuth: []
|
|
85330
|
+
- AuthZ:
|
|
85331
|
+
- security_monitoring_critical_assets_read
|
|
85332
|
+
summary: Get a critical asset
|
|
85333
|
+
tags:
|
|
85334
|
+
- Security Monitoring
|
|
85335
|
+
patch:
|
|
85336
|
+
description: Update a specific critical asset.
|
|
85337
|
+
operationId: UpdateSecurityMonitoringCriticalAsset
|
|
85338
|
+
parameters:
|
|
85339
|
+
- $ref: '#/components/parameters/SecurityMonitoringCriticalAssetID'
|
|
85340
|
+
requestBody:
|
|
85341
|
+
content:
|
|
85342
|
+
application/json:
|
|
85343
|
+
schema:
|
|
85344
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateRequest'
|
|
85345
|
+
description: New definition of the critical asset. Supports partial updates.
|
|
85346
|
+
required: true
|
|
85347
|
+
responses:
|
|
85348
|
+
'200':
|
|
85349
|
+
content:
|
|
85350
|
+
application/json:
|
|
85351
|
+
schema:
|
|
85352
|
+
$ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse'
|
|
85353
|
+
description: OK
|
|
85354
|
+
'400':
|
|
85355
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
85356
|
+
'403':
|
|
85357
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
85358
|
+
'404':
|
|
85359
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
85360
|
+
'409':
|
|
85361
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
|
85362
|
+
'429':
|
|
85363
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
85364
|
+
security:
|
|
85365
|
+
- apiKeyAuth: []
|
|
85366
|
+
appKeyAuth: []
|
|
85367
|
+
- AuthZ:
|
|
85368
|
+
- security_monitoring_critical_assets_write
|
|
85369
|
+
summary: Update a critical asset
|
|
85370
|
+
tags:
|
|
85371
|
+
- Security Monitoring
|
|
83663
85372
|
/api/v2/security_monitoring/configuration/security_filters:
|
|
83664
85373
|
get:
|
|
83665
85374
|
description: Get the list of configured security filters with their definitions.
|
|
@@ -84113,6 +85822,14 @@ paths:
|
|
|
84113
85822
|
parameters:
|
|
84114
85823
|
- $ref: '#/components/parameters/PageSize'
|
|
84115
85824
|
- $ref: '#/components/parameters/PageNumber'
|
|
85825
|
+
- description: A search query to filter security rules. You can filter by attributes
|
|
85826
|
+
such as `type`, `source`, `tags`.
|
|
85827
|
+
example: type:signal_correlation source:cloudtrail
|
|
85828
|
+
in: query
|
|
85829
|
+
name: query
|
|
85830
|
+
required: false
|
|
85831
|
+
schema:
|
|
85832
|
+
type: string
|
|
84116
85833
|
responses:
|
|
84117
85834
|
'200':
|
|
84118
85835
|
content:
|
|
@@ -86346,13 +88063,79 @@ paths:
|
|
|
86346
88063
|
x-unstable: '**Note**: This feature is in private beta. To request access, use
|
|
86347
88064
|
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
|
|
86348
88065
|
docs.'
|
|
86349
|
-
/api/v2/spa/recommendations/{service}
|
|
88066
|
+
/api/v2/spa/recommendations/{service}:
|
|
86350
88067
|
get:
|
|
86351
|
-
description:
|
|
86352
|
-
|
|
86353
|
-
|
|
88068
|
+
description: This endpoint is currently experimental and restricted to Datadog
|
|
88069
|
+
internal use only. Retrieve resource recommendations for a Spark job. The
|
|
88070
|
+
caller (Spark Gateway or DJM UI) provides a service name and SPA returns structured
|
|
88071
|
+
recommendations for driver and executor resources. The version with a shard
|
|
88072
|
+
should be preferred, where possible, as it gives more accurate results.
|
|
86354
88073
|
operationId: GetSPARecommendations
|
|
86355
88074
|
parameters:
|
|
88075
|
+
- description: The recommendation service should not use its metrics cache.
|
|
88076
|
+
in: query
|
|
88077
|
+
name: bypass_cache
|
|
88078
|
+
schema:
|
|
88079
|
+
type: string
|
|
88080
|
+
- description: The service name for a spark job.
|
|
88081
|
+
in: path
|
|
88082
|
+
name: service
|
|
88083
|
+
required: true
|
|
88084
|
+
schema:
|
|
88085
|
+
type: string
|
|
88086
|
+
responses:
|
|
88087
|
+
'200':
|
|
88088
|
+
content:
|
|
88089
|
+
application/json:
|
|
88090
|
+
example:
|
|
88091
|
+
data:
|
|
88092
|
+
attributes:
|
|
88093
|
+
driver:
|
|
88094
|
+
estimation:
|
|
88095
|
+
cpu:
|
|
88096
|
+
max: 1500
|
|
88097
|
+
p75: 1000
|
|
88098
|
+
p95: 1200
|
|
88099
|
+
ephemeral_storage: 896
|
|
88100
|
+
heap: 6144
|
|
88101
|
+
memory: 7168
|
|
88102
|
+
overhead: 1024
|
|
88103
|
+
executor:
|
|
88104
|
+
estimation:
|
|
88105
|
+
cpu:
|
|
88106
|
+
max: 2000
|
|
88107
|
+
p75: 1200
|
|
88108
|
+
p95: 1500
|
|
88109
|
+
ephemeral_storage: 512
|
|
88110
|
+
heap: 3072
|
|
88111
|
+
memory: 4096
|
|
88112
|
+
overhead: 1024
|
|
88113
|
+
id: dedupeactivecontexts:adp_dedupeactivecontexts_org2
|
|
88114
|
+
type: recommendation
|
|
88115
|
+
schema:
|
|
88116
|
+
$ref: '#/components/schemas/RecommendationDocument'
|
|
88117
|
+
description: OK
|
|
88118
|
+
'400':
|
|
88119
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
88120
|
+
'403':
|
|
88121
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
88122
|
+
'429':
|
|
88123
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
88124
|
+
security:
|
|
88125
|
+
- AuthZ: []
|
|
88126
|
+
summary: Get SPA Recommendations
|
|
88127
|
+
tags:
|
|
88128
|
+
- Spa
|
|
88129
|
+
x-unstable: '**Note**: This endpoint is in preview and may change in the future.
|
|
88130
|
+
It is not yet recommended for production use.'
|
|
88131
|
+
/api/v2/spa/recommendations/{service}/{shard}:
|
|
88132
|
+
get:
|
|
88133
|
+
description: This endpoint is currently experimental and restricted to Datadog
|
|
88134
|
+
internal use only. Retrieve resource recommendations for a Spark job. The
|
|
88135
|
+
caller (Spark Gateway or DJM UI) provides a service name and shard identifier,
|
|
88136
|
+
and SPA returns structured recommendations for driver and executor resources.
|
|
88137
|
+
operationId: GetSPARecommendationsWithShard
|
|
88138
|
+
parameters:
|
|
86356
88139
|
- description: The shard tag for a spark job, which differentiates jobs within
|
|
86357
88140
|
the same service that have different resource needs
|
|
86358
88141
|
in: path
|
|
@@ -86366,6 +88149,11 @@ paths:
|
|
|
86366
88149
|
required: true
|
|
86367
88150
|
schema:
|
|
86368
88151
|
type: string
|
|
88152
|
+
- description: The recommendation service should not use its metrics cache.
|
|
88153
|
+
in: query
|
|
88154
|
+
name: bypass_cache
|
|
88155
|
+
schema:
|
|
88156
|
+
type: string
|
|
86369
88157
|
responses:
|
|
86370
88158
|
'200':
|
|
86371
88159
|
content:
|
|
@@ -86404,11 +88192,13 @@ paths:
|
|
|
86404
88192
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
86405
88193
|
'429':
|
|
86406
88194
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
86407
|
-
|
|
88195
|
+
security:
|
|
88196
|
+
- AuthZ: []
|
|
88197
|
+
summary: Get SPA Recommendations with a shard parameter
|
|
86408
88198
|
tags:
|
|
86409
88199
|
- Spa
|
|
86410
|
-
x-unstable: '**Note**: This endpoint is in
|
|
86411
|
-
|
|
88200
|
+
x-unstable: '**Note**: This endpoint is in preview and may change in the future.
|
|
88201
|
+
It is not yet recommended for production use.'
|
|
86412
88202
|
/api/v2/spans/analytics/aggregate:
|
|
86413
88203
|
post:
|
|
86414
88204
|
description: 'The API endpoint to aggregate spans into buckets and compute metrics
|