datadog_api_client 2.30.0 → 2.31.1
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/.apigentools-info +4 -4
- data/.generator/schemas/v1/openapi.yaml +338 -22
- data/.generator/schemas/v2/openapi.yaml +3647 -98
- data/CHANGELOG.md +45 -0
- data/examples/v1/dashboards/CreateDashboard_1490099434.rb +65 -0
- data/examples/v1/dashboards/CreateDashboard_3520534424.rb +61 -0
- data/examples/v1/logs-indexes/DeleteLogsIndex.rb +5 -0
- data/examples/v1/logs-pipelines/CreateLogsPipeline_2707101123.rb +23 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +1 -0
- data/examples/v2/agentless-scanning/CreateAwsOnDemandTask.rb +14 -0
- data/examples/v2/agentless-scanning/CreateAwsScanOptions.rb +18 -0
- data/examples/v2/agentless-scanning/DeleteAwsScanOptions.rb +5 -0
- data/examples/v2/agentless-scanning/GetAwsOnDemandTask.rb +5 -0
- data/examples/v2/agentless-scanning/ListAwsOnDemandTasks.rb +5 -0
- data/examples/v2/agentless-scanning/UpdateAwsScanOptions.rb +17 -0
- data/examples/v2/app-builder/CreateApp.rb +121 -13
- data/examples/v2/app-builder/DeleteApp.rb +0 -3
- data/examples/v2/app-builder/DeleteApps.rb +0 -3
- data/examples/v2/app-builder/GetApp.rb +0 -3
- data/examples/v2/app-builder/ListApps.rb +0 -3
- data/examples/v2/app-builder/PublishApp.rb +0 -3
- data/examples/v2/app-builder/UnpublishApp.rb +0 -3
- data/examples/v2/app-builder/UpdateApp.rb +0 -3
- data/examples/v2/application-security/CreateApplicationSecurityWafCustomRule.rb +55 -0
- data/examples/v2/application-security/CreateApplicationSecurityWafExclusionFilter.rb +33 -0
- data/examples/v2/application-security/DeleteApplicationSecurityWafCustomRule.rb +5 -0
- data/examples/v2/application-security/DeleteApplicationSecurityWafExclusionFilter.rb +8 -0
- data/examples/v2/application-security/GetApplicationSecurityWafCustomRule.rb +5 -0
- data/examples/v2/application-security/GetApplicationSecurityWafExclusionFilter.rb +8 -0
- data/examples/v2/application-security/ListApplicationSecurityWAFCustomRules.rb +5 -0
- data/examples/v2/application-security/ListApplicationSecurityWafExclusionFilters.rb +5 -0
- data/examples/v2/application-security/UpdateApplicationSecurityWafCustomRule.rb +46 -0
- data/examples/v2/application-security/UpdateApplicationSecurityWafExclusionFilter.rb +22 -0
- data/examples/v2/rum-retention-filters/CreateRetentionFilter.rb +18 -0
- data/examples/v2/rum-retention-filters/DeleteRetentionFilter.rb +5 -0
- data/examples/v2/rum-retention-filters/GetRetentionFilter.rb +5 -0
- data/examples/v2/rum-retention-filters/ListRetentionFilters.rb +5 -0
- data/examples/v2/rum-retention-filters/OrderRetentionFilters.rb +22 -0
- data/examples/v2/rum-retention-filters/UpdateRetentionFilter.rb +19 -0
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1965169892.rb +50 -0
- data/examples/v2/security-monitoring/CreateSignalNotificationRule.rb +1 -1
- data/examples/v2/security-monitoring/CreateVulnerabilityNotificationRule.rb +1 -1
- data/examples/v2/security-monitoring/DeleteSignalNotificationRule.rb +1 -1
- data/examples/v2/security-monitoring/DeleteVulnerabilityNotificationRule.rb +1 -1
- data/examples/v2/security-monitoring/GetRuleVersionHistory.rb +8 -0
- data/examples/v2/security-monitoring/GetRuleVersionHistory_2467565841.rb +11 -0
- data/examples/v2/security-monitoring/GetSBOM.rb +3 -0
- data/examples/v2/security-monitoring/GetSignalNotificationRule.rb +1 -1
- data/examples/v2/security-monitoring/GetSignalNotificationRules.rb +1 -1
- data/examples/v2/security-monitoring/GetVulnerabilityNotificationRule.rb +1 -1
- data/examples/v2/security-monitoring/GetVulnerabilityNotificationRules.rb +1 -1
- data/examples/v2/security-monitoring/ListVulnerabilities.rb +3 -0
- data/examples/v2/security-monitoring/ListVulnerableAssets.rb +3 -0
- data/examples/v2/security-monitoring/PatchSignalNotificationRule.rb +1 -1
- data/examples/v2/security-monitoring/PatchVulnerabilityNotificationRule.rb +1 -1
- data/examples/v2/software-catalog/UpsertCatalogEntity.rb +5 -1
- data/examples/v2/workflow-automation/CreateWorkflow.rb +95 -0
- data/examples/v2/workflow-automation/DeleteWorkflow.rb +8 -0
- data/examples/v2/workflow-automation/GetWorkflow.rb +8 -0
- data/examples/v2/workflow-automation/UpdateWorkflow.rb +99 -0
- data/lib/datadog_api_client/configuration.rb +4 -8
- data/lib/datadog_api_client/inflector.rb +186 -1
- data/lib/datadog_api_client/v1/api/logs_indexes_api.rb +66 -0
- data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -1
- data/lib/datadog_api_client/v1/models/check_can_delete_monitor_response_data.rb +1 -1
- data/lib/datadog_api_client/v1/models/check_can_delete_slo_response_data.rb +1 -1
- data/lib/datadog_api_client/v1/models/dashboard_share_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/logs_processor.rb +2 -1
- data/lib/datadog_api_client/v1/models/logs_span_remapper.rb +160 -0
- data/lib/datadog_api_client/v1/models/logs_span_remapper_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/monitor_options_scheduling_options_evaluation_window.rb +14 -4
- data/lib/datadog_api_client/v1/models/monitor_search_result.rb +13 -1
- data/lib/datadog_api_client/v1/models/number_format_unit.rb +63 -0
- data/lib/datadog_api_client/v1/models/number_format_unit_canonical.rb +125 -0
- data/lib/datadog_api_client/v1/models/number_format_unit_custom.rb +137 -0
- data/lib/datadog_api_client/v1/models/number_format_unit_custom_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/number_format_unit_scale.rb +115 -0
- data/lib/datadog_api_client/v1/models/number_format_unit_scale_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/shared_dashboard.rb +85 -9
- data/lib/datadog_api_client/v1/models/shared_dashboard_invitees_items.rb +151 -0
- data/lib/datadog_api_client/v1/models/shared_dashboard_status.rb +27 -0
- data/lib/datadog_api_client/v1/models/shared_dashboard_update_request.rb +68 -3
- data/lib/datadog_api_client/v1/models/slo_correction_list_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_api_test_step.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_browser_variable_type.rb +0 -1
- data/lib/datadog_api_client/v1/models/synthetics_ci_test_body.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_user_locator.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_trigger_body.rb +1 -1
- data/lib/datadog_api_client/v1/models/table_widget_cell_display_mode.rb +1 -0
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +3 -3
- data/lib/datadog_api_client/v1/models/viewing_preferences.rb +115 -0
- data/lib/datadog_api_client/v1/models/viewing_preferences_theme.rb +28 -0
- data/lib/datadog_api_client/v1/models/widget_formula.rb +21 -1
- data/lib/datadog_api_client/v1/models/widget_formula_cell_display_mode_options.rb +115 -0
- data/lib/datadog_api_client/v1/models/widget_formula_cell_display_mode_options_trend_type.rb +28 -0
- data/lib/datadog_api_client/v1/models/widget_formula_cell_display_mode_options_y_scale.rb +27 -0
- data/lib/datadog_api_client/v1/models/widget_number_format.rb +123 -0
- data/lib/datadog_api_client/v2/api/agentless_scanning_api.rb +398 -2
- data/lib/datadog_api_client/v2/api/api_management_api.rb +15 -0
- data/lib/datadog_api_client/v2/api/app_builder_api.rb +0 -48
- data/lib/datadog_api_client/v2/api/application_security_api.rb +689 -0
- data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/confluent_cloud_api.rb +8 -8
- data/lib/datadog_api_client/v2/api/metrics_api.rb +3 -1
- data/lib/datadog_api_client/v2/api/rum_retention_filters_api.rb +455 -0
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +116 -23
- data/lib/datadog_api_client/v2/api/software_catalog_api.rb +1 -2
- data/lib/datadog_api_client/v2/api/workflow_automation_api.rb +269 -0
- data/lib/datadog_api_client/v2/models/account_filtering_config.rb +129 -0
- data/lib/datadog_api_client/v2/models/action_query.rb +198 -0
- data/lib/datadog_api_client/v2/models/action_query_condition.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_debounce_in_ms.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_mocked_outputs.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_mocked_outputs_enabled.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_mocked_outputs_object.rb +133 -0
- data/lib/datadog_api_client/v2/models/action_query_only_trigger_manually.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_polling_interval_in_ms.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_properties.rb +203 -0
- data/lib/datadog_api_client/v2/models/action_query_requires_confirmation.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_show_toast_on_error.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_spec.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_spec_connection_group.rb +117 -0
- data/lib/datadog_api_client/v2/models/action_query_spec_inputs.rb +63 -0
- data/lib/datadog_api_client/v2/models/action_query_spec_object.rb +153 -0
- data/lib/datadog_api_client/v2/models/action_query_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/annotation.rb +165 -0
- data/lib/datadog_api_client/v2/models/annotation_display.rb +105 -0
- data/lib/datadog_api_client/v2/models/annotation_display_bounds.rb +135 -0
- data/lib/datadog_api_client/v2/models/annotation_markdown_text_annotation.rb +105 -0
- data/lib/datadog_api_client/v2/models/api_trigger.rb +105 -0
- data/lib/datadog_api_client/v2/models/api_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/app_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_action.rb +115 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_action_action.rb +27 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_action_parameters.rb +115 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_attributes.rb +253 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_condition.rb +144 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_condition_input.rb +135 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_condition_input_address.rb +46 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_condition_operator.rb +36 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_condition_options.rb +115 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_condition_parameters.rb +178 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_create_attributes.rb +243 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_create_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_list_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_metadata.rb +155 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_scope.rb +144 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_tags.rb +145 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_tags_category.rb +28 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_update_attributes.rb +243 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_update_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_attributes.rb +213 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_create_attributes.rb +212 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_create_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_metadata.rb +155 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_on_match.rb +26 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_resource.rb +125 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_rules_target.rb +115 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_rules_target_tags.rb +115 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_scope.rb +115 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_update_attributes.rb +212 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_update_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filter_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/application_security_waf_exclusion_filters_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_request_attributes.rb +12 -20
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/aws_on_demand_attributes.rb +138 -0
- data/lib/datadog_api_client/v2/models/aws_on_demand_create_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/aws_on_demand_create_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/aws_on_demand_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/aws_on_demand_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/aws_on_demand_list_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/aws_on_demand_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/aws_on_demand_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_scan_options_create_attributes.rb +186 -0
- data/lib/datadog_api_client/v2/models/aws_scan_options_create_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/aws_scan_options_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/aws_scan_options_list_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/aws_scan_options_response.rb +4 -6
- data/lib/datadog_api_client/v2/models/aws_scan_options_update_attributes.rb +135 -0
- data/lib/datadog_api_client/v2/models/aws_scan_options_update_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/aws_scan_options_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/case_trigger.rb +105 -0
- data/lib/datadog_api_client/v2/models/case_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/change_event_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/completion_condition.rb +154 -0
- data/lib/datadog_api_client/v2/models/completion_condition_operator.rb +37 -0
- data/lib/datadog_api_client/v2/models/completion_gate.rb +144 -0
- data/lib/datadog_api_client/v2/models/connection.rb +144 -0
- data/lib/datadog_api_client/v2/models/connection_env.rb +147 -0
- data/lib/datadog_api_client/v2/models/connection_env_env.rb +26 -0
- data/lib/datadog_api_client/v2/models/connection_group.rb +167 -0
- data/lib/datadog_api_client/v2/models/create_workflow_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/create_workflow_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/dashboard_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/data_transform.rb +186 -0
- data/lib/datadog_api_client/v2/models/data_transform_properties.rb +105 -0
- data/lib/datadog_api_client/v2/models/{query_type.rb → data_transform_type.rb} +2 -4
- data/lib/datadog_api_client/v2/models/error_handler.rb +144 -0
- data/lib/datadog_api_client/v2/models/fastly_service.rb +1 -1
- data/lib/datadog_api_client/v2/models/get_rule_version_history_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/get_rule_version_history_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/get_rule_version_history_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/get_workflow_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/github_webhook_trigger.rb +105 -0
- data/lib/datadog_api_client/v2/models/github_webhook_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/incident_trigger.rb +105 -0
- data/lib/datadog_api_client/v2/models/incident_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/input_schema.rb +107 -0
- data/lib/datadog_api_client/v2/models/input_schema_parameters.rb +174 -0
- data/lib/datadog_api_client/v2/models/input_schema_parameters_type.rb +33 -0
- data/lib/datadog_api_client/v2/models/job_definition.rb +13 -1
- data/lib/datadog_api_client/v2/models/logs_archive_destination_s3.rb +11 -1
- data/lib/datadog_api_client/v2/models/logs_archive_storage_class_s3_type.rb +30 -0
- data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_create_attributes.rb +50 -1
- data/lib/datadog_api_client/v2/models/monitor_trigger.rb +105 -0
- data/lib/datadog_api_client/v2/models/monitor_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/outbound_edge.rb +144 -0
- data/lib/datadog_api_client/v2/models/output_schema.rb +107 -0
- data/lib/datadog_api_client/v2/models/output_schema_parameters.rb +184 -0
- data/lib/datadog_api_client/v2/models/output_schema_parameters_type.rb +33 -0
- data/lib/datadog_api_client/v2/models/parameter.rb +144 -0
- data/lib/datadog_api_client/v2/models/query.rb +37 -160
- data/lib/datadog_api_client/v2/models/readiness_gate.rb +123 -0
- data/lib/datadog_api_client/v2/models/readiness_gate_threshold_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/retry_strategy.rb +133 -0
- data/lib/datadog_api_client/v2/models/retry_strategy_kind.rb +26 -0
- data/lib/datadog_api_client/v2/models/retry_strategy_linear.rb +144 -0
- data/lib/datadog_api_client/v2/models/rule_types_items.rb +1 -1
- data/lib/datadog_api_client/v2/models/rule_version_history.rb +133 -0
- data/lib/datadog_api_client/v2/models/rule_version_update.rb +125 -0
- data/lib/datadog_api_client/v2/models/rule_version_update_type.rb +28 -0
- data/lib/datadog_api_client/v2/models/rule_versions.rb +117 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_attributes.rb +167 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_create_attributes.rb +193 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_create_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_event_type.rb +32 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_update_attributes.rb +167 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_update_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filter_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filters_order_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filters_order_request.rb +108 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filters_order_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/rum_retention_filters_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/schedule_trigger.rb +123 -0
- data/lib/datadog_api_client/v2/models/schedule_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_case.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_case_action.rb +115 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_case_action_options.rb +123 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_case_action_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_case_create.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_evaluation_window.rb +4 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_keep_alive.rb +2 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_test_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_trigger.rb +105 -0
- data/lib/datadog_api_client/v2/models/security_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/selectors.rb +1 -1
- data/lib/datadog_api_client/v2/models/slack_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/spec.rb +173 -0
- data/lib/datadog_api_client/v2/models/state_variable.rb +186 -0
- data/lib/datadog_api_client/v2/models/state_variable_properties.rb +105 -0
- data/lib/datadog_api_client/v2/models/state_variable_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/step.rb +220 -0
- data/lib/datadog_api_client/v2/models/step_display.rb +105 -0
- data/lib/datadog_api_client/v2/models/step_display_bounds.rb +115 -0
- data/lib/datadog_api_client/v2/models/trigger.rb +73 -0
- data/lib/datadog_api_client/v2/models/trigger_rate_limit.rb +115 -0
- data/lib/datadog_api_client/v2/models/update_workflow_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/update_workflow_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/workflow_data.rb +164 -0
- data/lib/datadog_api_client/v2/models/workflow_data_attributes.rb +206 -0
- data/lib/datadog_api_client/v2/models/workflow_data_relationships.rb +115 -0
- data/lib/datadog_api_client/v2/models/workflow_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/workflow_data_update.rb +164 -0
- data/lib/datadog_api_client/v2/models/workflow_data_update_attributes.rb +177 -0
- data/lib/datadog_api_client/v2/models/workflow_trigger_wrapper.rb +135 -0
- data/lib/datadog_api_client/v2/models/workflow_user_relationship.rb +105 -0
- data/lib/datadog_api_client/v2/models/workflow_user_relationship_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/workflow_user_relationship_type.rb +26 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +221 -3
@@ -148,6 +148,22 @@ components:
|
|
148
148
|
required: false
|
149
149
|
schema:
|
150
150
|
$ref: '#/components/schemas/ApplicationKeysSort'
|
151
|
+
ApplicationSecurityWafCustomRuleIDParam:
|
152
|
+
description: The ID of the custom rule.
|
153
|
+
example: 3b5-v82-ns6
|
154
|
+
in: path
|
155
|
+
name: custom_rule_id
|
156
|
+
required: true
|
157
|
+
schema:
|
158
|
+
type: string
|
159
|
+
ApplicationSecurityWafExclusionFilterID:
|
160
|
+
description: The identifier of the WAF exclusion filter.
|
161
|
+
example: 3b5-v82-ns6
|
162
|
+
in: path
|
163
|
+
name: exclusion_filter_id
|
164
|
+
required: true
|
165
|
+
schema:
|
166
|
+
type: string
|
151
167
|
ArchiveID:
|
152
168
|
description: The ID of the archive.
|
153
169
|
in: path
|
@@ -162,6 +178,14 @@ components:
|
|
162
178
|
required: true
|
163
179
|
schema:
|
164
180
|
type: string
|
181
|
+
AwsAccountId:
|
182
|
+
description: The ID of an AWS account.
|
183
|
+
example: '123456789012'
|
184
|
+
in: path
|
185
|
+
name: account_id
|
186
|
+
required: true
|
187
|
+
schema:
|
188
|
+
type: string
|
165
189
|
CaseIDPathParameter:
|
166
190
|
description: Case's UUID or key
|
167
191
|
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
|
@@ -193,7 +217,7 @@ components:
|
|
193
217
|
schema:
|
194
218
|
type: string
|
195
219
|
ConfluentAccountID:
|
196
|
-
description: Confluent Account
|
220
|
+
description: Confluent Account ID.
|
197
221
|
in: path
|
198
222
|
name: account_id
|
199
223
|
required: true
|
@@ -546,6 +570,14 @@ components:
|
|
546
570
|
required: false
|
547
571
|
schema:
|
548
572
|
type: string
|
573
|
+
OnDemandTaskId:
|
574
|
+
description: The UUID of the task.
|
575
|
+
example: 6d09294c-9ad9-42fd-a759-a0c1599b4828
|
576
|
+
in: path
|
577
|
+
name: task_id
|
578
|
+
required: true
|
579
|
+
schema:
|
580
|
+
type: string
|
549
581
|
OpsgenieServiceIDPathParameter:
|
550
582
|
description: The UUID of the service.
|
551
583
|
in: path
|
@@ -651,6 +683,13 @@ components:
|
|
651
683
|
required: true
|
652
684
|
schema:
|
653
685
|
type: string
|
686
|
+
RumApplicationIDParameter:
|
687
|
+
description: RUM application ID.
|
688
|
+
in: path
|
689
|
+
name: app_id
|
690
|
+
required: true
|
691
|
+
schema:
|
692
|
+
type: string
|
654
693
|
RumMetricIDParameter:
|
655
694
|
description: The name of the rum-based metric.
|
656
695
|
in: path
|
@@ -658,6 +697,13 @@ components:
|
|
658
697
|
required: true
|
659
698
|
schema:
|
660
699
|
type: string
|
700
|
+
RumRetentionFilterIDParameter:
|
701
|
+
description: Retention filter ID.
|
702
|
+
in: path
|
703
|
+
name: rf_id
|
704
|
+
required: true
|
705
|
+
schema:
|
706
|
+
type: string
|
661
707
|
SchemaVersion:
|
662
708
|
description: The schema version desired in the response.
|
663
709
|
in: query
|
@@ -1048,6 +1094,22 @@ components:
|
|
1048
1094
|
type: string
|
1049
1095
|
x-enum-varnames:
|
1050
1096
|
- API_KEYS
|
1097
|
+
APITrigger:
|
1098
|
+
description: Trigger a workflow VIA an API. The workflow must be published.
|
1099
|
+
properties:
|
1100
|
+
rateLimit:
|
1101
|
+
$ref: '#/components/schemas/TriggerRateLimit'
|
1102
|
+
type: object
|
1103
|
+
APITriggerWrapper:
|
1104
|
+
description: Schema for an API-based trigger.
|
1105
|
+
properties:
|
1106
|
+
apiTrigger:
|
1107
|
+
$ref: '#/components/schemas/APITrigger'
|
1108
|
+
startStepNames:
|
1109
|
+
$ref: '#/components/schemas/StartStepNames'
|
1110
|
+
required:
|
1111
|
+
- apiTrigger
|
1112
|
+
type: object
|
1051
1113
|
AWSAccountConfigID:
|
1052
1114
|
description: 'Unique Datadog ID of the AWS Account Integration Config.
|
1053
1115
|
|
@@ -1514,6 +1576,7 @@ components:
|
|
1514
1576
|
type: array
|
1515
1577
|
required:
|
1516
1578
|
- exclude_only
|
1579
|
+
type: object
|
1517
1580
|
AWSNamespaceFiltersIncludeOnly:
|
1518
1581
|
description: Include only these namespaces.
|
1519
1582
|
properties:
|
@@ -1527,6 +1590,7 @@ components:
|
|
1527
1590
|
type: array
|
1528
1591
|
required:
|
1529
1592
|
- include_only
|
1593
|
+
type: object
|
1530
1594
|
AWSNamespaceTagFilter:
|
1531
1595
|
description: 'AWS Metrics Collection tag filters list. Defaults to `[]`.
|
1532
1596
|
|
@@ -1660,6 +1724,7 @@ components:
|
|
1660
1724
|
type: boolean
|
1661
1725
|
required:
|
1662
1726
|
- include_all
|
1727
|
+
type: object
|
1663
1728
|
AWSRegionsIncludeOnly:
|
1664
1729
|
description: Include only these regions.
|
1665
1730
|
properties:
|
@@ -1673,6 +1738,7 @@ components:
|
|
1673
1738
|
type: array
|
1674
1739
|
required:
|
1675
1740
|
- include_only
|
1741
|
+
type: object
|
1676
1742
|
AWSResourcesConfig:
|
1677
1743
|
description: AWS Resources Collection config.
|
1678
1744
|
properties:
|
@@ -1695,6 +1761,33 @@ components:
|
|
1695
1761
|
xray_services:
|
1696
1762
|
$ref: '#/components/schemas/XRayServicesList'
|
1697
1763
|
type: object
|
1764
|
+
AccountFilteringConfig:
|
1765
|
+
description: The account filtering configuration.
|
1766
|
+
properties:
|
1767
|
+
excluded_accounts:
|
1768
|
+
description: The AWS account IDs to be excluded from your billing dataset.
|
1769
|
+
This field is used when `include_new_accounts` is `true`.
|
1770
|
+
example:
|
1771
|
+
- '123456789123'
|
1772
|
+
- '123456789143'
|
1773
|
+
items:
|
1774
|
+
type: string
|
1775
|
+
type: array
|
1776
|
+
include_new_accounts:
|
1777
|
+
description: Whether or not to automatically include new member accounts
|
1778
|
+
by default in your billing dataset.
|
1779
|
+
example: true
|
1780
|
+
type: boolean
|
1781
|
+
included_accounts:
|
1782
|
+
description: The AWS account IDs to be included in your billing dataset.
|
1783
|
+
This field is used when `include_new_accounts` is `false`.
|
1784
|
+
example:
|
1785
|
+
- '123456789123'
|
1786
|
+
- '123456789143'
|
1787
|
+
items:
|
1788
|
+
type: string
|
1789
|
+
type: array
|
1790
|
+
type: object
|
1698
1791
|
ActionConnectionAttributes:
|
1699
1792
|
description: The definition of `ActionConnectionAttributes` object.
|
1700
1793
|
properties:
|
@@ -1762,6 +1855,207 @@ components:
|
|
1762
1855
|
oneOf:
|
1763
1856
|
- $ref: '#/components/schemas/AWSIntegrationUpdate'
|
1764
1857
|
- $ref: '#/components/schemas/HTTPIntegrationUpdate'
|
1858
|
+
ActionQuery:
|
1859
|
+
description: An action query. This query type is used to trigger an action,
|
1860
|
+
such as sending a HTTP request.
|
1861
|
+
properties:
|
1862
|
+
events:
|
1863
|
+
description: Events to listen for downstream of the action query.
|
1864
|
+
items:
|
1865
|
+
$ref: '#/components/schemas/AppBuilderEvent'
|
1866
|
+
type: array
|
1867
|
+
id:
|
1868
|
+
description: The ID of the action query.
|
1869
|
+
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
|
1870
|
+
format: uuid
|
1871
|
+
type: string
|
1872
|
+
name:
|
1873
|
+
description: A unique identifier for this action query. This name is also
|
1874
|
+
used to access the query's result throughout the app.
|
1875
|
+
example: fetchPendingOrders
|
1876
|
+
type: string
|
1877
|
+
properties:
|
1878
|
+
$ref: '#/components/schemas/ActionQueryProperties'
|
1879
|
+
type:
|
1880
|
+
$ref: '#/components/schemas/ActionQueryType'
|
1881
|
+
required:
|
1882
|
+
- id
|
1883
|
+
- name
|
1884
|
+
- type
|
1885
|
+
- properties
|
1886
|
+
type: object
|
1887
|
+
ActionQueryCondition:
|
1888
|
+
description: Whether to run this query. If specified, the query will only run
|
1889
|
+
if this condition evaluates to `true` in JavaScript and all other conditions
|
1890
|
+
are also met.
|
1891
|
+
oneOf:
|
1892
|
+
- type: boolean
|
1893
|
+
- example: ${true}
|
1894
|
+
type: string
|
1895
|
+
ActionQueryDebounceInMs:
|
1896
|
+
description: The minimum time in milliseconds that must pass before the query
|
1897
|
+
can be triggered again. This is useful for preventing accidental double-clicks
|
1898
|
+
from triggering the query multiple times.
|
1899
|
+
oneOf:
|
1900
|
+
- example: 310.5
|
1901
|
+
format: double
|
1902
|
+
type: number
|
1903
|
+
- description: If this is a string, it must be a valid JavaScript expression
|
1904
|
+
that evaluates to a number.
|
1905
|
+
example: ${1000}
|
1906
|
+
type: string
|
1907
|
+
ActionQueryMockedOutputs:
|
1908
|
+
description: The mocked outputs of the action query. This is useful for testing
|
1909
|
+
the app without actually running the action.
|
1910
|
+
oneOf:
|
1911
|
+
- type: string
|
1912
|
+
- $ref: '#/components/schemas/ActionQueryMockedOutputsObject'
|
1913
|
+
ActionQueryMockedOutputsEnabled:
|
1914
|
+
description: Whether to enable the mocked outputs for testing.
|
1915
|
+
oneOf:
|
1916
|
+
- type: boolean
|
1917
|
+
- description: If this is a string, it must be a valid JavaScript expression
|
1918
|
+
that evaluates to a boolean.
|
1919
|
+
example: ${true}
|
1920
|
+
type: string
|
1921
|
+
ActionQueryMockedOutputsObject:
|
1922
|
+
description: The mocked outputs of the action query.
|
1923
|
+
properties:
|
1924
|
+
enabled:
|
1925
|
+
$ref: '#/components/schemas/ActionQueryMockedOutputsEnabled'
|
1926
|
+
outputs:
|
1927
|
+
description: The mocked outputs of the action query, serialized as JSON.
|
1928
|
+
example: '{"status": "success"}'
|
1929
|
+
type: string
|
1930
|
+
required:
|
1931
|
+
- enabled
|
1932
|
+
type: object
|
1933
|
+
ActionQueryOnlyTriggerManually:
|
1934
|
+
description: Determines when this query is executed. If set to `false`, the
|
1935
|
+
query will run when the app loads and whenever any query arguments change.
|
1936
|
+
If set to `true`, the query will only run when manually triggered from elsewhere
|
1937
|
+
in the app.
|
1938
|
+
oneOf:
|
1939
|
+
- type: boolean
|
1940
|
+
- description: If this is a string, it must be a valid JavaScript expression
|
1941
|
+
that evaluates to a boolean.
|
1942
|
+
example: ${true}
|
1943
|
+
type: string
|
1944
|
+
ActionQueryPollingIntervalInMs:
|
1945
|
+
description: If specified, the app will poll the query at the specified interval
|
1946
|
+
in milliseconds. The minimum polling interval is 15 seconds. The query will
|
1947
|
+
only poll when the app's browser tab is active.
|
1948
|
+
oneOf:
|
1949
|
+
- example: 30000.0
|
1950
|
+
format: double
|
1951
|
+
minimum: 15000.0
|
1952
|
+
type: number
|
1953
|
+
- description: If this is a string, it must be a valid JavaScript expression
|
1954
|
+
that evaluates to a number.
|
1955
|
+
example: ${15000}
|
1956
|
+
type: string
|
1957
|
+
ActionQueryProperties:
|
1958
|
+
description: The properties of the action query.
|
1959
|
+
properties:
|
1960
|
+
condition:
|
1961
|
+
$ref: '#/components/schemas/ActionQueryCondition'
|
1962
|
+
debounceInMs:
|
1963
|
+
$ref: '#/components/schemas/ActionQueryDebounceInMs'
|
1964
|
+
mockedOutputs:
|
1965
|
+
$ref: '#/components/schemas/ActionQueryMockedOutputs'
|
1966
|
+
onlyTriggerManually:
|
1967
|
+
$ref: '#/components/schemas/ActionQueryOnlyTriggerManually'
|
1968
|
+
outputs:
|
1969
|
+
description: The post-query transformation function, which is a JavaScript
|
1970
|
+
function that changes the query's `.outputs` property after the query's
|
1971
|
+
execution.
|
1972
|
+
example: ${((outputs) => {return outputs.body.data})(self.rawOutputs)}
|
1973
|
+
type: string
|
1974
|
+
pollingIntervalInMs:
|
1975
|
+
$ref: '#/components/schemas/ActionQueryPollingIntervalInMs'
|
1976
|
+
requiresConfirmation:
|
1977
|
+
$ref: '#/components/schemas/ActionQueryRequiresConfirmation'
|
1978
|
+
showToastOnError:
|
1979
|
+
$ref: '#/components/schemas/ActionQueryShowToastOnError'
|
1980
|
+
spec:
|
1981
|
+
$ref: '#/components/schemas/ActionQuerySpec'
|
1982
|
+
required:
|
1983
|
+
- spec
|
1984
|
+
type: object
|
1985
|
+
ActionQueryRequiresConfirmation:
|
1986
|
+
description: Whether to prompt the user to confirm this query before it runs.
|
1987
|
+
oneOf:
|
1988
|
+
- type: boolean
|
1989
|
+
- description: If this is a string, it must be a valid JavaScript expression
|
1990
|
+
that evaluates to a boolean.
|
1991
|
+
example: ${true}
|
1992
|
+
type: string
|
1993
|
+
ActionQueryShowToastOnError:
|
1994
|
+
description: Whether to display a toast to the user when the query returns an
|
1995
|
+
error.
|
1996
|
+
oneOf:
|
1997
|
+
- type: boolean
|
1998
|
+
- description: If this is a string, it must be a valid JavaScript expression
|
1999
|
+
that evaluates to a boolean.
|
2000
|
+
example: ${true}
|
2001
|
+
type: string
|
2002
|
+
ActionQuerySpec:
|
2003
|
+
description: The definition of the action query.
|
2004
|
+
oneOf:
|
2005
|
+
- type: string
|
2006
|
+
- $ref: '#/components/schemas/ActionQuerySpecObject'
|
2007
|
+
ActionQuerySpecConnectionGroup:
|
2008
|
+
description: The connection group to use for an action query.
|
2009
|
+
properties:
|
2010
|
+
id:
|
2011
|
+
description: The ID of the connection group.
|
2012
|
+
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
|
2013
|
+
format: uuid
|
2014
|
+
type: string
|
2015
|
+
tags:
|
2016
|
+
description: The tags of the connection group.
|
2017
|
+
items:
|
2018
|
+
type: string
|
2019
|
+
type: array
|
2020
|
+
type: object
|
2021
|
+
ActionQuerySpecInput:
|
2022
|
+
additionalProperties: {}
|
2023
|
+
description: The inputs to the action query. See the [Actions Catalog](https://docs.datadoghq.com/actions/actions_catalog/)
|
2024
|
+
for more detail on each action and its inputs.
|
2025
|
+
type: object
|
2026
|
+
ActionQuerySpecInputs:
|
2027
|
+
description: The inputs to the action query. These are the values that are passed
|
2028
|
+
to the action when it is triggered.
|
2029
|
+
oneOf:
|
2030
|
+
- type: string
|
2031
|
+
- $ref: '#/components/schemas/ActionQuerySpecInput'
|
2032
|
+
ActionQuerySpecObject:
|
2033
|
+
description: The action query spec object.
|
2034
|
+
properties:
|
2035
|
+
connectionGroup:
|
2036
|
+
$ref: '#/components/schemas/ActionQuerySpecConnectionGroup'
|
2037
|
+
connectionId:
|
2038
|
+
description: The ID of the custom connection to use for this action query.
|
2039
|
+
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
|
2040
|
+
type: string
|
2041
|
+
fqn:
|
2042
|
+
description: The fully qualified name of the action type.
|
2043
|
+
example: com.datadoghq.http.request
|
2044
|
+
type: string
|
2045
|
+
inputs:
|
2046
|
+
$ref: '#/components/schemas/ActionQuerySpecInputs'
|
2047
|
+
required:
|
2048
|
+
- fqn
|
2049
|
+
type: object
|
2050
|
+
ActionQueryType:
|
2051
|
+
default: action
|
2052
|
+
description: The action query type.
|
2053
|
+
enum:
|
2054
|
+
- action
|
2055
|
+
example: action
|
2056
|
+
type: string
|
2057
|
+
x-enum-varnames:
|
2058
|
+
- ACTION
|
1765
2059
|
ActiveBillingDimensionsAttributes:
|
1766
2060
|
description: List of active billing dimensions.
|
1767
2061
|
properties:
|
@@ -1822,6 +2116,56 @@ components:
|
|
1822
2116
|
- id
|
1823
2117
|
- base_severity
|
1824
2118
|
type: object
|
2119
|
+
Annotation:
|
2120
|
+
description: A list of annotations used in the workflow. These are like sticky
|
2121
|
+
notes for your workflow!
|
2122
|
+
properties:
|
2123
|
+
display:
|
2124
|
+
$ref: '#/components/schemas/AnnotationDisplay'
|
2125
|
+
id:
|
2126
|
+
description: The `Annotation` `id`.
|
2127
|
+
example: ''
|
2128
|
+
type: string
|
2129
|
+
markdownTextAnnotation:
|
2130
|
+
$ref: '#/components/schemas/AnnotationMarkdownTextAnnotation'
|
2131
|
+
required:
|
2132
|
+
- id
|
2133
|
+
- display
|
2134
|
+
- markdownTextAnnotation
|
2135
|
+
type: object
|
2136
|
+
AnnotationDisplay:
|
2137
|
+
description: The definition of `AnnotationDisplay` object.
|
2138
|
+
properties:
|
2139
|
+
bounds:
|
2140
|
+
$ref: '#/components/schemas/AnnotationDisplayBounds'
|
2141
|
+
type: object
|
2142
|
+
AnnotationDisplayBounds:
|
2143
|
+
description: The definition of `AnnotationDisplayBounds` object.
|
2144
|
+
properties:
|
2145
|
+
height:
|
2146
|
+
description: The `bounds` `height`.
|
2147
|
+
format: double
|
2148
|
+
type: number
|
2149
|
+
width:
|
2150
|
+
description: The `bounds` `width`.
|
2151
|
+
format: double
|
2152
|
+
type: number
|
2153
|
+
x:
|
2154
|
+
description: The `bounds` `x`.
|
2155
|
+
format: double
|
2156
|
+
type: number
|
2157
|
+
y:
|
2158
|
+
description: The `bounds` `y`.
|
2159
|
+
format: double
|
2160
|
+
type: number
|
2161
|
+
type: object
|
2162
|
+
AnnotationMarkdownTextAnnotation:
|
2163
|
+
description: The definition of `AnnotationMarkdownTextAnnotation` object.
|
2164
|
+
properties:
|
2165
|
+
text:
|
2166
|
+
description: The `markdownTextAnnotation` `text`.
|
2167
|
+
type: string
|
2168
|
+
type: object
|
1825
2169
|
ApiID:
|
1826
2170
|
description: API identifier.
|
1827
2171
|
example: 90646597-5fdb-4a17-a240-647003f8c028
|
@@ -1965,6 +2309,17 @@ components:
|
|
1965
2309
|
deployment:
|
1966
2310
|
$ref: '#/components/schemas/DeploymentRelationship'
|
1967
2311
|
type: object
|
2312
|
+
AppTriggerWrapper:
|
2313
|
+
description: Schema for an App-based trigger.
|
2314
|
+
properties:
|
2315
|
+
appTrigger:
|
2316
|
+
description: Trigger a workflow VIA an App.
|
2317
|
+
type: object
|
2318
|
+
startStepNames:
|
2319
|
+
$ref: '#/components/schemas/StartStepNames'
|
2320
|
+
required:
|
2321
|
+
- appTrigger
|
2322
|
+
type: object
|
1968
2323
|
ApplicationKeyCreateAttributes:
|
1969
2324
|
description: Attributes used to create an application Key.
|
1970
2325
|
properties:
|
@@ -2116,6 +2471,770 @@ components:
|
|
2116
2471
|
type: string
|
2117
2472
|
x-enum-varnames:
|
2118
2473
|
- APPLICATION_KEYS
|
2474
|
+
ApplicationSecurityWafCustomRuleAction:
|
2475
|
+
description: The definition of `ApplicationSecurityWafCustomRuleAction` object.
|
2476
|
+
properties:
|
2477
|
+
action:
|
2478
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionAction'
|
2479
|
+
parameters:
|
2480
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionParameters'
|
2481
|
+
type: object
|
2482
|
+
ApplicationSecurityWafCustomRuleActionAction:
|
2483
|
+
default: block_request
|
2484
|
+
description: Override the default action to take when the WAF custom rule would
|
2485
|
+
block.
|
2486
|
+
enum:
|
2487
|
+
- redirect_request
|
2488
|
+
- block_request
|
2489
|
+
example: block_request
|
2490
|
+
type: string
|
2491
|
+
x-enum-varnames:
|
2492
|
+
- REDIRECT_REQUEST
|
2493
|
+
- BLOCK_REQUEST
|
2494
|
+
ApplicationSecurityWafCustomRuleActionParameters:
|
2495
|
+
description: The definition of `ApplicationSecurityWafCustomRuleActionParameters`
|
2496
|
+
object.
|
2497
|
+
properties:
|
2498
|
+
location:
|
2499
|
+
description: The location to redirect to when the WAF custom rule triggers.
|
2500
|
+
example: /blocking
|
2501
|
+
type: string
|
2502
|
+
status_code:
|
2503
|
+
default: 403
|
2504
|
+
description: The status code to return when the WAF custom rule triggers.
|
2505
|
+
example: 403
|
2506
|
+
format: int64
|
2507
|
+
type: integer
|
2508
|
+
type: object
|
2509
|
+
ApplicationSecurityWafCustomRuleAttributes:
|
2510
|
+
description: A WAF custom rule.
|
2511
|
+
properties:
|
2512
|
+
action:
|
2513
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction'
|
2514
|
+
blocking:
|
2515
|
+
description: Indicates whether the WAF custom rule will block the request.
|
2516
|
+
example: false
|
2517
|
+
type: boolean
|
2518
|
+
conditions:
|
2519
|
+
description: 'Conditions for which the WAF Custom Rule will triggers, all
|
2520
|
+
conditions needs to match in order for the WAF
|
2521
|
+
|
2522
|
+
rule to trigger.'
|
2523
|
+
items:
|
2524
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition'
|
2525
|
+
type: array
|
2526
|
+
enabled:
|
2527
|
+
description: Indicates whether the WAF custom rule is enabled.
|
2528
|
+
example: false
|
2529
|
+
type: boolean
|
2530
|
+
metadata:
|
2531
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleMetadata'
|
2532
|
+
name:
|
2533
|
+
description: The Name of the WAF custom rule.
|
2534
|
+
example: Block request from bad useragent
|
2535
|
+
type: string
|
2536
|
+
path_glob:
|
2537
|
+
description: The path glob for the WAF custom rule.
|
2538
|
+
example: /api/search/*
|
2539
|
+
type: string
|
2540
|
+
scope:
|
2541
|
+
description: The scope of the WAF custom rule.
|
2542
|
+
items:
|
2543
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope'
|
2544
|
+
type: array
|
2545
|
+
tags:
|
2546
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags'
|
2547
|
+
required:
|
2548
|
+
- enabled
|
2549
|
+
- blocking
|
2550
|
+
- name
|
2551
|
+
- tags
|
2552
|
+
- conditions
|
2553
|
+
type: object
|
2554
|
+
ApplicationSecurityWafCustomRuleCondition:
|
2555
|
+
description: One condition of the WAF Custom Rule.
|
2556
|
+
properties:
|
2557
|
+
operator:
|
2558
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOperator'
|
2559
|
+
parameters:
|
2560
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionParameters'
|
2561
|
+
required:
|
2562
|
+
- operator
|
2563
|
+
- parameters
|
2564
|
+
type: object
|
2565
|
+
ApplicationSecurityWafCustomRuleConditionInput:
|
2566
|
+
description: Input from the request on which the condition should apply.
|
2567
|
+
properties:
|
2568
|
+
address:
|
2569
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInputAddress'
|
2570
|
+
key_path:
|
2571
|
+
description: Specific path for the input.
|
2572
|
+
items:
|
2573
|
+
type: string
|
2574
|
+
type: array
|
2575
|
+
required:
|
2576
|
+
- address
|
2577
|
+
type: object
|
2578
|
+
ApplicationSecurityWafCustomRuleConditionInputAddress:
|
2579
|
+
description: Input from the request on which the condition should apply.
|
2580
|
+
enum:
|
2581
|
+
- server.db.statement
|
2582
|
+
- server.io.fs.file
|
2583
|
+
- server.io.net.url
|
2584
|
+
- server.sys.shell.cmd
|
2585
|
+
- server.request.method
|
2586
|
+
- server.request.uri.raw
|
2587
|
+
- server.request.path_params
|
2588
|
+
- server.request.query
|
2589
|
+
- server.request.headers.no_cookies
|
2590
|
+
- server.request.cookies
|
2591
|
+
- server.request.trailers
|
2592
|
+
- server.request.body
|
2593
|
+
- server.response.status
|
2594
|
+
- server.response.headers.no_cookies
|
2595
|
+
- server.response.trailers
|
2596
|
+
- grpc.server.request.metadata
|
2597
|
+
- grpc.server.request.message
|
2598
|
+
- grpc.server.method
|
2599
|
+
- graphql.server.all_resolvers
|
2600
|
+
- usr.id
|
2601
|
+
- http.client_ip
|
2602
|
+
example: server.db.statement
|
2603
|
+
type: string
|
2604
|
+
x-enum-varnames:
|
2605
|
+
- SERVER_DB_STATEMENT
|
2606
|
+
- SERVER_IO_FS_FILE
|
2607
|
+
- SERVER_IO_NET_URL
|
2608
|
+
- SERVER_SYS_SHELL_CMD
|
2609
|
+
- SERVER_REQUEST_METHOD
|
2610
|
+
- SERVER_REQUEST_URI_RAW
|
2611
|
+
- SERVER_REQUEST_PATH_PARAMS
|
2612
|
+
- SERVER_REQUEST_QUERY
|
2613
|
+
- SERVER_REQUEST_HEADERS_NO_COOKIES
|
2614
|
+
- SERVER_REQUEST_COOKIES
|
2615
|
+
- SERVER_REQUEST_TRAILERS
|
2616
|
+
- SERVER_REQUEST_BODY
|
2617
|
+
- SERVER_RESPONSE_STATUS
|
2618
|
+
- SERVER_RESPONSE_HEADERS_NO_COOKIES
|
2619
|
+
- SERVER_RESPONSE_TRAILERS
|
2620
|
+
- GRPC_SERVER_REQUEST_METADATA
|
2621
|
+
- GRPC_SERVER_REQUEST_MESSAGE
|
2622
|
+
- GRPC_SERVER_METHOD
|
2623
|
+
- GRAPHQL_SERVER_ALL_RESOLVERS
|
2624
|
+
- USR_ID
|
2625
|
+
- HTTP_CLIENT_IP
|
2626
|
+
ApplicationSecurityWafCustomRuleConditionOperator:
|
2627
|
+
description: Operator to use for the WAF Condition.
|
2628
|
+
enum:
|
2629
|
+
- match_regex
|
2630
|
+
- '!match_regex'
|
2631
|
+
- phrase_match
|
2632
|
+
- '!phrase_match'
|
2633
|
+
- is_xss
|
2634
|
+
- is_sqli
|
2635
|
+
- exact_match
|
2636
|
+
- '!exact_match'
|
2637
|
+
- ip_match
|
2638
|
+
- '!ip_match'
|
2639
|
+
- capture_data
|
2640
|
+
example: match_regex
|
2641
|
+
type: string
|
2642
|
+
x-enum-varnames:
|
2643
|
+
- MATCH_REGEX
|
2644
|
+
- NOT_MATCH_REGEX
|
2645
|
+
- PHRASE_MATCH
|
2646
|
+
- NOT_PHRASE_MATCH
|
2647
|
+
- IS_XSS
|
2648
|
+
- IS_SQLI
|
2649
|
+
- EXACT_MATCH
|
2650
|
+
- NOT_EXACT_MATCH
|
2651
|
+
- IP_MATCH
|
2652
|
+
- NOT_IP_MATCH
|
2653
|
+
- CAPTURE_DATA
|
2654
|
+
ApplicationSecurityWafCustomRuleConditionOptions:
|
2655
|
+
description: Options for the operator of this condition.
|
2656
|
+
properties:
|
2657
|
+
case_sensitive:
|
2658
|
+
default: false
|
2659
|
+
description: Evaluate the value as case sensitive.
|
2660
|
+
type: boolean
|
2661
|
+
min_length:
|
2662
|
+
default: 0
|
2663
|
+
description: Only evaluate this condition if the value has a minimum amount
|
2664
|
+
of characters.
|
2665
|
+
format: int64
|
2666
|
+
type: integer
|
2667
|
+
type: object
|
2668
|
+
ApplicationSecurityWafCustomRuleConditionParameters:
|
2669
|
+
description: The scope of the WAF custom rule.
|
2670
|
+
properties:
|
2671
|
+
data:
|
2672
|
+
description: Identifier of a list of data from the denylist. Can only be
|
2673
|
+
used as substitution from the list parameter.
|
2674
|
+
example: blocked_users
|
2675
|
+
type: string
|
2676
|
+
inputs:
|
2677
|
+
description: List of inputs on which at least one should match with the
|
2678
|
+
given operator.
|
2679
|
+
items:
|
2680
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInput'
|
2681
|
+
type: array
|
2682
|
+
list:
|
2683
|
+
description: 'List of value to use with the condition. Only used with the
|
2684
|
+
phrase_match, !phrase_match, exact_match and
|
2685
|
+
|
2686
|
+
!exact_match operator.'
|
2687
|
+
items:
|
2688
|
+
type: string
|
2689
|
+
type: array
|
2690
|
+
options:
|
2691
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOptions'
|
2692
|
+
regex:
|
2693
|
+
description: Regex to use with the condition. Only used with match_regex
|
2694
|
+
and !match_regex operator.
|
2695
|
+
example: path.*
|
2696
|
+
type: string
|
2697
|
+
value:
|
2698
|
+
description: Store the captured value in the specified tag name. Only used
|
2699
|
+
with the capture_data operator.
|
2700
|
+
example: custom_tag
|
2701
|
+
type: string
|
2702
|
+
required:
|
2703
|
+
- inputs
|
2704
|
+
type: object
|
2705
|
+
ApplicationSecurityWafCustomRuleCreateAttributes:
|
2706
|
+
description: Create a new WAF custom rule.
|
2707
|
+
properties:
|
2708
|
+
action:
|
2709
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction'
|
2710
|
+
blocking:
|
2711
|
+
description: Indicates whether the WAF custom rule will block the request.
|
2712
|
+
example: false
|
2713
|
+
type: boolean
|
2714
|
+
conditions:
|
2715
|
+
description: 'Conditions for which the WAF Custom Rule will triggers, all
|
2716
|
+
conditions needs to match in order for the WAF
|
2717
|
+
|
2718
|
+
rule to trigger'
|
2719
|
+
items:
|
2720
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition'
|
2721
|
+
type: array
|
2722
|
+
enabled:
|
2723
|
+
description: Indicates whether the WAF custom rule is enabled.
|
2724
|
+
example: false
|
2725
|
+
type: boolean
|
2726
|
+
name:
|
2727
|
+
description: The Name of the WAF custom rule.
|
2728
|
+
example: Block request from a bad useragent
|
2729
|
+
type: string
|
2730
|
+
path_glob:
|
2731
|
+
description: The path glob for the WAF custom rule.
|
2732
|
+
example: /api/search/*
|
2733
|
+
type: string
|
2734
|
+
scope:
|
2735
|
+
description: The scope of the WAF custom rule.
|
2736
|
+
items:
|
2737
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope'
|
2738
|
+
type: array
|
2739
|
+
tags:
|
2740
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags'
|
2741
|
+
required:
|
2742
|
+
- enabled
|
2743
|
+
- blocking
|
2744
|
+
- name
|
2745
|
+
- tags
|
2746
|
+
- conditions
|
2747
|
+
type: object
|
2748
|
+
ApplicationSecurityWafCustomRuleCreateData:
|
2749
|
+
description: Object for a single WAF custom rule.
|
2750
|
+
properties:
|
2751
|
+
attributes:
|
2752
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateAttributes'
|
2753
|
+
type:
|
2754
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType'
|
2755
|
+
required:
|
2756
|
+
- attributes
|
2757
|
+
- type
|
2758
|
+
type: object
|
2759
|
+
ApplicationSecurityWafCustomRuleCreateRequest:
|
2760
|
+
description: Request object that includes the custom rule to create.
|
2761
|
+
properties:
|
2762
|
+
data:
|
2763
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateData'
|
2764
|
+
required:
|
2765
|
+
- data
|
2766
|
+
type: object
|
2767
|
+
ApplicationSecurityWafCustomRuleData:
|
2768
|
+
description: Object for a single WAF custom rule.
|
2769
|
+
properties:
|
2770
|
+
attributes:
|
2771
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAttributes'
|
2772
|
+
id:
|
2773
|
+
description: The ID of the custom rule.
|
2774
|
+
example: 2857c47d-1e3a-4300-8b2f-dc24089c084b
|
2775
|
+
readOnly: true
|
2776
|
+
type: string
|
2777
|
+
type:
|
2778
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType'
|
2779
|
+
type: object
|
2780
|
+
ApplicationSecurityWafCustomRuleListResponse:
|
2781
|
+
description: Response object that includes a list of WAF custom rules.
|
2782
|
+
properties:
|
2783
|
+
data:
|
2784
|
+
description: The WAF custom rule data.
|
2785
|
+
items:
|
2786
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleData'
|
2787
|
+
type: array
|
2788
|
+
type: object
|
2789
|
+
ApplicationSecurityWafCustomRuleMetadata:
|
2790
|
+
description: Metadata associated with the WAF Custom Rule.
|
2791
|
+
properties:
|
2792
|
+
added_at:
|
2793
|
+
description: The date and time the WAF custom rule was created.
|
2794
|
+
example: '2021-01-01T00:00:00Z'
|
2795
|
+
format: date-time
|
2796
|
+
type: string
|
2797
|
+
added_by:
|
2798
|
+
description: The handle of the user who created the WAF custom rule.
|
2799
|
+
example: john.doe@datadoghq.com
|
2800
|
+
type: string
|
2801
|
+
added_by_name:
|
2802
|
+
description: The name of the user who created the WAF custom rule.
|
2803
|
+
example: John Doe
|
2804
|
+
type: string
|
2805
|
+
modified_at:
|
2806
|
+
description: The date and time the WAF custom rule was last updated.
|
2807
|
+
example: '2021-01-01T00:00:00Z'
|
2808
|
+
format: date-time
|
2809
|
+
type: string
|
2810
|
+
modified_by:
|
2811
|
+
description: The handle of the user who last updated the WAF custom rule.
|
2812
|
+
example: john.doe@datadoghq.com
|
2813
|
+
type: string
|
2814
|
+
modified_by_name:
|
2815
|
+
description: The name of the user who last updated the WAF custom rule.
|
2816
|
+
example: John Doe
|
2817
|
+
type: string
|
2818
|
+
readOnly: true
|
2819
|
+
type: object
|
2820
|
+
ApplicationSecurityWafCustomRuleResponse:
|
2821
|
+
description: Response object that includes a single WAF custom rule.
|
2822
|
+
properties:
|
2823
|
+
data:
|
2824
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleData'
|
2825
|
+
type: object
|
2826
|
+
ApplicationSecurityWafCustomRuleScope:
|
2827
|
+
description: The scope of the WAF custom rule.
|
2828
|
+
properties:
|
2829
|
+
env:
|
2830
|
+
description: The environment scope for the WAF custom rule.
|
2831
|
+
example: prod
|
2832
|
+
type: string
|
2833
|
+
service:
|
2834
|
+
description: The service scope for the WAF custom rule.
|
2835
|
+
example: billing-service
|
2836
|
+
type: string
|
2837
|
+
required:
|
2838
|
+
- service
|
2839
|
+
- env
|
2840
|
+
type: object
|
2841
|
+
ApplicationSecurityWafCustomRuleTags:
|
2842
|
+
additionalProperties:
|
2843
|
+
type: string
|
2844
|
+
description: 'Tags associated with the WAF Custom Rule. The concatenation of
|
2845
|
+
category and type will form the security
|
2846
|
+
|
2847
|
+
activity field associated with the traces.'
|
2848
|
+
maxProperties: 32
|
2849
|
+
properties:
|
2850
|
+
category:
|
2851
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTagsCategory'
|
2852
|
+
type:
|
2853
|
+
description: The type of the WAF rule, associated with the category will
|
2854
|
+
form the security activity.
|
2855
|
+
example: users.login.success
|
2856
|
+
type: string
|
2857
|
+
required:
|
2858
|
+
- category
|
2859
|
+
- type
|
2860
|
+
type: object
|
2861
|
+
ApplicationSecurityWafCustomRuleTagsCategory:
|
2862
|
+
description: The category of the WAF Rule, can be either `business_logic`, `attack_attempt`
|
2863
|
+
or `security_response`.
|
2864
|
+
enum:
|
2865
|
+
- attack_attempt
|
2866
|
+
- business_logic
|
2867
|
+
- security_responses
|
2868
|
+
example: business_logic
|
2869
|
+
type: string
|
2870
|
+
x-enum-varnames:
|
2871
|
+
- ATTACK_ATTEMPT
|
2872
|
+
- BUSINESS_LOGIC
|
2873
|
+
- SECURITY_RESPONSES
|
2874
|
+
ApplicationSecurityWafCustomRuleType:
|
2875
|
+
default: custom_rule
|
2876
|
+
description: The type of the resource. The value should always be `custom_rule`.
|
2877
|
+
enum:
|
2878
|
+
- custom_rule
|
2879
|
+
example: custom_rule
|
2880
|
+
type: string
|
2881
|
+
x-enum-varnames:
|
2882
|
+
- CUSTOM_RULE
|
2883
|
+
ApplicationSecurityWafCustomRuleUpdateAttributes:
|
2884
|
+
description: Update a WAF custom rule.
|
2885
|
+
properties:
|
2886
|
+
action:
|
2887
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction'
|
2888
|
+
blocking:
|
2889
|
+
description: Indicates whether the WAF custom rule will block the request.
|
2890
|
+
example: false
|
2891
|
+
type: boolean
|
2892
|
+
conditions:
|
2893
|
+
description: 'Conditions for which the WAF Custom Rule will triggers, all
|
2894
|
+
conditions needs to match in order for the WAF
|
2895
|
+
|
2896
|
+
rule to trigger.'
|
2897
|
+
items:
|
2898
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition'
|
2899
|
+
type: array
|
2900
|
+
enabled:
|
2901
|
+
description: Indicates whether the WAF custom rule is enabled.
|
2902
|
+
example: false
|
2903
|
+
type: boolean
|
2904
|
+
name:
|
2905
|
+
description: The Name of the WAF custom rule.
|
2906
|
+
example: Block request from bad useragent
|
2907
|
+
type: string
|
2908
|
+
path_glob:
|
2909
|
+
description: The path glob for the WAF custom rule.
|
2910
|
+
example: /api/search/*
|
2911
|
+
type: string
|
2912
|
+
scope:
|
2913
|
+
description: The scope of the WAF custom rule.
|
2914
|
+
items:
|
2915
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope'
|
2916
|
+
type: array
|
2917
|
+
tags:
|
2918
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags'
|
2919
|
+
required:
|
2920
|
+
- enabled
|
2921
|
+
- blocking
|
2922
|
+
- name
|
2923
|
+
- tags
|
2924
|
+
- conditions
|
2925
|
+
type: object
|
2926
|
+
ApplicationSecurityWafCustomRuleUpdateData:
|
2927
|
+
description: Object for a single WAF Custom Rule.
|
2928
|
+
properties:
|
2929
|
+
attributes:
|
2930
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateAttributes'
|
2931
|
+
type:
|
2932
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType'
|
2933
|
+
required:
|
2934
|
+
- attributes
|
2935
|
+
- type
|
2936
|
+
type: object
|
2937
|
+
ApplicationSecurityWafCustomRuleUpdateRequest:
|
2938
|
+
description: Request object that includes the Custom Rule to update.
|
2939
|
+
properties:
|
2940
|
+
data:
|
2941
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateData'
|
2942
|
+
required:
|
2943
|
+
- data
|
2944
|
+
type: object
|
2945
|
+
ApplicationSecurityWafExclusionFilterAttributes:
|
2946
|
+
description: Attributes describing a WAF exclusion filter.
|
2947
|
+
properties:
|
2948
|
+
description:
|
2949
|
+
description: A description for the exclusion filter.
|
2950
|
+
example: Exclude false positives on a path
|
2951
|
+
type: string
|
2952
|
+
enabled:
|
2953
|
+
description: Indicates whether the exclusion filter is enabled.
|
2954
|
+
example: true
|
2955
|
+
type: boolean
|
2956
|
+
event_query:
|
2957
|
+
description: The event query matched by the legacy exclusion filter. Cannot
|
2958
|
+
be created nor updated.
|
2959
|
+
type: string
|
2960
|
+
ip_list:
|
2961
|
+
description: The client IP addresses matched by the exclusion filter (CIDR
|
2962
|
+
notation is supported).
|
2963
|
+
items:
|
2964
|
+
example: 198.51.100.72
|
2965
|
+
type: string
|
2966
|
+
type: array
|
2967
|
+
metadata:
|
2968
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterMetadata'
|
2969
|
+
on_match:
|
2970
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch'
|
2971
|
+
parameters:
|
2972
|
+
description: A list of parameters matched by the exclusion filter in the
|
2973
|
+
HTTP query string and HTTP request body. Nested parameters can be matched
|
2974
|
+
by joining fields with a dot character.
|
2975
|
+
items:
|
2976
|
+
example: list.search.query
|
2977
|
+
type: string
|
2978
|
+
type: array
|
2979
|
+
path_glob:
|
2980
|
+
description: The HTTP path glob expression matched by the exclusion filter.
|
2981
|
+
example: /accounts/*
|
2982
|
+
type: string
|
2983
|
+
rules_target:
|
2984
|
+
description: The WAF rules targeted by the exclusion filter.
|
2985
|
+
items:
|
2986
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget'
|
2987
|
+
type: array
|
2988
|
+
scope:
|
2989
|
+
description: The services where the exclusion filter is deployed.
|
2990
|
+
items:
|
2991
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope'
|
2992
|
+
type: array
|
2993
|
+
search_query:
|
2994
|
+
description: Generated event search query for traces matching the exclusion
|
2995
|
+
filter.
|
2996
|
+
readOnly: true
|
2997
|
+
type: string
|
2998
|
+
type: object
|
2999
|
+
ApplicationSecurityWafExclusionFilterCreateAttributes:
|
3000
|
+
description: Attributes for creating a WAF exclusion filter.
|
3001
|
+
properties:
|
3002
|
+
description:
|
3003
|
+
description: A description for the exclusion filter.
|
3004
|
+
example: Exclude false positives on a path
|
3005
|
+
type: string
|
3006
|
+
enabled:
|
3007
|
+
description: Indicates whether the exclusion filter is enabled.
|
3008
|
+
example: true
|
3009
|
+
type: boolean
|
3010
|
+
ip_list:
|
3011
|
+
description: The client IP addresses matched by the exclusion filter (CIDR
|
3012
|
+
notation is supported).
|
3013
|
+
items:
|
3014
|
+
example: 198.51.100.72
|
3015
|
+
type: string
|
3016
|
+
type: array
|
3017
|
+
on_match:
|
3018
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch'
|
3019
|
+
parameters:
|
3020
|
+
description: A list of parameters matched by the exclusion filter in the
|
3021
|
+
HTTP query string and HTTP request body. Nested parameters can be matched
|
3022
|
+
by joining fields with a dot character.
|
3023
|
+
items:
|
3024
|
+
example: list.search.query
|
3025
|
+
type: string
|
3026
|
+
type: array
|
3027
|
+
path_glob:
|
3028
|
+
description: The HTTP path glob expression matched by the exclusion filter.
|
3029
|
+
example: /accounts/*
|
3030
|
+
type: string
|
3031
|
+
rules_target:
|
3032
|
+
description: The WAF rules targeted by the exclusion filter.
|
3033
|
+
items:
|
3034
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget'
|
3035
|
+
type: array
|
3036
|
+
scope:
|
3037
|
+
description: The services where the exclusion filter is deployed.
|
3038
|
+
items:
|
3039
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope'
|
3040
|
+
type: array
|
3041
|
+
required:
|
3042
|
+
- description
|
3043
|
+
- enabled
|
3044
|
+
type: object
|
3045
|
+
ApplicationSecurityWafExclusionFilterCreateData:
|
3046
|
+
description: Object for creating a single WAF exclusion filter.
|
3047
|
+
properties:
|
3048
|
+
attributes:
|
3049
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateAttributes'
|
3050
|
+
type:
|
3051
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType'
|
3052
|
+
required:
|
3053
|
+
- attributes
|
3054
|
+
- type
|
3055
|
+
type: object
|
3056
|
+
ApplicationSecurityWafExclusionFilterCreateRequest:
|
3057
|
+
description: Request object for creating a single WAF exclusion filter.
|
3058
|
+
properties:
|
3059
|
+
data:
|
3060
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateData'
|
3061
|
+
required:
|
3062
|
+
- data
|
3063
|
+
type: object
|
3064
|
+
ApplicationSecurityWafExclusionFilterID:
|
3065
|
+
description: The identifier of the WAF exclusion filter.
|
3066
|
+
example: 3dd-0uc-h1s
|
3067
|
+
readOnly: true
|
3068
|
+
type: string
|
3069
|
+
ApplicationSecurityWafExclusionFilterMetadata:
|
3070
|
+
description: Extra information about the exclusion filter.
|
3071
|
+
properties:
|
3072
|
+
added_at:
|
3073
|
+
description: The creation date of the exclusion filter.
|
3074
|
+
format: date-time
|
3075
|
+
type: string
|
3076
|
+
added_by:
|
3077
|
+
description: The handle of the user who created the exclusion filter.
|
3078
|
+
type: string
|
3079
|
+
added_by_name:
|
3080
|
+
description: The name of the user who created the exclusion filter.
|
3081
|
+
type: string
|
3082
|
+
modified_at:
|
3083
|
+
description: The last modification date of the exclusion filter.
|
3084
|
+
format: date-time
|
3085
|
+
type: string
|
3086
|
+
modified_by:
|
3087
|
+
description: The handle of the user who last modified the exclusion filter.
|
3088
|
+
type: string
|
3089
|
+
modified_by_name:
|
3090
|
+
description: The name of the user who last modified the exclusion filter.
|
3091
|
+
type: string
|
3092
|
+
readOnly: true
|
3093
|
+
type: object
|
3094
|
+
ApplicationSecurityWafExclusionFilterOnMatch:
|
3095
|
+
description: The action taken when the exclusion filter matches. When set to
|
3096
|
+
`monitor`, security traces are emitted but the requests are not blocked. By
|
3097
|
+
default, security traces are not emitted and the requests are not blocked.
|
3098
|
+
enum:
|
3099
|
+
- monitor
|
3100
|
+
type: string
|
3101
|
+
x-enum-varnames:
|
3102
|
+
- MONITOR
|
3103
|
+
ApplicationSecurityWafExclusionFilterResource:
|
3104
|
+
description: A JSON:API resource for an WAF exclusion filter.
|
3105
|
+
properties:
|
3106
|
+
attributes:
|
3107
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterAttributes'
|
3108
|
+
id:
|
3109
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterID'
|
3110
|
+
type:
|
3111
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType'
|
3112
|
+
type: object
|
3113
|
+
ApplicationSecurityWafExclusionFilterResponse:
|
3114
|
+
description: Response object for a single WAF exclusion filter.
|
3115
|
+
properties:
|
3116
|
+
data:
|
3117
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResource'
|
3118
|
+
type: object
|
3119
|
+
ApplicationSecurityWafExclusionFilterRulesTarget:
|
3120
|
+
description: Target WAF rules based either on an identifier or tags.
|
3121
|
+
properties:
|
3122
|
+
rule_id:
|
3123
|
+
description: Target a single WAF rule based on its identifier.
|
3124
|
+
example: dog-913-009
|
3125
|
+
type: string
|
3126
|
+
tags:
|
3127
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTargetTags'
|
3128
|
+
type: object
|
3129
|
+
ApplicationSecurityWafExclusionFilterRulesTargetTags:
|
3130
|
+
additionalProperties:
|
3131
|
+
type: string
|
3132
|
+
description: Target multiple WAF rules based on their tags.
|
3133
|
+
properties:
|
3134
|
+
category:
|
3135
|
+
description: The category of the targeted WAF rules.
|
3136
|
+
example: attack_attempt
|
3137
|
+
type: string
|
3138
|
+
type:
|
3139
|
+
description: The type of the targeted WAF rules.
|
3140
|
+
example: lfi
|
3141
|
+
type: string
|
3142
|
+
type: object
|
3143
|
+
ApplicationSecurityWafExclusionFilterScope:
|
3144
|
+
description: Deploy on services based on their environment and/or service name.
|
3145
|
+
properties:
|
3146
|
+
env:
|
3147
|
+
description: Deploy on this environment.
|
3148
|
+
example: www
|
3149
|
+
type: string
|
3150
|
+
service:
|
3151
|
+
description: Deploy on this service.
|
3152
|
+
example: prod
|
3153
|
+
type: string
|
3154
|
+
type: object
|
3155
|
+
ApplicationSecurityWafExclusionFilterType:
|
3156
|
+
default: exclusion_filter
|
3157
|
+
description: Type of the resource. The value should always be `exclusion_filter`.
|
3158
|
+
enum:
|
3159
|
+
- exclusion_filter
|
3160
|
+
example: exclusion_filter
|
3161
|
+
type: string
|
3162
|
+
x-enum-varnames:
|
3163
|
+
- EXCLUSION_FILTER
|
3164
|
+
ApplicationSecurityWafExclusionFilterUpdateAttributes:
|
3165
|
+
description: Attributes for updating a WAF exclusion filter.
|
3166
|
+
properties:
|
3167
|
+
description:
|
3168
|
+
description: A description for the exclusion filter.
|
3169
|
+
example: Exclude false positives on a path
|
3170
|
+
type: string
|
3171
|
+
enabled:
|
3172
|
+
description: Indicates whether the exclusion filter is enabled.
|
3173
|
+
example: true
|
3174
|
+
type: boolean
|
3175
|
+
ip_list:
|
3176
|
+
description: The client IP addresses matched by the exclusion filter (CIDR
|
3177
|
+
notation is supported).
|
3178
|
+
items:
|
3179
|
+
example: 198.51.100.72
|
3180
|
+
type: string
|
3181
|
+
type: array
|
3182
|
+
on_match:
|
3183
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch'
|
3184
|
+
parameters:
|
3185
|
+
description: A list of parameters matched by the exclusion filter in the
|
3186
|
+
HTTP query string and HTTP request body. Nested parameters can be matched
|
3187
|
+
by joining fields with a dot character.
|
3188
|
+
items:
|
3189
|
+
example: list.search.query
|
3190
|
+
type: string
|
3191
|
+
type: array
|
3192
|
+
path_glob:
|
3193
|
+
description: The HTTP path glob expression matched by the exclusion filter.
|
3194
|
+
example: /accounts/*
|
3195
|
+
type: string
|
3196
|
+
rules_target:
|
3197
|
+
description: The WAF rules targeted by the exclusion filter.
|
3198
|
+
items:
|
3199
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget'
|
3200
|
+
type: array
|
3201
|
+
scope:
|
3202
|
+
description: The services where the exclusion filter is deployed.
|
3203
|
+
items:
|
3204
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope'
|
3205
|
+
type: array
|
3206
|
+
required:
|
3207
|
+
- description
|
3208
|
+
- enabled
|
3209
|
+
type: object
|
3210
|
+
ApplicationSecurityWafExclusionFilterUpdateData:
|
3211
|
+
description: Object for updating a single WAF exclusion filter.
|
3212
|
+
properties:
|
3213
|
+
attributes:
|
3214
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateAttributes'
|
3215
|
+
type:
|
3216
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType'
|
3217
|
+
required:
|
3218
|
+
- attributes
|
3219
|
+
- type
|
3220
|
+
type: object
|
3221
|
+
ApplicationSecurityWafExclusionFilterUpdateRequest:
|
3222
|
+
description: Request object for updating a single WAF exclusion filter.
|
3223
|
+
properties:
|
3224
|
+
data:
|
3225
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateData'
|
3226
|
+
required:
|
3227
|
+
- data
|
3228
|
+
type: object
|
3229
|
+
ApplicationSecurityWafExclusionFiltersResponse:
|
3230
|
+
description: Response object for multiple WAF exclusion filters.
|
3231
|
+
properties:
|
3232
|
+
data:
|
3233
|
+
description: A list of WAF exclusion filters.
|
3234
|
+
items:
|
3235
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResource'
|
3236
|
+
type: array
|
3237
|
+
type: object
|
2119
3238
|
AppsSortField:
|
2120
3239
|
description: The field and direction to sort apps by
|
2121
3240
|
enum:
|
@@ -2771,6 +3890,10 @@ components:
|
|
2771
3890
|
type: string
|
2772
3891
|
x-enum-varnames:
|
2773
3892
|
- AUTHN_MAPPINGS
|
3893
|
+
AwsAccountId:
|
3894
|
+
description: The ID of the AWS account.
|
3895
|
+
example: '123456789012'
|
3896
|
+
type: string
|
2774
3897
|
AwsCURConfig:
|
2775
3898
|
description: AWS CUR config.
|
2776
3899
|
properties:
|
@@ -2789,6 +3912,8 @@ components:
|
|
2789
3912
|
AwsCURConfigAttributes:
|
2790
3913
|
description: Attributes for An AWS CUR config.
|
2791
3914
|
properties:
|
3915
|
+
account_filters:
|
3916
|
+
$ref: '#/components/schemas/AccountFilteringConfig'
|
2792
3917
|
account_id:
|
2793
3918
|
description: The AWS account ID.
|
2794
3919
|
example: '123456789123'
|
@@ -2866,12 +3991,12 @@ components:
|
|
2866
3991
|
AwsCURConfigPatchRequestAttributes:
|
2867
3992
|
description: Attributes for AWS CUR config Patch Request.
|
2868
3993
|
properties:
|
3994
|
+
account_filters:
|
3995
|
+
$ref: '#/components/schemas/AccountFilteringConfig'
|
2869
3996
|
is_enabled:
|
2870
3997
|
description: Whether or not the Cloud Cost Management account is enabled.
|
2871
3998
|
example: true
|
2872
3999
|
type: boolean
|
2873
|
-
required:
|
2874
|
-
- is_enabled
|
2875
4000
|
type: object
|
2876
4001
|
AwsCURConfigPatchRequestType:
|
2877
4002
|
default: aws_cur_config_patch_request
|
@@ -2904,6 +4029,8 @@ components:
|
|
2904
4029
|
AwsCURConfigPostRequestAttributes:
|
2905
4030
|
description: Attributes for AWS CUR config Post Request.
|
2906
4031
|
properties:
|
4032
|
+
account_filters:
|
4033
|
+
$ref: '#/components/schemas/AccountFilteringConfig'
|
2907
4034
|
account_id:
|
2908
4035
|
description: The AWS account ID.
|
2909
4036
|
example: '123456789123'
|
@@ -2971,6 +4098,102 @@ components:
|
|
2971
4098
|
$ref: '#/components/schemas/AwsCURConfig'
|
2972
4099
|
type: array
|
2973
4100
|
type: object
|
4101
|
+
AwsOnDemandAttributes:
|
4102
|
+
description: Attributes for the AWS on demand task.
|
4103
|
+
properties:
|
4104
|
+
arn:
|
4105
|
+
description: The arn of the resource to scan.
|
4106
|
+
example: arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba
|
4107
|
+
type: string
|
4108
|
+
assigned_at:
|
4109
|
+
description: Specifies the assignment timestamp if the task has been already
|
4110
|
+
assigned to a scanner.
|
4111
|
+
example: '2025-02-11T18:25:04.550564Z'
|
4112
|
+
type: string
|
4113
|
+
created_at:
|
4114
|
+
description: The task submission timestamp.
|
4115
|
+
example: '2025-02-11T18:13:24.576915Z'
|
4116
|
+
type: string
|
4117
|
+
status:
|
4118
|
+
description: 'Indicates the status of the task.
|
4119
|
+
|
4120
|
+
QUEUED: the task has been submitted successfully and the resource has
|
4121
|
+
not been assigned to a scanner yet.
|
4122
|
+
|
4123
|
+
ASSIGNED: the task has been assigned.
|
4124
|
+
|
4125
|
+
ABORTED: the scan has been aborted after a period of time due to technical
|
4126
|
+
reasons, such as resource not found, insufficient permissions, or the
|
4127
|
+
absence of a configured scanner.'
|
4128
|
+
example: QUEUED
|
4129
|
+
type: string
|
4130
|
+
type: object
|
4131
|
+
AwsOnDemandCreateAttributes:
|
4132
|
+
description: Attributes for the AWS on demand task.
|
4133
|
+
properties:
|
4134
|
+
arn:
|
4135
|
+
description: The arn of the resource to scan. Agentless supports the scan
|
4136
|
+
of EC2 instances, lambda functions, AMI, ECR, RDS and S3 buckets.
|
4137
|
+
example: arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba
|
4138
|
+
type: string
|
4139
|
+
required:
|
4140
|
+
- arn
|
4141
|
+
type: object
|
4142
|
+
AwsOnDemandCreateData:
|
4143
|
+
description: Object for a single AWS on demand task.
|
4144
|
+
properties:
|
4145
|
+
attributes:
|
4146
|
+
$ref: '#/components/schemas/AwsOnDemandCreateAttributes'
|
4147
|
+
type:
|
4148
|
+
$ref: '#/components/schemas/AwsOnDemandType'
|
4149
|
+
required:
|
4150
|
+
- type
|
4151
|
+
- attributes
|
4152
|
+
type: object
|
4153
|
+
AwsOnDemandCreateRequest:
|
4154
|
+
description: Request object that includes the on demand task to submit.
|
4155
|
+
properties:
|
4156
|
+
data:
|
4157
|
+
$ref: '#/components/schemas/AwsOnDemandCreateData'
|
4158
|
+
required:
|
4159
|
+
- data
|
4160
|
+
type: object
|
4161
|
+
AwsOnDemandData:
|
4162
|
+
description: Single AWS on demand task.
|
4163
|
+
properties:
|
4164
|
+
attributes:
|
4165
|
+
$ref: '#/components/schemas/AwsOnDemandAttributes'
|
4166
|
+
id:
|
4167
|
+
description: The UUID of the task.
|
4168
|
+
example: 6d09294c-9ad9-42fd-a759-a0c1599b4828
|
4169
|
+
type: string
|
4170
|
+
type:
|
4171
|
+
$ref: '#/components/schemas/AwsOnDemandType'
|
4172
|
+
type: object
|
4173
|
+
AwsOnDemandListResponse:
|
4174
|
+
description: Response object that includes a list of AWS on demand tasks.
|
4175
|
+
properties:
|
4176
|
+
data:
|
4177
|
+
description: A list of on demand tasks.
|
4178
|
+
items:
|
4179
|
+
$ref: '#/components/schemas/AwsOnDemandData'
|
4180
|
+
type: array
|
4181
|
+
type: object
|
4182
|
+
AwsOnDemandResponse:
|
4183
|
+
description: Response object that includes an AWS on demand task.
|
4184
|
+
properties:
|
4185
|
+
data:
|
4186
|
+
$ref: '#/components/schemas/AwsOnDemandData'
|
4187
|
+
type: object
|
4188
|
+
AwsOnDemandType:
|
4189
|
+
default: aws_resource
|
4190
|
+
description: The type of the on demand task. The value should always be `aws_resource`.
|
4191
|
+
enum:
|
4192
|
+
- aws_resource
|
4193
|
+
example: aws_resource
|
4194
|
+
type: string
|
4195
|
+
x-enum-varnames:
|
4196
|
+
- AWS_RESOURCE
|
2974
4197
|
AwsScanOptionsAttributes:
|
2975
4198
|
description: Attributes for the AWS scan options.
|
2976
4199
|
properties:
|
@@ -2992,6 +4215,54 @@ components:
|
|
2992
4215
|
example: true
|
2993
4216
|
type: boolean
|
2994
4217
|
type: object
|
4218
|
+
AwsScanOptionsCreateAttributes:
|
4219
|
+
description: Attributes for the AWS scan options to create.
|
4220
|
+
properties:
|
4221
|
+
lambda:
|
4222
|
+
description: Indicates if scanning of Lambda functions is enabled.
|
4223
|
+
example: true
|
4224
|
+
type: boolean
|
4225
|
+
sensitive_data:
|
4226
|
+
description: Indicates if scanning for sensitive data is enabled.
|
4227
|
+
example: false
|
4228
|
+
type: boolean
|
4229
|
+
vuln_containers_os:
|
4230
|
+
description: Indicates if scanning for vulnerabilities in containers is
|
4231
|
+
enabled.
|
4232
|
+
example: true
|
4233
|
+
type: boolean
|
4234
|
+
vuln_host_os:
|
4235
|
+
description: Indicates if scanning for vulnerabilities in hosts is enabled.
|
4236
|
+
example: true
|
4237
|
+
type: boolean
|
4238
|
+
required:
|
4239
|
+
- lambda
|
4240
|
+
- sensitive_data
|
4241
|
+
- vuln_containers_os
|
4242
|
+
- vuln_host_os
|
4243
|
+
type: object
|
4244
|
+
AwsScanOptionsCreateData:
|
4245
|
+
description: Object for the scan options of a single AWS account.
|
4246
|
+
properties:
|
4247
|
+
attributes:
|
4248
|
+
$ref: '#/components/schemas/AwsScanOptionsCreateAttributes'
|
4249
|
+
id:
|
4250
|
+
$ref: '#/components/schemas/AwsAccountId'
|
4251
|
+
type:
|
4252
|
+
$ref: '#/components/schemas/AwsScanOptionsType'
|
4253
|
+
required:
|
4254
|
+
- id
|
4255
|
+
- type
|
4256
|
+
- attributes
|
4257
|
+
type: object
|
4258
|
+
AwsScanOptionsCreateRequest:
|
4259
|
+
description: Request object that includes the scan options to create.
|
4260
|
+
properties:
|
4261
|
+
data:
|
4262
|
+
$ref: '#/components/schemas/AwsScanOptionsCreateData'
|
4263
|
+
required:
|
4264
|
+
- data
|
4265
|
+
type: object
|
2995
4266
|
AwsScanOptionsData:
|
2996
4267
|
description: Single AWS Scan Options entry.
|
2997
4268
|
properties:
|
@@ -3004,7 +4275,7 @@ components:
|
|
3004
4275
|
type:
|
3005
4276
|
$ref: '#/components/schemas/AwsScanOptionsType'
|
3006
4277
|
type: object
|
3007
|
-
|
4278
|
+
AwsScanOptionsListResponse:
|
3008
4279
|
description: Response object that includes a list of AWS scan options.
|
3009
4280
|
properties:
|
3010
4281
|
data:
|
@@ -3013,6 +4284,12 @@ components:
|
|
3013
4284
|
$ref: '#/components/schemas/AwsScanOptionsData'
|
3014
4285
|
type: array
|
3015
4286
|
type: object
|
4287
|
+
AwsScanOptionsResponse:
|
4288
|
+
description: Response object that includes the scan options of an AWS account.
|
4289
|
+
properties:
|
4290
|
+
data:
|
4291
|
+
$ref: '#/components/schemas/AwsScanOptionsData'
|
4292
|
+
type: object
|
3016
4293
|
AwsScanOptionsType:
|
3017
4294
|
default: aws_scan_options
|
3018
4295
|
description: The type of the resource. The value should always be `aws_scan_options`.
|
@@ -3022,6 +4299,49 @@ components:
|
|
3022
4299
|
type: string
|
3023
4300
|
x-enum-varnames:
|
3024
4301
|
- AWS_SCAN_OPTIONS
|
4302
|
+
AwsScanOptionsUpdateAttributes:
|
4303
|
+
description: Attributes for the AWS scan options to update.
|
4304
|
+
properties:
|
4305
|
+
lambda:
|
4306
|
+
description: Indicates if scanning of Lambda functions is enabled.
|
4307
|
+
example: true
|
4308
|
+
type: boolean
|
4309
|
+
sensitive_data:
|
4310
|
+
description: Indicates if scanning for sensitive data is enabled.
|
4311
|
+
example: false
|
4312
|
+
type: boolean
|
4313
|
+
vuln_containers_os:
|
4314
|
+
description: Indicates if scanning for vulnerabilities in containers is
|
4315
|
+
enabled.
|
4316
|
+
example: true
|
4317
|
+
type: boolean
|
4318
|
+
vuln_host_os:
|
4319
|
+
description: Indicates if scanning for vulnerabilities in hosts is enabled.
|
4320
|
+
example: true
|
4321
|
+
type: boolean
|
4322
|
+
type: object
|
4323
|
+
AwsScanOptionsUpdateData:
|
4324
|
+
description: Object for the scan options of a single AWS account.
|
4325
|
+
properties:
|
4326
|
+
attributes:
|
4327
|
+
$ref: '#/components/schemas/AwsScanOptionsUpdateAttributes'
|
4328
|
+
id:
|
4329
|
+
$ref: '#/components/schemas/AwsAccountId'
|
4330
|
+
type:
|
4331
|
+
$ref: '#/components/schemas/AwsScanOptionsType'
|
4332
|
+
required:
|
4333
|
+
- id
|
4334
|
+
- type
|
4335
|
+
- attributes
|
4336
|
+
type: object
|
4337
|
+
AwsScanOptionsUpdateRequest:
|
4338
|
+
description: Request object that includes the scan options to update.
|
4339
|
+
properties:
|
4340
|
+
data:
|
4341
|
+
$ref: '#/components/schemas/AwsScanOptionsUpdateData'
|
4342
|
+
required:
|
4343
|
+
- data
|
4344
|
+
type: object
|
3025
4345
|
AzureUCConfig:
|
3026
4346
|
description: Azure config.
|
3027
4347
|
properties:
|
@@ -3066,7 +4386,7 @@ components:
|
|
3066
4386
|
type: integer
|
3067
4387
|
scope:
|
3068
4388
|
description: The scope of your observed subscription.
|
3069
|
-
example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
4389
|
+
example: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
3070
4390
|
type: string
|
3071
4391
|
status:
|
3072
4392
|
description: The status of the Azure config.
|
@@ -3222,7 +4542,7 @@ components:
|
|
3222
4542
|
type: boolean
|
3223
4543
|
scope:
|
3224
4544
|
description: The scope of your observed subscription.
|
3225
|
-
example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
4545
|
+
example: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
3226
4546
|
type: string
|
3227
4547
|
required:
|
3228
4548
|
- account_id
|
@@ -5204,6 +6524,23 @@ components:
|
|
5204
6524
|
- OPEN
|
5205
6525
|
- IN_PROGRESS
|
5206
6526
|
- CLOSED
|
6527
|
+
CaseTrigger:
|
6528
|
+
description: Trigger a workflow VIA a Case. For automatic triggering a handle
|
6529
|
+
must be configured and the workflow must be published.
|
6530
|
+
properties:
|
6531
|
+
rateLimit:
|
6532
|
+
$ref: '#/components/schemas/TriggerRateLimit'
|
6533
|
+
type: object
|
6534
|
+
CaseTriggerWrapper:
|
6535
|
+
description: Schema for a Case-based trigger.
|
6536
|
+
properties:
|
6537
|
+
caseTrigger:
|
6538
|
+
$ref: '#/components/schemas/CaseTrigger'
|
6539
|
+
startStepNames:
|
6540
|
+
$ref: '#/components/schemas/StartStepNames'
|
6541
|
+
required:
|
6542
|
+
- caseTrigger
|
6543
|
+
type: object
|
5207
6544
|
CaseType:
|
5208
6545
|
description: Case type
|
5209
6546
|
enum:
|
@@ -5421,6 +6758,17 @@ components:
|
|
5421
6758
|
type: string
|
5422
6759
|
x-enum-varnames:
|
5423
6760
|
- SERVICE
|
6761
|
+
ChangeEventTriggerWrapper:
|
6762
|
+
description: Schema for a Change Event-based trigger.
|
6763
|
+
properties:
|
6764
|
+
changeEventTrigger:
|
6765
|
+
description: Trigger a workflow VIA a Change Event.
|
6766
|
+
type: object
|
6767
|
+
startStepNames:
|
6768
|
+
$ref: '#/components/schemas/StartStepNames'
|
6769
|
+
required:
|
6770
|
+
- changeEventTrigger
|
6771
|
+
type: object
|
5424
6772
|
ChargebackBreakdown:
|
5425
6773
|
description: Charges breakdown.
|
5426
6774
|
properties:
|
@@ -6117,6 +7465,60 @@ components:
|
|
6117
7465
|
required:
|
6118
7466
|
- location
|
6119
7467
|
type: object
|
7468
|
+
CompletionCondition:
|
7469
|
+
description: The definition of `CompletionCondition` object.
|
7470
|
+
properties:
|
7471
|
+
operand1:
|
7472
|
+
description: The `CompletionCondition` `operand1`.
|
7473
|
+
operand2:
|
7474
|
+
description: The `CompletionCondition` `operand2`.
|
7475
|
+
operator:
|
7476
|
+
$ref: '#/components/schemas/CompletionConditionOperator'
|
7477
|
+
required:
|
7478
|
+
- operand1
|
7479
|
+
- operator
|
7480
|
+
type: object
|
7481
|
+
CompletionConditionOperator:
|
7482
|
+
description: The definition of `CompletionConditionOperator` object.
|
7483
|
+
enum:
|
7484
|
+
- OPERATOR_EQUAL
|
7485
|
+
- OPERATOR_NOT_EQUAL
|
7486
|
+
- OPERATOR_GREATER_THAN
|
7487
|
+
- OPERATOR_LESS_THAN
|
7488
|
+
- OPERATOR_GREATER_THAN_OR_EQUAL_TO
|
7489
|
+
- OPERATOR_LESS_THAN_OR_EQUAL_TO
|
7490
|
+
- OPERATOR_CONTAINS
|
7491
|
+
- OPERATOR_DOES_NOT_CONTAIN
|
7492
|
+
- OPERATOR_IS_NULL
|
7493
|
+
- OPERATOR_IS_NOT_NULL
|
7494
|
+
- OPERATOR_IS_EMPTY
|
7495
|
+
- OPERATOR_IS_NOT_EMPTY
|
7496
|
+
example: OPERATOR_EQUAL
|
7497
|
+
type: string
|
7498
|
+
x-enum-varnames:
|
7499
|
+
- OPERATOR_EQUAL
|
7500
|
+
- OPERATOR_NOT_EQUAL
|
7501
|
+
- OPERATOR_GREATER_THAN
|
7502
|
+
- OPERATOR_LESS_THAN
|
7503
|
+
- OPERATOR_GREATER_THAN_OR_EQUAL_TO
|
7504
|
+
- OPERATOR_LESS_THAN_OR_EQUAL_TO
|
7505
|
+
- OPERATOR_CONTAINS
|
7506
|
+
- OPERATOR_DOES_NOT_CONTAIN
|
7507
|
+
- OPERATOR_IS_NULL
|
7508
|
+
- OPERATOR_IS_NOT_NULL
|
7509
|
+
- OPERATOR_IS_EMPTY
|
7510
|
+
- OPERATOR_IS_NOT_EMPTY
|
7511
|
+
CompletionGate:
|
7512
|
+
description: Used to create conditions before running subsequent actions.
|
7513
|
+
properties:
|
7514
|
+
completionCondition:
|
7515
|
+
$ref: '#/components/schemas/CompletionCondition'
|
7516
|
+
retryStrategy:
|
7517
|
+
$ref: '#/components/schemas/RetryStrategy'
|
7518
|
+
required:
|
7519
|
+
- completionCondition
|
7520
|
+
- retryStrategy
|
7521
|
+
type: object
|
6120
7522
|
Component:
|
6121
7523
|
description: '[Definition of a UI component in the app](https://docs.datadoghq.com/service_management/app_builder/components/)'
|
6122
7524
|
properties:
|
@@ -6578,6 +7980,70 @@ components:
|
|
6578
7980
|
$ref: '#/components/schemas/ConfluentResourceResponseData'
|
6579
7981
|
type: array
|
6580
7982
|
type: object
|
7983
|
+
Connection:
|
7984
|
+
description: The definition of `Connection` object.
|
7985
|
+
properties:
|
7986
|
+
connectionId:
|
7987
|
+
description: The `Connection` `connectionId`.
|
7988
|
+
example: ''
|
7989
|
+
type: string
|
7990
|
+
label:
|
7991
|
+
description: The `Connection` `label`.
|
7992
|
+
example: ''
|
7993
|
+
type: string
|
7994
|
+
required:
|
7995
|
+
- connectionId
|
7996
|
+
- label
|
7997
|
+
type: object
|
7998
|
+
ConnectionEnv:
|
7999
|
+
description: A list of connections or connection groups used in the workflow.
|
8000
|
+
properties:
|
8001
|
+
connectionGroups:
|
8002
|
+
description: The `ConnectionEnv` `connectionGroups`.
|
8003
|
+
items:
|
8004
|
+
$ref: '#/components/schemas/ConnectionGroup'
|
8005
|
+
type: array
|
8006
|
+
connections:
|
8007
|
+
description: The `ConnectionEnv` `connections`.
|
8008
|
+
items:
|
8009
|
+
$ref: '#/components/schemas/Connection'
|
8010
|
+
type: array
|
8011
|
+
env:
|
8012
|
+
$ref: '#/components/schemas/ConnectionEnvEnv'
|
8013
|
+
required:
|
8014
|
+
- env
|
8015
|
+
type: object
|
8016
|
+
ConnectionEnvEnv:
|
8017
|
+
description: The definition of `ConnectionEnvEnv` object.
|
8018
|
+
enum:
|
8019
|
+
- default
|
8020
|
+
example: default
|
8021
|
+
type: string
|
8022
|
+
x-enum-varnames:
|
8023
|
+
- DEFAULT
|
8024
|
+
ConnectionGroup:
|
8025
|
+
description: The definition of `ConnectionGroup` object.
|
8026
|
+
properties:
|
8027
|
+
connectionGroupId:
|
8028
|
+
description: The `ConnectionGroup` `connectionGroupId`.
|
8029
|
+
example: ''
|
8030
|
+
type: string
|
8031
|
+
label:
|
8032
|
+
description: The `ConnectionGroup` `label`.
|
8033
|
+
example: ''
|
8034
|
+
type: string
|
8035
|
+
tags:
|
8036
|
+
description: The `ConnectionGroup` `tags`.
|
8037
|
+
example:
|
8038
|
+
- ''
|
8039
|
+
items:
|
8040
|
+
type: string
|
8041
|
+
type: array
|
8042
|
+
required:
|
8043
|
+
- connectionGroupId
|
8044
|
+
- label
|
8045
|
+
- tags
|
8046
|
+
type: object
|
6581
8047
|
Container:
|
6582
8048
|
description: Container object.
|
6583
8049
|
properties:
|
@@ -7557,6 +9023,82 @@ components:
|
|
7557
9023
|
type:
|
7558
9024
|
$ref: '#/components/schemas/RuleType'
|
7559
9025
|
type: object
|
9026
|
+
CreateWorkflowRequest:
|
9027
|
+
description: A request object for creating a new workflow.
|
9028
|
+
example:
|
9029
|
+
data:
|
9030
|
+
attributes:
|
9031
|
+
description: A sample workflow.
|
9032
|
+
name: Example Workflow
|
9033
|
+
published: true
|
9034
|
+
spec:
|
9035
|
+
annotations:
|
9036
|
+
- display:
|
9037
|
+
bounds:
|
9038
|
+
height: 150
|
9039
|
+
width: 300
|
9040
|
+
x: -375
|
9041
|
+
y: -0.5
|
9042
|
+
id: 99999999-9999-9999-9999-999999999999
|
9043
|
+
markdownTextAnnotation:
|
9044
|
+
text: Example annotation.
|
9045
|
+
connectionEnvs:
|
9046
|
+
- connections:
|
9047
|
+
- connectionId: 11111111-1111-1111-1111-111111111111
|
9048
|
+
label: INTEGRATION_DATADOG
|
9049
|
+
env: default
|
9050
|
+
handle: my-handle
|
9051
|
+
inputSchema:
|
9052
|
+
parameters:
|
9053
|
+
- defaultValue: default
|
9054
|
+
name: input
|
9055
|
+
type: STRING
|
9056
|
+
outputSchema:
|
9057
|
+
parameters:
|
9058
|
+
- name: output
|
9059
|
+
type: ARRAY_OBJECT
|
9060
|
+
value: '{{ Steps.Step1 }}'
|
9061
|
+
steps:
|
9062
|
+
- actionId: com.datadoghq.dd.monitor.listMonitors
|
9063
|
+
connectionLabel: INTEGRATION_DATADOG
|
9064
|
+
name: Step1
|
9065
|
+
outboundEdges:
|
9066
|
+
- branchName: main
|
9067
|
+
nextStepName: Step2
|
9068
|
+
parameters:
|
9069
|
+
- name: tags
|
9070
|
+
value: service:monitoring
|
9071
|
+
- actionId: com.datadoghq.core.noop
|
9072
|
+
name: Step2
|
9073
|
+
triggers:
|
9074
|
+
- monitorTrigger:
|
9075
|
+
rateLimit:
|
9076
|
+
count: 1
|
9077
|
+
interval: 3600s
|
9078
|
+
startStepNames:
|
9079
|
+
- Step1
|
9080
|
+
- githubWebhookTrigger: {}
|
9081
|
+
startStepNames:
|
9082
|
+
- Step1
|
9083
|
+
tags:
|
9084
|
+
- team:infra
|
9085
|
+
- service:monitoring
|
9086
|
+
- foo:bar
|
9087
|
+
type: workflows
|
9088
|
+
properties:
|
9089
|
+
data:
|
9090
|
+
$ref: '#/components/schemas/WorkflowData'
|
9091
|
+
required:
|
9092
|
+
- data
|
9093
|
+
type: object
|
9094
|
+
CreateWorkflowResponse:
|
9095
|
+
description: The response object after creating a new workflow.
|
9096
|
+
properties:
|
9097
|
+
data:
|
9098
|
+
$ref: '#/components/schemas/WorkflowData'
|
9099
|
+
required:
|
9100
|
+
- data
|
9101
|
+
type: object
|
7560
9102
|
Creator:
|
7561
9103
|
description: Creator of the object.
|
7562
9104
|
properties:
|
@@ -9043,6 +10585,17 @@ components:
|
|
9043
10585
|
$ref: '#/components/schemas/DashboardListItemResponse'
|
9044
10586
|
type: array
|
9045
10587
|
type: object
|
10588
|
+
DashboardTriggerWrapper:
|
10589
|
+
description: Schema for a Dashboard-based trigger.
|
10590
|
+
properties:
|
10591
|
+
dashboardTrigger:
|
10592
|
+
description: Trigger a workflow VIA a Dashboard.
|
10593
|
+
type: object
|
10594
|
+
startStepNames:
|
10595
|
+
$ref: '#/components/schemas/StartStepNames'
|
10596
|
+
required:
|
10597
|
+
- dashboardTrigger
|
10598
|
+
type: object
|
9046
10599
|
DashboardType:
|
9047
10600
|
description: The type of the dashboard.
|
9048
10601
|
enum:
|
@@ -9218,6 +10771,48 @@ components:
|
|
9218
10771
|
type: number
|
9219
10772
|
type: array
|
9220
10773
|
type: object
|
10774
|
+
DataTransform:
|
10775
|
+
description: A data transformer, which is custom JavaScript code that executes
|
10776
|
+
and transforms data when its inputs change.
|
10777
|
+
properties:
|
10778
|
+
id:
|
10779
|
+
description: The ID of the data transformer.
|
10780
|
+
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
|
10781
|
+
format: uuid
|
10782
|
+
type: string
|
10783
|
+
name:
|
10784
|
+
description: A unique identifier for this data transformer. This name is
|
10785
|
+
also used to access the transformer's result throughout the app.
|
10786
|
+
example: combineTwoOrders
|
10787
|
+
type: string
|
10788
|
+
properties:
|
10789
|
+
$ref: '#/components/schemas/DataTransformProperties'
|
10790
|
+
type:
|
10791
|
+
$ref: '#/components/schemas/DataTransformType'
|
10792
|
+
required:
|
10793
|
+
- id
|
10794
|
+
- name
|
10795
|
+
- type
|
10796
|
+
- properties
|
10797
|
+
type: object
|
10798
|
+
DataTransformProperties:
|
10799
|
+
description: The properties of the data transformer.
|
10800
|
+
properties:
|
10801
|
+
outputs:
|
10802
|
+
description: A JavaScript function that returns the transformed data.
|
10803
|
+
example: "${(() => {return {\n allItems: [...fetchOrder1.outputs.items,
|
10804
|
+
...fetchOrder2.outputs.items],\n}})()}"
|
10805
|
+
type: string
|
10806
|
+
type: object
|
10807
|
+
DataTransformType:
|
10808
|
+
default: dataTransform
|
10809
|
+
description: The data transform type.
|
10810
|
+
enum:
|
10811
|
+
- dataTransform
|
10812
|
+
example: dataTransform
|
10813
|
+
type: string
|
10814
|
+
x-enum-varnames:
|
10815
|
+
- DATATRANSFORM
|
9221
10816
|
Date:
|
9222
10817
|
description: Date as Unix timestamp in milliseconds.
|
9223
10818
|
example: 1722439510282
|
@@ -10624,6 +12219,7 @@ components:
|
|
10624
12219
|
definition:
|
10625
12220
|
description: The API definition.
|
10626
12221
|
type: object
|
12222
|
+
type: object
|
10627
12223
|
EntityV3APISpecInterfaceFileRef:
|
10628
12224
|
additionalProperties: false
|
10629
12225
|
description: The definition of `EntityV3APISpecInterfaceFileRef` object.
|
@@ -10631,6 +12227,7 @@ components:
|
|
10631
12227
|
fileRef:
|
10632
12228
|
description: The reference to the API definition file.
|
10633
12229
|
type: string
|
12230
|
+
type: object
|
10634
12231
|
EntityV3APIVersion:
|
10635
12232
|
description: The schema version of entity type. The field is known as schema-version
|
10636
12233
|
in the previous version.
|
@@ -10896,6 +12493,7 @@ components:
|
|
10896
12493
|
type: string
|
10897
12494
|
required:
|
10898
12495
|
- name
|
12496
|
+
type: object
|
10899
12497
|
EntityV3MetadataContactsItems:
|
10900
12498
|
additionalProperties: false
|
10901
12499
|
description: The definition of Entity V3 Metadata Contacts Items object.
|
@@ -11142,6 +12740,19 @@ components:
|
|
11142
12740
|
minLength: 1
|
11143
12741
|
type: string
|
11144
12742
|
type: object
|
12743
|
+
ErrorHandler:
|
12744
|
+
description: Used to handle errors in an action.
|
12745
|
+
properties:
|
12746
|
+
fallbackStepName:
|
12747
|
+
description: The `ErrorHandler` `fallbackStepName`.
|
12748
|
+
example: ''
|
12749
|
+
type: string
|
12750
|
+
retryStrategy:
|
12751
|
+
$ref: '#/components/schemas/RetryStrategy'
|
12752
|
+
required:
|
12753
|
+
- retryStrategy
|
12754
|
+
- fallbackStepName
|
12755
|
+
type: object
|
11145
12756
|
Event:
|
11146
12757
|
description: The metadata associated with a request.
|
11147
12758
|
properties:
|
@@ -11903,7 +13514,7 @@ components:
|
|
11903
13514
|
description: The schema representation of a Fastly service.
|
11904
13515
|
properties:
|
11905
13516
|
id:
|
11906
|
-
description: The
|
13517
|
+
description: The ID of the Fastly service
|
11907
13518
|
example: 6abc7de6893AbcDe9fghIj
|
11908
13519
|
type: string
|
11909
13520
|
tags:
|
@@ -12683,6 +14294,30 @@ components:
|
|
12683
14294
|
$ref: '#/components/schemas/GetInterfacesData'
|
12684
14295
|
type: array
|
12685
14296
|
type: object
|
14297
|
+
GetRuleVersionHistoryData:
|
14298
|
+
description: Data for the rule version history.
|
14299
|
+
properties:
|
14300
|
+
attributes:
|
14301
|
+
$ref: '#/components/schemas/RuleVersionHistory'
|
14302
|
+
id:
|
14303
|
+
description: ID of the rule.
|
14304
|
+
type: string
|
14305
|
+
type:
|
14306
|
+
$ref: '#/components/schemas/GetRuleVersionHistoryDataType'
|
14307
|
+
type: object
|
14308
|
+
GetRuleVersionHistoryDataType:
|
14309
|
+
description: Type of data.
|
14310
|
+
enum:
|
14311
|
+
- GetRuleVersionHistoryResponse
|
14312
|
+
type: string
|
14313
|
+
x-enum-varnames:
|
14314
|
+
- GETRULEVERSIONHISTORYRESPONSE
|
14315
|
+
GetRuleVersionHistoryResponse:
|
14316
|
+
description: Response for getting the rule version history.
|
14317
|
+
properties:
|
14318
|
+
data:
|
14319
|
+
$ref: '#/components/schemas/GetRuleVersionHistoryData'
|
14320
|
+
type: object
|
12686
14321
|
GetSBOMResponse:
|
12687
14322
|
description: The expected response schema when getting an SBOM.
|
12688
14323
|
properties:
|
@@ -12712,6 +14347,12 @@ components:
|
|
12712
14347
|
- _HANDLE
|
12713
14348
|
- EMAIL
|
12714
14349
|
- _EMAIL
|
14350
|
+
GetWorkflowResponse:
|
14351
|
+
description: The response object after getting a workflow.
|
14352
|
+
properties:
|
14353
|
+
data:
|
14354
|
+
$ref: '#/components/schemas/WorkflowData'
|
14355
|
+
type: object
|
12715
14356
|
GitCommitSHA:
|
12716
14357
|
description: Git Commit SHA.
|
12717
14358
|
example: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
@@ -12721,6 +14362,26 @@ components:
|
|
12721
14362
|
description: Git Repository URL
|
12722
14363
|
example: https://github.com/organization/example-repository
|
12723
14364
|
type: string
|
14365
|
+
GithubWebhookTrigger:
|
14366
|
+
description: Trigger a workflow VIA GitHub webhook. To trigger a workflow from
|
14367
|
+
GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings, set
|
14368
|
+
the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id",
|
14369
|
+
select application/json for the content type, and be highly recommend enabling
|
14370
|
+
SSL verification for security. The workflow must be published.
|
14371
|
+
properties:
|
14372
|
+
rateLimit:
|
14373
|
+
$ref: '#/components/schemas/TriggerRateLimit'
|
14374
|
+
type: object
|
14375
|
+
GithubWebhookTriggerWrapper:
|
14376
|
+
description: Schema for a GitHub webhook-based trigger.
|
14377
|
+
properties:
|
14378
|
+
githubWebhookTrigger:
|
14379
|
+
$ref: '#/components/schemas/GithubWebhookTrigger'
|
14380
|
+
startStepNames:
|
14381
|
+
$ref: '#/components/schemas/StartStepNames'
|
14382
|
+
required:
|
14383
|
+
- githubWebhookTrigger
|
14384
|
+
type: object
|
12724
14385
|
GroupScalarColumn:
|
12725
14386
|
description: A column containing the tag keys and values in a group.
|
12726
14387
|
properties:
|
@@ -15012,6 +16673,23 @@ components:
|
|
15012
16673
|
type: string
|
15013
16674
|
x-enum-varnames:
|
15014
16675
|
- INCIDENT_TODOS
|
16676
|
+
IncidentTrigger:
|
16677
|
+
description: Trigger a workflow VIA an Incident. For automatic triggering a
|
16678
|
+
handle must be configured and the workflow must be published.
|
16679
|
+
properties:
|
16680
|
+
rateLimit:
|
16681
|
+
$ref: '#/components/schemas/TriggerRateLimit'
|
16682
|
+
type: object
|
16683
|
+
IncidentTriggerWrapper:
|
16684
|
+
description: Schema for an Incident-based trigger.
|
16685
|
+
properties:
|
16686
|
+
incidentTrigger:
|
16687
|
+
$ref: '#/components/schemas/IncidentTrigger'
|
16688
|
+
startStepNames:
|
16689
|
+
$ref: '#/components/schemas/StartStepNames'
|
16690
|
+
required:
|
16691
|
+
- incidentTrigger
|
16692
|
+
type: object
|
15015
16693
|
IncidentType:
|
15016
16694
|
default: incidents
|
15017
16695
|
description: Incident resource type.
|
@@ -15456,6 +17134,59 @@ components:
|
|
15456
17134
|
- ONCALL
|
15457
17135
|
- INCIDENT
|
15458
17136
|
- RELATION
|
17137
|
+
InputSchema:
|
17138
|
+
description: A list of input parameters for the workflow. These can be used
|
17139
|
+
as dynamic runtime values in your workflow.
|
17140
|
+
properties:
|
17141
|
+
parameters:
|
17142
|
+
description: The `InputSchema` `parameters`.
|
17143
|
+
items:
|
17144
|
+
$ref: '#/components/schemas/InputSchemaParameters'
|
17145
|
+
type: array
|
17146
|
+
type: object
|
17147
|
+
InputSchemaParameters:
|
17148
|
+
description: The definition of `InputSchemaParameters` object.
|
17149
|
+
properties:
|
17150
|
+
defaultValue:
|
17151
|
+
description: The `InputSchemaParameters` `defaultValue`.
|
17152
|
+
description:
|
17153
|
+
description: The `InputSchemaParameters` `description`.
|
17154
|
+
type: string
|
17155
|
+
label:
|
17156
|
+
description: The `InputSchemaParameters` `label`.
|
17157
|
+
type: string
|
17158
|
+
name:
|
17159
|
+
description: The `InputSchemaParameters` `name`.
|
17160
|
+
example: ''
|
17161
|
+
type: string
|
17162
|
+
type:
|
17163
|
+
$ref: '#/components/schemas/InputSchemaParametersType'
|
17164
|
+
required:
|
17165
|
+
- name
|
17166
|
+
- type
|
17167
|
+
type: object
|
17168
|
+
InputSchemaParametersType:
|
17169
|
+
description: The definition of `InputSchemaParametersType` object.
|
17170
|
+
enum:
|
17171
|
+
- STRING
|
17172
|
+
- NUMBER
|
17173
|
+
- BOOLEAN
|
17174
|
+
- OBJECT
|
17175
|
+
- ARRAY_STRING
|
17176
|
+
- ARRAY_NUMBER
|
17177
|
+
- ARRAY_BOOLEAN
|
17178
|
+
- ARRAY_OBJECT
|
17179
|
+
example: STRING
|
17180
|
+
type: string
|
17181
|
+
x-enum-varnames:
|
17182
|
+
- STRING
|
17183
|
+
- NUMBER
|
17184
|
+
- BOOLEAN
|
17185
|
+
- OBJECT
|
17186
|
+
- ARRAY_STRING
|
17187
|
+
- ARRAY_NUMBER
|
17188
|
+
- ARRAY_BOOLEAN
|
17189
|
+
- ARRAY_OBJECT
|
15459
17190
|
IntakePayloadAccepted:
|
15460
17191
|
description: The payload accepted for intake.
|
15461
17192
|
properties:
|
@@ -15657,6 +17388,15 @@ components:
|
|
15657
17388
|
example: 1729843470000
|
15658
17389
|
format: int64
|
15659
17390
|
type: integer
|
17391
|
+
groupSignalsBy:
|
17392
|
+
description: Additional grouping to perform on top of the existing groups
|
17393
|
+
in the query section. Must be a subset of the existing groups.
|
17394
|
+
example:
|
17395
|
+
- service
|
17396
|
+
items:
|
17397
|
+
description: Field to group by.
|
17398
|
+
type: string
|
17399
|
+
type: array
|
15660
17400
|
index:
|
15661
17401
|
description: Index used to load the data.
|
15662
17402
|
example: cloud_siem
|
@@ -16719,6 +18459,8 @@ components:
|
|
16719
18459
|
path:
|
16720
18460
|
description: The archive path.
|
16721
18461
|
type: string
|
18462
|
+
storage_class:
|
18463
|
+
$ref: '#/components/schemas/LogsArchiveStorageClassS3Type'
|
16722
18464
|
type:
|
16723
18465
|
$ref: '#/components/schemas/LogsArchiveDestinationS3Type'
|
16724
18466
|
required:
|
@@ -16862,6 +18604,23 @@ components:
|
|
16862
18604
|
- WORKING
|
16863
18605
|
- FAILING
|
16864
18606
|
- WORKING_AUTH_LEGACY
|
18607
|
+
LogsArchiveStorageClassS3Type:
|
18608
|
+
default: STANDARD
|
18609
|
+
description: The storage class where the archive will be stored.
|
18610
|
+
enum:
|
18611
|
+
- STANDARD
|
18612
|
+
- STANDARD_IA
|
18613
|
+
- ONEZONE_IA
|
18614
|
+
- INTELLIGENT_TIERING
|
18615
|
+
- GLACIER_IR
|
18616
|
+
example: STANDARD
|
18617
|
+
type: string
|
18618
|
+
x-enum-varnames:
|
18619
|
+
- STANDARD
|
18620
|
+
- STANDARD_IA
|
18621
|
+
- ONEZONE_IA
|
18622
|
+
- INTELLIGENT_TIERING
|
18623
|
+
- GLACIER_IR
|
16865
18624
|
LogsArchives:
|
16866
18625
|
description: The available archives.
|
16867
18626
|
properties:
|
@@ -17689,6 +19448,29 @@ components:
|
|
17689
19448
|
|
17690
19449
|
Defaults to false.'
|
17691
19450
|
type: boolean
|
19451
|
+
include_actively_queried_tags_window:
|
19452
|
+
description: 'When provided, all tags that have been actively queried are
|
19453
|
+
|
19454
|
+
configured (and, therefore, remain queryable) for each metric that
|
19455
|
+
|
19456
|
+
matches the given prefix. Minimum value is 1 second, and maximum
|
19457
|
+
|
19458
|
+
value is 7,776,000 seconds (90 days).'
|
19459
|
+
format: double
|
19460
|
+
maximum: 7776000
|
19461
|
+
minimum: 1
|
19462
|
+
type: number
|
19463
|
+
override_existing_configurations:
|
19464
|
+
description: 'When set to true, the configuration overrides any existing
|
19465
|
+
|
19466
|
+
configurations for the given metric with the new set of tags in this
|
19467
|
+
|
19468
|
+
configuration request. If false, old configurations are kept and
|
19469
|
+
|
19470
|
+
are merged with the set of tags in this configuration request.
|
19471
|
+
|
19472
|
+
Defaults to true.'
|
19473
|
+
type: boolean
|
17692
19474
|
tags:
|
17693
19475
|
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
|
17694
19476
|
type: object
|
@@ -19364,6 +21146,23 @@ components:
|
|
19364
21146
|
type:
|
19365
21147
|
$ref: '#/components/schemas/MonitorDowntimeMatchResourceType'
|
19366
21148
|
type: object
|
21149
|
+
MonitorTrigger:
|
21150
|
+
description: Trigger a workflow VIA a Monitor. For automatic triggering a handle
|
21151
|
+
must be configured and the workflow must be published.
|
21152
|
+
properties:
|
21153
|
+
rateLimit:
|
21154
|
+
$ref: '#/components/schemas/TriggerRateLimit'
|
21155
|
+
type: object
|
21156
|
+
MonitorTriggerWrapper:
|
21157
|
+
description: Schema for a Monitor-based trigger.
|
21158
|
+
properties:
|
21159
|
+
monitorTrigger:
|
21160
|
+
$ref: '#/components/schemas/MonitorTrigger'
|
21161
|
+
startStepNames:
|
21162
|
+
$ref: '#/components/schemas/StartStepNames'
|
21163
|
+
required:
|
21164
|
+
- monitorTrigger
|
21165
|
+
type: object
|
19367
21166
|
MonitorType:
|
19368
21167
|
description: Attributes from the monitor that triggered the event.
|
19369
21168
|
nullable: true
|
@@ -19736,6 +21535,7 @@ components:
|
|
19736
21535
|
$ref: '#/components/schemas/OktaAccountUpdateRequestAttributes'
|
19737
21536
|
type:
|
19738
21537
|
$ref: '#/components/schemas/OktaAccountType'
|
21538
|
+
type: object
|
19739
21539
|
OktaAccountsResponse:
|
19740
21540
|
description: The expected response schema when getting Okta accounts.
|
19741
21541
|
properties:
|
@@ -20127,6 +21927,21 @@ components:
|
|
20127
21927
|
type: string
|
20128
21928
|
x-enum-varnames:
|
20129
21929
|
- ORGS
|
21930
|
+
OutboundEdge:
|
21931
|
+
description: The definition of `OutboundEdge` object.
|
21932
|
+
properties:
|
21933
|
+
branchName:
|
21934
|
+
description: The `OutboundEdge` `branchName`.
|
21935
|
+
example: ''
|
21936
|
+
type: string
|
21937
|
+
nextStepName:
|
21938
|
+
description: The `OutboundEdge` `nextStepName`.
|
21939
|
+
example: ''
|
21940
|
+
type: string
|
21941
|
+
required:
|
21942
|
+
- nextStepName
|
21943
|
+
- branchName
|
21944
|
+
type: object
|
20130
21945
|
OutcomeType:
|
20131
21946
|
default: outcome
|
20132
21947
|
description: The JSON:API type for an outcome.
|
@@ -20306,6 +22121,60 @@ components:
|
|
20306
22121
|
example: /api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100
|
20307
22122
|
type: string
|
20308
22123
|
type: object
|
22124
|
+
OutputSchema:
|
22125
|
+
description: A list of output parameters for the workflow.
|
22126
|
+
properties:
|
22127
|
+
parameters:
|
22128
|
+
description: The `OutputSchema` `parameters`.
|
22129
|
+
items:
|
22130
|
+
$ref: '#/components/schemas/OutputSchemaParameters'
|
22131
|
+
type: array
|
22132
|
+
type: object
|
22133
|
+
OutputSchemaParameters:
|
22134
|
+
description: The definition of `OutputSchemaParameters` object.
|
22135
|
+
properties:
|
22136
|
+
defaultValue:
|
22137
|
+
description: The `OutputSchemaParameters` `defaultValue`.
|
22138
|
+
description:
|
22139
|
+
description: The `OutputSchemaParameters` `description`.
|
22140
|
+
type: string
|
22141
|
+
label:
|
22142
|
+
description: The `OutputSchemaParameters` `label`.
|
22143
|
+
type: string
|
22144
|
+
name:
|
22145
|
+
description: The `OutputSchemaParameters` `name`.
|
22146
|
+
example: ''
|
22147
|
+
type: string
|
22148
|
+
type:
|
22149
|
+
$ref: '#/components/schemas/OutputSchemaParametersType'
|
22150
|
+
value:
|
22151
|
+
description: The `OutputSchemaParameters` `value`.
|
22152
|
+
required:
|
22153
|
+
- name
|
22154
|
+
- type
|
22155
|
+
type: object
|
22156
|
+
OutputSchemaParametersType:
|
22157
|
+
description: The definition of `OutputSchemaParametersType` object.
|
22158
|
+
enum:
|
22159
|
+
- STRING
|
22160
|
+
- NUMBER
|
22161
|
+
- BOOLEAN
|
22162
|
+
- OBJECT
|
22163
|
+
- ARRAY_STRING
|
22164
|
+
- ARRAY_NUMBER
|
22165
|
+
- ARRAY_BOOLEAN
|
22166
|
+
- ARRAY_OBJECT
|
22167
|
+
example: STRING
|
22168
|
+
type: string
|
22169
|
+
x-enum-varnames:
|
22170
|
+
- STRING
|
22171
|
+
- NUMBER
|
22172
|
+
- BOOLEAN
|
22173
|
+
- OBJECT
|
22174
|
+
- ARRAY_STRING
|
22175
|
+
- ARRAY_NUMBER
|
22176
|
+
- ARRAY_BOOLEAN
|
22177
|
+
- ARRAY_OBJECT
|
20309
22178
|
Pagination:
|
20310
22179
|
description: Pagination object.
|
20311
22180
|
properties:
|
@@ -20318,6 +22187,19 @@ components:
|
|
20318
22187
|
format: int64
|
20319
22188
|
type: integer
|
20320
22189
|
type: object
|
22190
|
+
Parameter:
|
22191
|
+
description: The definition of `Parameter` object.
|
22192
|
+
properties:
|
22193
|
+
name:
|
22194
|
+
description: The `Parameter` `name`.
|
22195
|
+
example: ''
|
22196
|
+
type: string
|
22197
|
+
value:
|
22198
|
+
description: The `Parameter` `value`.
|
22199
|
+
required:
|
22200
|
+
- name
|
22201
|
+
- value
|
22202
|
+
type: object
|
20321
22203
|
PartialAPIKey:
|
20322
22204
|
description: Partial Datadog API key.
|
20323
22205
|
properties:
|
@@ -21098,34 +22980,12 @@ components:
|
|
21098
22980
|
$ref: '#/components/schemas/Deployment'
|
21099
22981
|
type: object
|
21100
22982
|
Query:
|
21101
|
-
description: A query used by an app. This can take the form of an external
|
21102
|
-
a data transformation, or a state variable
|
21103
|
-
|
21104
|
-
|
21105
|
-
|
21106
|
-
|
21107
|
-
$ref: '#/components/schemas/AppBuilderEvent'
|
21108
|
-
type: array
|
21109
|
-
id:
|
21110
|
-
description: The ID of the query.
|
21111
|
-
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
|
21112
|
-
format: uuid
|
21113
|
-
type: string
|
21114
|
-
name:
|
21115
|
-
description: The name of the query. The name must be unique within the app
|
21116
|
-
and is visible in the app editor.
|
21117
|
-
example: ''
|
21118
|
-
type: string
|
21119
|
-
properties:
|
21120
|
-
description: The properties of the query. The properties vary depending
|
21121
|
-
on the query type.
|
21122
|
-
type:
|
21123
|
-
$ref: '#/components/schemas/QueryType'
|
21124
|
-
required:
|
21125
|
-
- id
|
21126
|
-
- name
|
21127
|
-
- type
|
21128
|
-
type: object
|
22983
|
+
description: A data query used by an app. This can take the form of an external
|
22984
|
+
action, a data transformation, or a state variable.
|
22985
|
+
oneOf:
|
22986
|
+
- $ref: '#/components/schemas/ActionQuery'
|
22987
|
+
- $ref: '#/components/schemas/DataTransform'
|
22988
|
+
- $ref: '#/components/schemas/StateVariable'
|
21129
22989
|
QueryFormula:
|
21130
22990
|
description: A formula for calculation based on one or more queries.
|
21131
22991
|
properties:
|
@@ -21149,18 +23009,6 @@ components:
|
|
21149
23009
|
x-enum-varnames:
|
21150
23010
|
- ASC
|
21151
23011
|
- DESC
|
21152
|
-
QueryType:
|
21153
|
-
description: The query type.
|
21154
|
-
enum:
|
21155
|
-
- action
|
21156
|
-
- stateVariable
|
21157
|
-
- dataTransform
|
21158
|
-
example: action
|
21159
|
-
type: string
|
21160
|
-
x-enum-varnames:
|
21161
|
-
- ACTION
|
21162
|
-
- STATEVARIABLE
|
21163
|
-
- DATATRANSFORM
|
21164
23012
|
RUMAggregateBucketValue:
|
21165
23013
|
description: A bucket value, can be either a timeseries or a single value.
|
21166
23014
|
oneOf:
|
@@ -21930,6 +23778,24 @@ components:
|
|
21930
23778
|
from the other indexes
|
21931
23779
|
type: string
|
21932
23780
|
type: object
|
23781
|
+
ReadinessGate:
|
23782
|
+
description: Used to merge multiple branches into a single branch.
|
23783
|
+
properties:
|
23784
|
+
thresholdType:
|
23785
|
+
$ref: '#/components/schemas/ReadinessGateThresholdType'
|
23786
|
+
required:
|
23787
|
+
- thresholdType
|
23788
|
+
type: object
|
23789
|
+
ReadinessGateThresholdType:
|
23790
|
+
description: The definition of `ReadinessGateThresholdType` object.
|
23791
|
+
enum:
|
23792
|
+
- ANY
|
23793
|
+
- ALL
|
23794
|
+
example: ANY
|
23795
|
+
type: string
|
23796
|
+
x-enum-varnames:
|
23797
|
+
- ANY
|
23798
|
+
- ALL
|
21933
23799
|
RelationType:
|
21934
23800
|
description: Supported relation types.
|
21935
23801
|
enum:
|
@@ -22851,6 +24717,41 @@ components:
|
|
22851
24717
|
required:
|
22852
24718
|
- data
|
22853
24719
|
type: object
|
24720
|
+
RetryStrategy:
|
24721
|
+
description: The definition of `RetryStrategy` object.
|
24722
|
+
properties:
|
24723
|
+
kind:
|
24724
|
+
$ref: '#/components/schemas/RetryStrategyKind'
|
24725
|
+
linear:
|
24726
|
+
$ref: '#/components/schemas/RetryStrategyLinear'
|
24727
|
+
required:
|
24728
|
+
- kind
|
24729
|
+
type: object
|
24730
|
+
RetryStrategyKind:
|
24731
|
+
description: The definition of `RetryStrategyKind` object.
|
24732
|
+
enum:
|
24733
|
+
- RETRY_STRATEGY_LINEAR
|
24734
|
+
example: RETRY_STRATEGY_LINEAR
|
24735
|
+
type: string
|
24736
|
+
x-enum-varnames:
|
24737
|
+
- RETRY_STRATEGY_LINEAR
|
24738
|
+
RetryStrategyLinear:
|
24739
|
+
description: The definition of `RetryStrategyLinear` object.
|
24740
|
+
properties:
|
24741
|
+
interval:
|
24742
|
+
description: The `RetryStrategyLinear` `interval`. The expected format is
|
24743
|
+
the number of seconds ending with an s. For example, 1 day is 86400s
|
24744
|
+
example: ''
|
24745
|
+
type: string
|
24746
|
+
maxRetries:
|
24747
|
+
description: The `RetryStrategyLinear` `maxRetries`.
|
24748
|
+
example: 0.0
|
24749
|
+
format: double
|
24750
|
+
type: number
|
24751
|
+
required:
|
24752
|
+
- interval
|
24753
|
+
- maxRetries
|
24754
|
+
type: object
|
22854
24755
|
Role:
|
22855
24756
|
description: Role object returned by the API.
|
22856
24757
|
properties:
|
@@ -23184,8 +25085,7 @@ components:
|
|
23184
25085
|
x-enum-varnames:
|
23185
25086
|
- RULE
|
23186
25087
|
RuleTypes:
|
23187
|
-
description: Security rule types used
|
23188
|
-
generating notifications.
|
25088
|
+
description: Security rule types used as filters in security rules.
|
23189
25089
|
example:
|
23190
25090
|
- misconfiguration
|
23191
25091
|
- attack_path
|
@@ -23193,7 +25093,7 @@ components:
|
|
23193
25093
|
$ref: '#/components/schemas/RuleTypesItems'
|
23194
25094
|
type: array
|
23195
25095
|
RuleTypesItems:
|
23196
|
-
description: 'Security rule
|
25096
|
+
description: 'Security rule type which can be used in security rules.
|
23197
25097
|
|
23198
25098
|
Signal-based notification rules can filter signals based on rule types application_security,
|
23199
25099
|
log_detection,
|
@@ -23246,6 +25146,57 @@ components:
|
|
23246
25146
|
example: John Doe
|
23247
25147
|
type: string
|
23248
25148
|
type: object
|
25149
|
+
RuleVersionHistory:
|
25150
|
+
description: Response object containing the version history of a rule.
|
25151
|
+
properties:
|
25152
|
+
count:
|
25153
|
+
description: The number of rule versions.
|
25154
|
+
format: int32
|
25155
|
+
maximum: 2147483647
|
25156
|
+
type: integer
|
25157
|
+
data:
|
25158
|
+
additionalProperties:
|
25159
|
+
$ref: '#/components/schemas/RuleVersions'
|
25160
|
+
description: A rule version with a list of updates.
|
25161
|
+
description: The `RuleVersionHistory` `data`.
|
25162
|
+
type: object
|
25163
|
+
type: object
|
25164
|
+
RuleVersionUpdate:
|
25165
|
+
description: A change in a rule version.
|
25166
|
+
properties:
|
25167
|
+
change:
|
25168
|
+
description: The new value of the field.
|
25169
|
+
example: cloud_provider:aws
|
25170
|
+
type: string
|
25171
|
+
field:
|
25172
|
+
description: The field that was changed.
|
25173
|
+
example: Tags
|
25174
|
+
type: string
|
25175
|
+
type:
|
25176
|
+
$ref: '#/components/schemas/RuleVersionUpdateType'
|
25177
|
+
type: object
|
25178
|
+
RuleVersionUpdateType:
|
25179
|
+
description: The type of change.
|
25180
|
+
enum:
|
25181
|
+
- create
|
25182
|
+
- update
|
25183
|
+
- delete
|
25184
|
+
type: string
|
25185
|
+
x-enum-varnames:
|
25186
|
+
- CREATE
|
25187
|
+
- UPDATE
|
25188
|
+
- DELETE
|
25189
|
+
RuleVersions:
|
25190
|
+
description: A rule version with a list of updates.
|
25191
|
+
properties:
|
25192
|
+
changes:
|
25193
|
+
description: A list of changes.
|
25194
|
+
items:
|
25195
|
+
$ref: '#/components/schemas/RuleVersionUpdate'
|
25196
|
+
type: array
|
25197
|
+
rule:
|
25198
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleResponse'
|
25199
|
+
type: object
|
23249
25200
|
RumMetricCompute:
|
23250
25201
|
description: The compute rule to compute the rum-based metric.
|
23251
25202
|
properties:
|
@@ -23530,6 +25481,199 @@ components:
|
|
23530
25481
|
$ref: '#/components/schemas/RumMetricResponseData'
|
23531
25482
|
type: array
|
23532
25483
|
type: object
|
25484
|
+
RumRetentionFilterAttributes:
|
25485
|
+
description: The object describing attributes of a RUM retention filter.
|
25486
|
+
properties:
|
25487
|
+
enabled:
|
25488
|
+
$ref: '#/components/schemas/RumRetentionFilterEnabled'
|
25489
|
+
event_type:
|
25490
|
+
$ref: '#/components/schemas/RumRetentionFilterEventType'
|
25491
|
+
name:
|
25492
|
+
$ref: '#/components/schemas/RunRetentionFilterName'
|
25493
|
+
query:
|
25494
|
+
$ref: '#/components/schemas/RumRetentionFilterQuery'
|
25495
|
+
sample_rate:
|
25496
|
+
$ref: '#/components/schemas/RumRetentionFilterSampleRate'
|
25497
|
+
type: object
|
25498
|
+
RumRetentionFilterCreateAttributes:
|
25499
|
+
description: The object describing attributes of a RUM retention filter to create.
|
25500
|
+
properties:
|
25501
|
+
enabled:
|
25502
|
+
$ref: '#/components/schemas/RumRetentionFilterEnabled'
|
25503
|
+
event_type:
|
25504
|
+
$ref: '#/components/schemas/RumRetentionFilterEventType'
|
25505
|
+
name:
|
25506
|
+
$ref: '#/components/schemas/RunRetentionFilterName'
|
25507
|
+
query:
|
25508
|
+
$ref: '#/components/schemas/RumRetentionFilterQuery'
|
25509
|
+
sample_rate:
|
25510
|
+
$ref: '#/components/schemas/RumRetentionFilterSampleRate'
|
25511
|
+
required:
|
25512
|
+
- event_type
|
25513
|
+
- name
|
25514
|
+
- sample_rate
|
25515
|
+
type: object
|
25516
|
+
RumRetentionFilterCreateData:
|
25517
|
+
description: The new RUM retention filter properties to create.
|
25518
|
+
properties:
|
25519
|
+
attributes:
|
25520
|
+
$ref: '#/components/schemas/RumRetentionFilterCreateAttributes'
|
25521
|
+
type:
|
25522
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25523
|
+
required:
|
25524
|
+
- type
|
25525
|
+
- attributes
|
25526
|
+
type: object
|
25527
|
+
RumRetentionFilterCreateRequest:
|
25528
|
+
description: The RUM retention filter body to create.
|
25529
|
+
properties:
|
25530
|
+
data:
|
25531
|
+
$ref: '#/components/schemas/RumRetentionFilterCreateData'
|
25532
|
+
required:
|
25533
|
+
- data
|
25534
|
+
type: object
|
25535
|
+
RumRetentionFilterData:
|
25536
|
+
description: The RUM retention filter.
|
25537
|
+
properties:
|
25538
|
+
attributes:
|
25539
|
+
$ref: '#/components/schemas/RumRetentionFilterAttributes'
|
25540
|
+
id:
|
25541
|
+
$ref: '#/components/schemas/RumRetentionFilterID'
|
25542
|
+
type:
|
25543
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25544
|
+
type: object
|
25545
|
+
RumRetentionFilterEnabled:
|
25546
|
+
description: Whether the retention filter is enabled.
|
25547
|
+
example: true
|
25548
|
+
type: boolean
|
25549
|
+
RumRetentionFilterEventType:
|
25550
|
+
description: The type of RUM events to filter on.
|
25551
|
+
enum:
|
25552
|
+
- session
|
25553
|
+
- view
|
25554
|
+
- action
|
25555
|
+
- error
|
25556
|
+
- resource
|
25557
|
+
- long_task
|
25558
|
+
- vital
|
25559
|
+
example: session
|
25560
|
+
type: string
|
25561
|
+
x-enum-varnames:
|
25562
|
+
- SESSION
|
25563
|
+
- VIEW
|
25564
|
+
- ACTION
|
25565
|
+
- ERROR
|
25566
|
+
- RESOURCE
|
25567
|
+
- LONG_TASK
|
25568
|
+
- VITAL
|
25569
|
+
RumRetentionFilterID:
|
25570
|
+
description: ID of retention filter in UUID.
|
25571
|
+
example: 051601eb-54a0-abc0-03f9-cc02efa18892
|
25572
|
+
type: string
|
25573
|
+
RumRetentionFilterQuery:
|
25574
|
+
description: The query string for a RUM retention filter.
|
25575
|
+
example: '@session.has_replay:true'
|
25576
|
+
type: string
|
25577
|
+
RumRetentionFilterResponse:
|
25578
|
+
description: The RUM retention filter object.
|
25579
|
+
properties:
|
25580
|
+
data:
|
25581
|
+
$ref: '#/components/schemas/RumRetentionFilterData'
|
25582
|
+
type: object
|
25583
|
+
RumRetentionFilterSampleRate:
|
25584
|
+
description: The sample rate for a RUM retention filter, between 0 and 100.
|
25585
|
+
example: 25
|
25586
|
+
format: int64
|
25587
|
+
maximum: 100
|
25588
|
+
minimum: 0
|
25589
|
+
type: integer
|
25590
|
+
RumRetentionFilterType:
|
25591
|
+
default: retention_filters
|
25592
|
+
description: The type of the resource. The value should always be retention_filters.
|
25593
|
+
enum:
|
25594
|
+
- retention_filters
|
25595
|
+
example: retention_filters
|
25596
|
+
type: string
|
25597
|
+
x-enum-varnames:
|
25598
|
+
- RETENTION_FILTERS
|
25599
|
+
RumRetentionFilterUpdateAttributes:
|
25600
|
+
description: The object describing attributes of a RUM retention filter to update.
|
25601
|
+
properties:
|
25602
|
+
enabled:
|
25603
|
+
$ref: '#/components/schemas/RumRetentionFilterEnabled'
|
25604
|
+
event_type:
|
25605
|
+
$ref: '#/components/schemas/RumRetentionFilterEventType'
|
25606
|
+
name:
|
25607
|
+
$ref: '#/components/schemas/RunRetentionFilterName'
|
25608
|
+
query:
|
25609
|
+
$ref: '#/components/schemas/RumRetentionFilterQuery'
|
25610
|
+
sample_rate:
|
25611
|
+
$ref: '#/components/schemas/RumRetentionFilterSampleRate'
|
25612
|
+
type: object
|
25613
|
+
RumRetentionFilterUpdateData:
|
25614
|
+
description: The new RUM retention filter properties to update.
|
25615
|
+
properties:
|
25616
|
+
attributes:
|
25617
|
+
$ref: '#/components/schemas/RumRetentionFilterUpdateAttributes'
|
25618
|
+
id:
|
25619
|
+
$ref: '#/components/schemas/RumRetentionFilterID'
|
25620
|
+
type:
|
25621
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25622
|
+
required:
|
25623
|
+
- id
|
25624
|
+
- type
|
25625
|
+
- attributes
|
25626
|
+
type: object
|
25627
|
+
RumRetentionFilterUpdateRequest:
|
25628
|
+
description: The RUM retention filter body to update.
|
25629
|
+
properties:
|
25630
|
+
data:
|
25631
|
+
$ref: '#/components/schemas/RumRetentionFilterUpdateData'
|
25632
|
+
required:
|
25633
|
+
- data
|
25634
|
+
type: object
|
25635
|
+
RumRetentionFiltersOrderData:
|
25636
|
+
description: The RUM retention filter data for ordering.
|
25637
|
+
properties:
|
25638
|
+
id:
|
25639
|
+
$ref: '#/components/schemas/RumRetentionFilterID'
|
25640
|
+
type:
|
25641
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25642
|
+
required:
|
25643
|
+
- id
|
25644
|
+
- type
|
25645
|
+
type: object
|
25646
|
+
RumRetentionFiltersOrderRequest:
|
25647
|
+
description: 'The list of RUM retention filter IDs along with their corresponding
|
25648
|
+
type to reorder.
|
25649
|
+
|
25650
|
+
All retention filter IDs should be included in the list created for a RUM
|
25651
|
+
application.'
|
25652
|
+
properties:
|
25653
|
+
data:
|
25654
|
+
description: A list of RUM retention filter IDs along with type.
|
25655
|
+
items:
|
25656
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderData'
|
25657
|
+
type: array
|
25658
|
+
type: object
|
25659
|
+
RumRetentionFiltersOrderResponse:
|
25660
|
+
description: The list of RUM retention filter IDs along with type.
|
25661
|
+
properties:
|
25662
|
+
data:
|
25663
|
+
description: A list of RUM retention filter IDs along with type.
|
25664
|
+
items:
|
25665
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderData'
|
25666
|
+
type: array
|
25667
|
+
type: object
|
25668
|
+
RumRetentionFiltersResponse:
|
25669
|
+
description: All RUM retention filters for a RUM application.
|
25670
|
+
properties:
|
25671
|
+
data:
|
25672
|
+
description: A list of RUM retention filters.
|
25673
|
+
items:
|
25674
|
+
$ref: '#/components/schemas/RumRetentionFilterData'
|
25675
|
+
type: array
|
25676
|
+
type: object
|
23533
25677
|
RunHistoricalJobRequest:
|
23534
25678
|
description: Run a historical job request.
|
23535
25679
|
properties:
|
@@ -23562,6 +25706,10 @@ components:
|
|
23562
25706
|
type: string
|
23563
25707
|
x-enum-varnames:
|
23564
25708
|
- HISTORICALDETECTIONSJOBCREATE
|
25709
|
+
RunRetentionFilterName:
|
25710
|
+
description: The name of a RUM retention filter.
|
25711
|
+
example: Retention filter for session
|
25712
|
+
type: string
|
23565
25713
|
SAMLAssertionAttribute:
|
23566
25714
|
description: SAML assertion attribute.
|
23567
25715
|
properties:
|
@@ -23958,6 +26106,26 @@ components:
|
|
23958
26106
|
type:
|
23959
26107
|
$ref: '#/components/schemas/ScalarFormulaResponseType'
|
23960
26108
|
type: object
|
26109
|
+
ScheduleTrigger:
|
26110
|
+
description: Trigger a workflow VIA a Schedule. The workflow must be published.
|
26111
|
+
properties:
|
26112
|
+
rruleExpression:
|
26113
|
+
description: Recurrence rule expression for scheduling.
|
26114
|
+
example: ''
|
26115
|
+
type: string
|
26116
|
+
required:
|
26117
|
+
- rruleExpression
|
26118
|
+
type: object
|
26119
|
+
ScheduleTriggerWrapper:
|
26120
|
+
description: Schema for a Schedule-based trigger.
|
26121
|
+
properties:
|
26122
|
+
scheduleTrigger:
|
26123
|
+
$ref: '#/components/schemas/ScheduleTrigger'
|
26124
|
+
startStepNames:
|
26125
|
+
$ref: '#/components/schemas/StartStepNames'
|
26126
|
+
required:
|
26127
|
+
- scheduleTrigger
|
26128
|
+
type: object
|
23961
26129
|
ScorecardType:
|
23962
26130
|
default: scorecard
|
23963
26131
|
description: The JSON:API type for scorecard.
|
@@ -24243,6 +26411,11 @@ components:
|
|
24243
26411
|
SecurityMonitoringRuleCase:
|
24244
26412
|
description: Case when signal is generated.
|
24245
26413
|
properties:
|
26414
|
+
actions:
|
26415
|
+
description: Action to perform for each rule case.
|
26416
|
+
items:
|
26417
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseAction'
|
26418
|
+
type: array
|
24246
26419
|
condition:
|
24247
26420
|
description: 'A rule case contains logical operations (`>`,`>=`, `&&`, `||`)
|
24248
26421
|
to determine if a signal should be generated
|
@@ -24261,9 +26434,42 @@ components:
|
|
24261
26434
|
status:
|
24262
26435
|
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
24263
26436
|
type: object
|
26437
|
+
SecurityMonitoringRuleCaseAction:
|
26438
|
+
description: Action to perform when a signal is triggered. Only available for
|
26439
|
+
Application Security rule type.
|
26440
|
+
properties:
|
26441
|
+
options:
|
26442
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptions'
|
26443
|
+
type:
|
26444
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseActionType'
|
26445
|
+
type: object
|
26446
|
+
SecurityMonitoringRuleCaseActionOptions:
|
26447
|
+
description: Options for the rule action
|
26448
|
+
properties:
|
26449
|
+
duration:
|
26450
|
+
description: Duration of the action in seconds. 0 indicates no expiration.
|
26451
|
+
example: 0
|
26452
|
+
format: int64
|
26453
|
+
minimum: 0
|
26454
|
+
type: integer
|
26455
|
+
type: object
|
26456
|
+
SecurityMonitoringRuleCaseActionType:
|
26457
|
+
description: The action type.
|
26458
|
+
enum:
|
26459
|
+
- block_ip
|
26460
|
+
- block_user
|
26461
|
+
type: string
|
26462
|
+
x-enum-varnames:
|
26463
|
+
- BLOCK_IP
|
26464
|
+
- BLOCK_USER
|
24264
26465
|
SecurityMonitoringRuleCaseCreate:
|
24265
26466
|
description: Case when signal is generated.
|
24266
26467
|
properties:
|
26468
|
+
actions:
|
26469
|
+
description: Action to perform for each rule case.
|
26470
|
+
items:
|
26471
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseAction'
|
26472
|
+
type: array
|
24267
26473
|
condition:
|
24268
26474
|
description: 'A case contains logical operations (`>`,`>=`, `&&`, `||`)
|
24269
26475
|
to determine if a signal should be generated
|
@@ -24347,6 +26553,10 @@ components:
|
|
24347
26553
|
- 1800
|
24348
26554
|
- 3600
|
24349
26555
|
- 7200
|
26556
|
+
- 10800
|
26557
|
+
- 21600
|
26558
|
+
- 43200
|
26559
|
+
- 86400
|
24350
26560
|
format: int32
|
24351
26561
|
type: integer
|
24352
26562
|
x-enum-varnames:
|
@@ -24358,6 +26568,10 @@ components:
|
|
24358
26568
|
- THIRTY_MINUTES
|
24359
26569
|
- ONE_HOUR
|
24360
26570
|
- TWO_HOURS
|
26571
|
+
- THREE_HOURS
|
26572
|
+
- SIX_HOURS
|
26573
|
+
- TWELVE_HOURS
|
26574
|
+
- ONE_DAY
|
24361
26575
|
SecurityMonitoringRuleHardcodedEvaluatorType:
|
24362
26576
|
description: Hardcoded evaluator type.
|
24363
26577
|
enum:
|
@@ -24394,6 +26608,8 @@ components:
|
|
24394
26608
|
- 7200
|
24395
26609
|
- 10800
|
24396
26610
|
- 21600
|
26611
|
+
- 43200
|
26612
|
+
- 86400
|
24397
26613
|
format: int32
|
24398
26614
|
type: integer
|
24399
26615
|
x-enum-varnames:
|
@@ -24407,6 +26623,8 @@ components:
|
|
24407
26623
|
- TWO_HOURS
|
24408
26624
|
- THREE_HOURS
|
24409
26625
|
- SIX_HOURS
|
26626
|
+
- TWELVE_HOURS
|
26627
|
+
- ONE_DAY
|
24410
26628
|
SecurityMonitoringRuleMaxSignalDuration:
|
24411
26629
|
description: "A signal will \u201Cclose\u201D regardless of the query being
|
24412
26630
|
matched once the time exceeds the maximum duration.\nThis time is calculated
|
@@ -24725,6 +26943,15 @@ components:
|
|
24725
26943
|
items:
|
24726
26944
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
24727
26945
|
type: array
|
26946
|
+
groupSignalsBy:
|
26947
|
+
description: Additional grouping to perform on top of the existing groups
|
26948
|
+
in the query section. Must be a subset of the existing groups.
|
26949
|
+
example:
|
26950
|
+
- service
|
26951
|
+
items:
|
26952
|
+
description: Field to group by.
|
26953
|
+
type: string
|
26954
|
+
type: array
|
24728
26955
|
hasExtendedTitle:
|
24729
26956
|
description: Whether the notifications include the triggering group-by values
|
24730
26957
|
in their title.
|
@@ -25195,6 +27422,7 @@ components:
|
|
25195
27422
|
description: The version of the rule.
|
25196
27423
|
format: int64
|
25197
27424
|
type: integer
|
27425
|
+
type: object
|
25198
27426
|
SecurityMonitoringSignalRuleResponseQuery:
|
25199
27427
|
description: Query for matching rule on signals.
|
25200
27428
|
properties:
|
@@ -25430,6 +27658,15 @@ components:
|
|
25430
27658
|
items:
|
25431
27659
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25432
27660
|
type: array
|
27661
|
+
groupSignalsBy:
|
27662
|
+
description: Additional grouping to perform on top of the existing groups
|
27663
|
+
in the query section. Must be a subset of the existing groups.
|
27664
|
+
example:
|
27665
|
+
- service
|
27666
|
+
items:
|
27667
|
+
description: Field to group by.
|
27668
|
+
type: string
|
27669
|
+
type: array
|
25433
27670
|
hasExtendedTitle:
|
25434
27671
|
description: Whether the notifications include the triggering group-by values
|
25435
27672
|
in their title.
|
@@ -25502,6 +27739,15 @@ components:
|
|
25502
27739
|
items:
|
25503
27740
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25504
27741
|
type: array
|
27742
|
+
groupSignalsBy:
|
27743
|
+
description: Additional grouping to perform on top of the existing groups
|
27744
|
+
in the query section. Must be a subset of the existing groups.
|
27745
|
+
example:
|
27746
|
+
- service
|
27747
|
+
items:
|
27748
|
+
description: Field to group by.
|
27749
|
+
type: string
|
27750
|
+
type: array
|
25505
27751
|
hasExtendedTitle:
|
25506
27752
|
description: Whether the notifications include the triggering group-by values
|
25507
27753
|
in their title.
|
@@ -25643,6 +27889,15 @@ components:
|
|
25643
27889
|
items:
|
25644
27890
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25645
27891
|
type: array
|
27892
|
+
groupSignalsBy:
|
27893
|
+
description: Additional grouping to perform on top of the existing groups
|
27894
|
+
in the query section. Must be a subset of the existing groups.
|
27895
|
+
example:
|
27896
|
+
- service
|
27897
|
+
items:
|
27898
|
+
description: Field to group by.
|
27899
|
+
type: string
|
27900
|
+
type: array
|
25646
27901
|
hasExtendedTitle:
|
25647
27902
|
description: Whether the notifications include the triggering group-by values
|
25648
27903
|
in their title.
|
@@ -25704,6 +27959,7 @@ components:
|
|
25704
27959
|
description: The version of the rule.
|
25705
27960
|
format: int64
|
25706
27961
|
type: integer
|
27962
|
+
type: object
|
25707
27963
|
SecurityMonitoringStandardRuleTestPayload:
|
25708
27964
|
description: The payload of a rule to test
|
25709
27965
|
properties:
|
@@ -25720,6 +27976,15 @@ components:
|
|
25720
27976
|
items:
|
25721
27977
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25722
27978
|
type: array
|
27979
|
+
groupSignalsBy:
|
27980
|
+
description: Additional grouping to perform on top of the existing groups
|
27981
|
+
in the query section. Must be a subset of the existing groups.
|
27982
|
+
example:
|
27983
|
+
- service
|
27984
|
+
items:
|
27985
|
+
description: Field to group by.
|
27986
|
+
type: string
|
27987
|
+
type: array
|
25723
27988
|
hasExtendedTitle:
|
25724
27989
|
description: Whether the notifications include the triggering group-by values
|
25725
27990
|
in their title.
|
@@ -26125,6 +28390,23 @@ components:
|
|
26125
28390
|
nullable: true
|
26126
28391
|
type: string
|
26127
28392
|
type: object
|
28393
|
+
SecurityTrigger:
|
28394
|
+
description: Trigger a workflow VIA a Security Signal or Finding. For automatic
|
28395
|
+
triggering a handle must be configured and the workflow must be published.
|
28396
|
+
properties:
|
28397
|
+
rateLimit:
|
28398
|
+
$ref: '#/components/schemas/TriggerRateLimit'
|
28399
|
+
type: object
|
28400
|
+
SecurityTriggerWrapper:
|
28401
|
+
description: Schema for a Security-based trigger.
|
28402
|
+
properties:
|
28403
|
+
securityTrigger:
|
28404
|
+
$ref: '#/components/schemas/SecurityTrigger'
|
28405
|
+
startStepNames:
|
28406
|
+
$ref: '#/components/schemas/StartStepNames'
|
28407
|
+
required:
|
28408
|
+
- securityTrigger
|
28409
|
+
type: object
|
26128
28410
|
Selectors:
|
26129
28411
|
description: 'Selectors are used to filter security issues for which notifications
|
26130
28412
|
should be generated.
|
@@ -27880,6 +30162,17 @@ components:
|
|
27880
30162
|
- channel_name
|
27881
30163
|
- redirect_url
|
27882
30164
|
type: object
|
30165
|
+
SlackTriggerWrapper:
|
30166
|
+
description: Schema for a Slack-based trigger.
|
30167
|
+
properties:
|
30168
|
+
slackTrigger:
|
30169
|
+
description: Trigger a workflow VIA Slack. The workflow must be published.
|
30170
|
+
type: object
|
30171
|
+
startStepNames:
|
30172
|
+
$ref: '#/components/schemas/StartStepNames'
|
30173
|
+
required:
|
30174
|
+
- slackTrigger
|
30175
|
+
type: object
|
27883
30176
|
SloReportCreateRequest:
|
27884
30177
|
description: The SLO report request body.
|
27885
30178
|
properties:
|
@@ -28802,6 +31095,41 @@ components:
|
|
28802
31095
|
from the other indexes
|
28803
31096
|
type: string
|
28804
31097
|
type: object
|
31098
|
+
Spec:
|
31099
|
+
description: The spec defines what the workflow does.
|
31100
|
+
properties:
|
31101
|
+
annotations:
|
31102
|
+
description: A list of annotations used in the workflow. These are like
|
31103
|
+
sticky notes for your workflow!
|
31104
|
+
items:
|
31105
|
+
$ref: '#/components/schemas/Annotation'
|
31106
|
+
type: array
|
31107
|
+
connectionEnvs:
|
31108
|
+
description: A list of connections or connection groups used in the workflow.
|
31109
|
+
items:
|
31110
|
+
$ref: '#/components/schemas/ConnectionEnv'
|
31111
|
+
type: array
|
31112
|
+
handle:
|
31113
|
+
description: Unique identifier used to trigger workflows automatically in
|
31114
|
+
Datadog.
|
31115
|
+
type: string
|
31116
|
+
inputSchema:
|
31117
|
+
$ref: '#/components/schemas/InputSchema'
|
31118
|
+
outputSchema:
|
31119
|
+
$ref: '#/components/schemas/OutputSchema'
|
31120
|
+
steps:
|
31121
|
+
description: A `Step` is a sub-component of a workflow. Each `Step` performs
|
31122
|
+
an action.
|
31123
|
+
items:
|
31124
|
+
$ref: '#/components/schemas/Step'
|
31125
|
+
type: array
|
31126
|
+
triggers:
|
31127
|
+
description: The list of triggers that activate this workflow. At least
|
31128
|
+
one trigger is required, and each trigger type may appear at most once.
|
31129
|
+
items:
|
31130
|
+
$ref: '#/components/schemas/Trigger'
|
31131
|
+
type: array
|
31132
|
+
type: object
|
28805
31133
|
SpecVersion:
|
28806
31134
|
description: The version of the CycloneDX specification a BOM conforms to.
|
28807
31135
|
enum:
|
@@ -28820,6 +31148,14 @@ components:
|
|
28820
31148
|
- ONE_THREE
|
28821
31149
|
- ONE_FOUR
|
28822
31150
|
- ONE_FIVE
|
31151
|
+
StartStepNames:
|
31152
|
+
description: A list of steps that run first after a trigger fires.
|
31153
|
+
example:
|
31154
|
+
- ''
|
31155
|
+
items:
|
31156
|
+
description: The `StartStepNames` `items`.
|
31157
|
+
type: string
|
31158
|
+
type: array
|
28823
31159
|
State:
|
28824
31160
|
description: The state of the rule evaluation.
|
28825
31161
|
enum:
|
@@ -28832,6 +31168,104 @@ components:
|
|
28832
31168
|
- PASS
|
28833
31169
|
- FAIL
|
28834
31170
|
- SKIP
|
31171
|
+
StateVariable:
|
31172
|
+
description: A variable, which can be set and read by other components in the
|
31173
|
+
app.
|
31174
|
+
properties:
|
31175
|
+
id:
|
31176
|
+
description: The ID of the state variable.
|
31177
|
+
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
|
31178
|
+
format: uuid
|
31179
|
+
type: string
|
31180
|
+
name:
|
31181
|
+
description: A unique identifier for this state variable. This name is also
|
31182
|
+
used to access the variable's value throughout the app.
|
31183
|
+
example: ordersToSubmit
|
31184
|
+
type: string
|
31185
|
+
properties:
|
31186
|
+
$ref: '#/components/schemas/StateVariableProperties'
|
31187
|
+
type:
|
31188
|
+
$ref: '#/components/schemas/StateVariableType'
|
31189
|
+
required:
|
31190
|
+
- id
|
31191
|
+
- name
|
31192
|
+
- type
|
31193
|
+
- properties
|
31194
|
+
type: object
|
31195
|
+
StateVariableProperties:
|
31196
|
+
description: The properties of the state variable.
|
31197
|
+
properties:
|
31198
|
+
defaultValue:
|
31199
|
+
description: The default value of the state variable.
|
31200
|
+
example: ${['order_3145', 'order_4920']}
|
31201
|
+
type: object
|
31202
|
+
StateVariableType:
|
31203
|
+
default: stateVariable
|
31204
|
+
description: The state variable type.
|
31205
|
+
enum:
|
31206
|
+
- stateVariable
|
31207
|
+
example: stateVariable
|
31208
|
+
type: string
|
31209
|
+
x-enum-varnames:
|
31210
|
+
- STATEVARIABLE
|
31211
|
+
Step:
|
31212
|
+
description: A Step is a sub-component of a workflow. Each Step performs an
|
31213
|
+
action.
|
31214
|
+
properties:
|
31215
|
+
actionId:
|
31216
|
+
description: The unique identifier of an action.
|
31217
|
+
example: ''
|
31218
|
+
type: string
|
31219
|
+
completionGate:
|
31220
|
+
$ref: '#/components/schemas/CompletionGate'
|
31221
|
+
connectionLabel:
|
31222
|
+
description: The unique identifier of a connection defined in the spec.
|
31223
|
+
type: string
|
31224
|
+
display:
|
31225
|
+
$ref: '#/components/schemas/StepDisplay'
|
31226
|
+
errorHandlers:
|
31227
|
+
description: The `Step` `errorHandlers`.
|
31228
|
+
items:
|
31229
|
+
$ref: '#/components/schemas/ErrorHandler'
|
31230
|
+
type: array
|
31231
|
+
name:
|
31232
|
+
description: Name of the step.
|
31233
|
+
example: ''
|
31234
|
+
type: string
|
31235
|
+
outboundEdges:
|
31236
|
+
description: A list of subsequent actions to run.
|
31237
|
+
items:
|
31238
|
+
$ref: '#/components/schemas/OutboundEdge'
|
31239
|
+
type: array
|
31240
|
+
parameters:
|
31241
|
+
description: A list of inputs for an action.
|
31242
|
+
items:
|
31243
|
+
$ref: '#/components/schemas/Parameter'
|
31244
|
+
type: array
|
31245
|
+
readinessGate:
|
31246
|
+
$ref: '#/components/schemas/ReadinessGate'
|
31247
|
+
required:
|
31248
|
+
- name
|
31249
|
+
- actionId
|
31250
|
+
type: object
|
31251
|
+
StepDisplay:
|
31252
|
+
description: The definition of `StepDisplay` object.
|
31253
|
+
properties:
|
31254
|
+
bounds:
|
31255
|
+
$ref: '#/components/schemas/StepDisplayBounds'
|
31256
|
+
type: object
|
31257
|
+
StepDisplayBounds:
|
31258
|
+
description: The definition of `StepDisplayBounds` object.
|
31259
|
+
properties:
|
31260
|
+
x:
|
31261
|
+
description: The `bounds` `x`.
|
31262
|
+
format: double
|
31263
|
+
type: number
|
31264
|
+
y:
|
31265
|
+
description: The `bounds` `y`.
|
31266
|
+
format: double
|
31267
|
+
type: number
|
31268
|
+
type: object
|
28835
31269
|
TagsEventAttribute:
|
28836
31270
|
description: Array of tags associated with your event.
|
28837
31271
|
example:
|
@@ -29638,6 +32072,33 @@ components:
|
|
29638
32072
|
type: string
|
29639
32073
|
x-enum-varnames:
|
29640
32074
|
- SECRET
|
32075
|
+
Trigger:
|
32076
|
+
description: One of the triggers that can start the execution of a workflow.
|
32077
|
+
oneOf:
|
32078
|
+
- $ref: '#/components/schemas/APITriggerWrapper'
|
32079
|
+
- $ref: '#/components/schemas/AppTriggerWrapper'
|
32080
|
+
- $ref: '#/components/schemas/CaseTriggerWrapper'
|
32081
|
+
- $ref: '#/components/schemas/ChangeEventTriggerWrapper'
|
32082
|
+
- $ref: '#/components/schemas/DashboardTriggerWrapper'
|
32083
|
+
- $ref: '#/components/schemas/GithubWebhookTriggerWrapper'
|
32084
|
+
- $ref: '#/components/schemas/IncidentTriggerWrapper'
|
32085
|
+
- $ref: '#/components/schemas/MonitorTriggerWrapper'
|
32086
|
+
- $ref: '#/components/schemas/ScheduleTriggerWrapper'
|
32087
|
+
- $ref: '#/components/schemas/SecurityTriggerWrapper'
|
32088
|
+
- $ref: '#/components/schemas/SlackTriggerWrapper'
|
32089
|
+
- $ref: '#/components/schemas/WorkflowTriggerWrapper'
|
32090
|
+
TriggerRateLimit:
|
32091
|
+
description: Defines a rate limit for a trigger.
|
32092
|
+
properties:
|
32093
|
+
count:
|
32094
|
+
description: The `TriggerRateLimit` `count`.
|
32095
|
+
format: int64
|
32096
|
+
type: integer
|
32097
|
+
interval:
|
32098
|
+
description: The `TriggerRateLimit` `interval`. The expected format is the
|
32099
|
+
number of seconds ending with an s. For example, 1 day is 86400s
|
32100
|
+
type: string
|
32101
|
+
type: object
|
29641
32102
|
TriggerSource:
|
29642
32103
|
description: 'The type of security issues on which the rule applies. Notification
|
29643
32104
|
rules based on security signals need to use the trigger source "security_signals",
|
@@ -29927,6 +32388,81 @@ components:
|
|
29927
32388
|
type:
|
29928
32389
|
$ref: '#/components/schemas/RuleType'
|
29929
32390
|
type: object
|
32391
|
+
UpdateWorkflowRequest:
|
32392
|
+
description: A request object for updating an existing workflow.
|
32393
|
+
example:
|
32394
|
+
data:
|
32395
|
+
attributes:
|
32396
|
+
description: A sample workflow.
|
32397
|
+
name: Example Workflow
|
32398
|
+
published: true
|
32399
|
+
spec:
|
32400
|
+
annotations:
|
32401
|
+
- display:
|
32402
|
+
bounds:
|
32403
|
+
height: 150
|
32404
|
+
width: 300
|
32405
|
+
x: -375
|
32406
|
+
y: -0.5
|
32407
|
+
id: 99999999-9999-9999-9999-999999999999
|
32408
|
+
markdownTextAnnotation:
|
32409
|
+
text: Example annotation.
|
32410
|
+
connectionEnvs:
|
32411
|
+
- connections:
|
32412
|
+
- connectionId: 11111111-1111-1111-1111-111111111111
|
32413
|
+
label: INTEGRATION_DATADOG
|
32414
|
+
env: default
|
32415
|
+
handle: my-handle
|
32416
|
+
inputSchema:
|
32417
|
+
parameters:
|
32418
|
+
- defaultValue: default
|
32419
|
+
name: input
|
32420
|
+
type: STRING
|
32421
|
+
outputSchema:
|
32422
|
+
parameters:
|
32423
|
+
- name: output
|
32424
|
+
type: ARRAY_OBJECT
|
32425
|
+
value: '{{ Steps.Step1 }}'
|
32426
|
+
steps:
|
32427
|
+
- actionId: com.datadoghq.dd.monitor.listMonitors
|
32428
|
+
connectionLabel: INTEGRATION_DATADOG
|
32429
|
+
name: Step1
|
32430
|
+
outboundEdges:
|
32431
|
+
- branchName: main
|
32432
|
+
nextStepName: Step2
|
32433
|
+
parameters:
|
32434
|
+
- name: tags
|
32435
|
+
value: service:monitoring
|
32436
|
+
- actionId: com.datadoghq.core.noop
|
32437
|
+
name: Step2
|
32438
|
+
triggers:
|
32439
|
+
- monitorTrigger:
|
32440
|
+
rateLimit:
|
32441
|
+
count: 1
|
32442
|
+
interval: 3600s
|
32443
|
+
startStepNames:
|
32444
|
+
- Step1
|
32445
|
+
- githubWebhookTrigger: {}
|
32446
|
+
startStepNames:
|
32447
|
+
- Step1
|
32448
|
+
tags:
|
32449
|
+
- team:infra
|
32450
|
+
- service:monitoring
|
32451
|
+
- foo:bar
|
32452
|
+
id: 22222222-2222-2222-2222-222222222222
|
32453
|
+
type: workflows
|
32454
|
+
properties:
|
32455
|
+
data:
|
32456
|
+
$ref: '#/components/schemas/WorkflowDataUpdate'
|
32457
|
+
required:
|
32458
|
+
- data
|
32459
|
+
type: object
|
32460
|
+
UpdateWorkflowResponse:
|
32461
|
+
description: The response object after updating a workflow.
|
32462
|
+
properties:
|
32463
|
+
data:
|
32464
|
+
$ref: '#/components/schemas/WorkflowDataUpdate'
|
32465
|
+
type: object
|
29930
32466
|
UpsertCatalogEntityRequest:
|
29931
32467
|
description: Create or update entity request.
|
29932
32468
|
oneOf:
|
@@ -30978,6 +33514,134 @@ components:
|
|
30978
33514
|
- PAST_SIX_MONTHS
|
30979
33515
|
- PAST_ONE_YEAR
|
30980
33516
|
- ALERT
|
33517
|
+
WorkflowData:
|
33518
|
+
description: Data related to the workflow.
|
33519
|
+
properties:
|
33520
|
+
attributes:
|
33521
|
+
$ref: '#/components/schemas/WorkflowDataAttributes'
|
33522
|
+
id:
|
33523
|
+
description: The workflow identifier
|
33524
|
+
readOnly: true
|
33525
|
+
type: string
|
33526
|
+
relationships:
|
33527
|
+
$ref: '#/components/schemas/WorkflowDataRelationships'
|
33528
|
+
type:
|
33529
|
+
$ref: '#/components/schemas/WorkflowDataType'
|
33530
|
+
required:
|
33531
|
+
- type
|
33532
|
+
- attributes
|
33533
|
+
type: object
|
33534
|
+
WorkflowDataAttributes:
|
33535
|
+
description: The definition of `WorkflowDataAttributes` object.
|
33536
|
+
properties:
|
33537
|
+
createdAt:
|
33538
|
+
description: When the workflow was created.
|
33539
|
+
format: date-time
|
33540
|
+
readOnly: true
|
33541
|
+
type: string
|
33542
|
+
description:
|
33543
|
+
description: Description of the workflow.
|
33544
|
+
type: string
|
33545
|
+
name:
|
33546
|
+
description: Name of the workflow.
|
33547
|
+
example: ''
|
33548
|
+
type: string
|
33549
|
+
published:
|
33550
|
+
description: Set the workflow to published or unpublished. Workflows in
|
33551
|
+
an unpublished state will only be executable via manual runs. Automatic
|
33552
|
+
triggers such as Schedule will not execute the workflow until it is published.
|
33553
|
+
type: boolean
|
33554
|
+
spec:
|
33555
|
+
$ref: '#/components/schemas/Spec'
|
33556
|
+
tags:
|
33557
|
+
description: Tags of the workflow.
|
33558
|
+
items:
|
33559
|
+
type: string
|
33560
|
+
type: array
|
33561
|
+
updatedAt:
|
33562
|
+
description: When the workflow was last updated.
|
33563
|
+
format: date-time
|
33564
|
+
readOnly: true
|
33565
|
+
type: string
|
33566
|
+
webhookSecret:
|
33567
|
+
description: If a Webhook trigger is defined on this workflow, a webhookSecret
|
33568
|
+
is required and should be provided here.
|
33569
|
+
type: string
|
33570
|
+
writeOnly: true
|
33571
|
+
required:
|
33572
|
+
- name
|
33573
|
+
- spec
|
33574
|
+
type: object
|
33575
|
+
WorkflowDataRelationships:
|
33576
|
+
description: The definition of `WorkflowDataRelationships` object.
|
33577
|
+
properties:
|
33578
|
+
creator:
|
33579
|
+
$ref: '#/components/schemas/WorkflowUserRelationship'
|
33580
|
+
owner:
|
33581
|
+
$ref: '#/components/schemas/WorkflowUserRelationship'
|
33582
|
+
readOnly: true
|
33583
|
+
type: object
|
33584
|
+
WorkflowDataType:
|
33585
|
+
description: The definition of `WorkflowDataType` object.
|
33586
|
+
enum:
|
33587
|
+
- workflows
|
33588
|
+
example: workflows
|
33589
|
+
type: string
|
33590
|
+
x-enum-varnames:
|
33591
|
+
- WORKFLOWS
|
33592
|
+
WorkflowDataUpdate:
|
33593
|
+
description: Data related to the workflow being updated.
|
33594
|
+
properties:
|
33595
|
+
attributes:
|
33596
|
+
$ref: '#/components/schemas/WorkflowDataUpdateAttributes'
|
33597
|
+
id:
|
33598
|
+
description: The workflow identifier
|
33599
|
+
type: string
|
33600
|
+
relationships:
|
33601
|
+
$ref: '#/components/schemas/WorkflowDataRelationships'
|
33602
|
+
type:
|
33603
|
+
$ref: '#/components/schemas/WorkflowDataType'
|
33604
|
+
required:
|
33605
|
+
- type
|
33606
|
+
- attributes
|
33607
|
+
type: object
|
33608
|
+
WorkflowDataUpdateAttributes:
|
33609
|
+
description: The definition of `WorkflowDataUpdateAttributes` object.
|
33610
|
+
properties:
|
33611
|
+
createdAt:
|
33612
|
+
description: When the workflow was created.
|
33613
|
+
format: date-time
|
33614
|
+
readOnly: true
|
33615
|
+
type: string
|
33616
|
+
description:
|
33617
|
+
description: Description of the workflow.
|
33618
|
+
type: string
|
33619
|
+
name:
|
33620
|
+
description: Name of the workflow.
|
33621
|
+
type: string
|
33622
|
+
published:
|
33623
|
+
description: Set the workflow to published or unpublished. Workflows in
|
33624
|
+
an unpublished state will only be executable via manual runs. Automatic
|
33625
|
+
triggers such as Schedule will not execute the workflow until it is published.
|
33626
|
+
type: boolean
|
33627
|
+
spec:
|
33628
|
+
$ref: '#/components/schemas/Spec'
|
33629
|
+
tags:
|
33630
|
+
description: Tags of the workflow.
|
33631
|
+
items:
|
33632
|
+
type: string
|
33633
|
+
type: array
|
33634
|
+
updatedAt:
|
33635
|
+
description: When the workflow was last updated.
|
33636
|
+
format: date-time
|
33637
|
+
readOnly: true
|
33638
|
+
type: string
|
33639
|
+
webhookSecret:
|
33640
|
+
description: If a Webhook trigger is defined on this workflow, a webhookSecret
|
33641
|
+
is required and should be provided here.
|
33642
|
+
type: string
|
33643
|
+
writeOnly: true
|
33644
|
+
type: object
|
30981
33645
|
WorkflowInstanceCreateMeta:
|
30982
33646
|
description: Additional information for creating a workflow instance.
|
30983
33647
|
properties:
|
@@ -31044,6 +33708,45 @@ components:
|
|
31044
33708
|
format: int64
|
31045
33709
|
type: integer
|
31046
33710
|
type: object
|
33711
|
+
WorkflowTriggerWrapper:
|
33712
|
+
description: Schema for a Workflow-based trigger.
|
33713
|
+
properties:
|
33714
|
+
startStepNames:
|
33715
|
+
$ref: '#/components/schemas/StartStepNames'
|
33716
|
+
workflowTrigger:
|
33717
|
+
description: Trigger a workflow VIA the Datadog UI. Only required if no
|
33718
|
+
other trigger exists.
|
33719
|
+
type: object
|
33720
|
+
required:
|
33721
|
+
- workflowTrigger
|
33722
|
+
type: object
|
33723
|
+
WorkflowUserRelationship:
|
33724
|
+
description: The definition of `WorkflowUserRelationship` object.
|
33725
|
+
properties:
|
33726
|
+
data:
|
33727
|
+
$ref: '#/components/schemas/WorkflowUserRelationshipData'
|
33728
|
+
type: object
|
33729
|
+
WorkflowUserRelationshipData:
|
33730
|
+
description: The definition of `WorkflowUserRelationshipData` object.
|
33731
|
+
properties:
|
33732
|
+
id:
|
33733
|
+
description: The user identifier
|
33734
|
+
example: ''
|
33735
|
+
type: string
|
33736
|
+
type:
|
33737
|
+
$ref: '#/components/schemas/WorkflowUserRelationshipType'
|
33738
|
+
required:
|
33739
|
+
- type
|
33740
|
+
- id
|
33741
|
+
type: object
|
33742
|
+
WorkflowUserRelationshipType:
|
33743
|
+
description: The definition of `WorkflowUserRelationshipType` object.
|
33744
|
+
enum:
|
33745
|
+
- users
|
33746
|
+
example: users
|
33747
|
+
type: string
|
33748
|
+
x-enum-varnames:
|
33749
|
+
- USERS
|
31047
33750
|
WorklflowCancelInstanceResponse:
|
31048
33751
|
description: Information about the canceled instance.
|
31049
33752
|
properties:
|
@@ -31088,6 +33791,7 @@ components:
|
|
31088
33791
|
type: boolean
|
31089
33792
|
required:
|
31090
33793
|
- include_all
|
33794
|
+
type: object
|
31091
33795
|
XRayServicesIncludeOnly:
|
31092
33796
|
description: Include only these services. Defaults to `[]`.
|
31093
33797
|
nullable: true
|
@@ -31102,6 +33806,7 @@ components:
|
|
31102
33806
|
type: array
|
31103
33807
|
required:
|
31104
33808
|
- include_only
|
33809
|
+
type: object
|
31105
33810
|
XRayServicesList:
|
31106
33811
|
description: AWS X-Ray services to collect traces from. Defaults to `include_only`.
|
31107
33812
|
oneOf:
|
@@ -31120,6 +33825,9 @@ components:
|
|
31120
33825
|
apm_service_catalog_read: View service catalog and service definitions.
|
31121
33826
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
31122
33827
|
when those definitions are maintained by Datadog.
|
33828
|
+
appsec_vm_read: View infrastructure, application code, and library vulnerabilities.
|
33829
|
+
This does not restrict API or inventory SQL access to the vulnerability
|
33830
|
+
data source.
|
31123
33831
|
cases_read: View Cases.
|
31124
33832
|
cases_write: Create and update cases.
|
31125
33833
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
@@ -31403,7 +34111,7 @@ paths:
|
|
31403
34111
|
content:
|
31404
34112
|
application/json:
|
31405
34113
|
schema:
|
31406
|
-
$ref: '#/components/schemas/
|
34114
|
+
$ref: '#/components/schemas/AwsScanOptionsListResponse'
|
31407
34115
|
description: OK
|
31408
34116
|
'403':
|
31409
34117
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
@@ -31412,6 +34120,165 @@ paths:
|
|
31412
34120
|
summary: Get AWS Scan Options
|
31413
34121
|
tags:
|
31414
34122
|
- Agentless Scanning
|
34123
|
+
post:
|
34124
|
+
description: Activate Agentless scan options for an AWS account.
|
34125
|
+
operationId: CreateAwsScanOptions
|
34126
|
+
requestBody:
|
34127
|
+
content:
|
34128
|
+
application/json:
|
34129
|
+
schema:
|
34130
|
+
$ref: '#/components/schemas/AwsScanOptionsCreateRequest'
|
34131
|
+
description: The definition of the new scan options.
|
34132
|
+
required: true
|
34133
|
+
responses:
|
34134
|
+
'201':
|
34135
|
+
content:
|
34136
|
+
application/json:
|
34137
|
+
schema:
|
34138
|
+
$ref: '#/components/schemas/AwsScanOptionsResponse'
|
34139
|
+
description: Agentless scan options enabled successfully.
|
34140
|
+
'400':
|
34141
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34142
|
+
'403':
|
34143
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34144
|
+
'409':
|
34145
|
+
$ref: '#/components/responses/ConflictResponse'
|
34146
|
+
'429':
|
34147
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34148
|
+
summary: Post AWS Scan Options
|
34149
|
+
tags:
|
34150
|
+
- Agentless Scanning
|
34151
|
+
x-codegen-request-body-name: body
|
34152
|
+
/api/v2/agentless_scanning/accounts/aws/{account_id}:
|
34153
|
+
delete:
|
34154
|
+
description: Delete Agentless scan options for an AWS account.
|
34155
|
+
operationId: DeleteAwsScanOptions
|
34156
|
+
parameters:
|
34157
|
+
- $ref: '#/components/parameters/AwsAccountId'
|
34158
|
+
responses:
|
34159
|
+
'204':
|
34160
|
+
description: No Content
|
34161
|
+
'400':
|
34162
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34163
|
+
'403':
|
34164
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34165
|
+
'404':
|
34166
|
+
$ref: '#/components/responses/NotFoundResponse'
|
34167
|
+
'429':
|
34168
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34169
|
+
summary: Delete AWS Scan Options
|
34170
|
+
tags:
|
34171
|
+
- Agentless Scanning
|
34172
|
+
patch:
|
34173
|
+
description: Update the Agentless scan options for an activated account.
|
34174
|
+
operationId: UpdateAwsScanOptions
|
34175
|
+
parameters:
|
34176
|
+
- $ref: '#/components/parameters/AwsAccountId'
|
34177
|
+
requestBody:
|
34178
|
+
content:
|
34179
|
+
application/json:
|
34180
|
+
schema:
|
34181
|
+
$ref: '#/components/schemas/AwsScanOptionsUpdateRequest'
|
34182
|
+
description: New definition of the scan options.
|
34183
|
+
required: true
|
34184
|
+
responses:
|
34185
|
+
'204':
|
34186
|
+
description: No Content
|
34187
|
+
'400':
|
34188
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34189
|
+
'403':
|
34190
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34191
|
+
'404':
|
34192
|
+
$ref: '#/components/responses/NotFoundResponse'
|
34193
|
+
'429':
|
34194
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34195
|
+
summary: Patch AWS Scan Options
|
34196
|
+
tags:
|
34197
|
+
- Agentless Scanning
|
34198
|
+
x-codegen-request-body-name: body
|
34199
|
+
/api/v2/agentless_scanning/ondemand/aws:
|
34200
|
+
get:
|
34201
|
+
description: Fetches the most recent 1000 AWS on demand tasks.
|
34202
|
+
operationId: ListAwsOnDemandTasks
|
34203
|
+
responses:
|
34204
|
+
'200':
|
34205
|
+
content:
|
34206
|
+
application/json:
|
34207
|
+
schema:
|
34208
|
+
$ref: '#/components/schemas/AwsOnDemandListResponse'
|
34209
|
+
description: OK
|
34210
|
+
'403':
|
34211
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34212
|
+
'429':
|
34213
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34214
|
+
summary: Get AWS On Demand tasks
|
34215
|
+
tags:
|
34216
|
+
- Agentless Scanning
|
34217
|
+
x-permission:
|
34218
|
+
operator: OR
|
34219
|
+
permissions:
|
34220
|
+
- security_monitoring_findings_read
|
34221
|
+
post:
|
34222
|
+
description: Trigger the scan of an AWS resource with a high priority. Agentless
|
34223
|
+
scanning must be activated for the AWS account containing the resource to
|
34224
|
+
scan.
|
34225
|
+
operationId: CreateAwsOnDemandTask
|
34226
|
+
requestBody:
|
34227
|
+
content:
|
34228
|
+
application/json:
|
34229
|
+
schema:
|
34230
|
+
$ref: '#/components/schemas/AwsOnDemandCreateRequest'
|
34231
|
+
description: The definition of the on demand task.
|
34232
|
+
required: true
|
34233
|
+
responses:
|
34234
|
+
'201':
|
34235
|
+
content:
|
34236
|
+
application/json:
|
34237
|
+
schema:
|
34238
|
+
$ref: '#/components/schemas/AwsOnDemandResponse'
|
34239
|
+
description: AWS on demand task created successfully.
|
34240
|
+
'400':
|
34241
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34242
|
+
'403':
|
34243
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34244
|
+
'429':
|
34245
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34246
|
+
summary: Post an AWS on demand task
|
34247
|
+
tags:
|
34248
|
+
- Agentless Scanning
|
34249
|
+
x-codegen-request-body-name: body
|
34250
|
+
x-permission:
|
34251
|
+
operator: OR
|
34252
|
+
permissions:
|
34253
|
+
- security_monitoring_findings_write
|
34254
|
+
/api/v2/agentless_scanning/ondemand/aws/{task_id}:
|
34255
|
+
get:
|
34256
|
+
description: Fetch the data of a specific on demand task.
|
34257
|
+
operationId: GetAwsOnDemandTask
|
34258
|
+
parameters:
|
34259
|
+
- $ref: '#/components/parameters/OnDemandTaskId'
|
34260
|
+
responses:
|
34261
|
+
'200':
|
34262
|
+
content:
|
34263
|
+
application/json:
|
34264
|
+
schema:
|
34265
|
+
$ref: '#/components/schemas/AwsOnDemandResponse'
|
34266
|
+
description: OK.
|
34267
|
+
'400':
|
34268
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34269
|
+
'403':
|
34270
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34271
|
+
'404':
|
34272
|
+
$ref: '#/components/responses/NotFoundResponse'
|
34273
|
+
'429':
|
34274
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34275
|
+
summary: Get AWS On Demand task by id
|
34276
|
+
tags:
|
34277
|
+
- Agentless Scanning
|
34278
|
+
x-permission:
|
34279
|
+
operator: OR
|
34280
|
+
permissions:
|
34281
|
+
- security_monitoring_findings_read
|
31415
34282
|
/api/v2/api_keys:
|
31416
34283
|
get:
|
31417
34284
|
description: List all API keys available for your account.
|
@@ -31606,6 +34473,7 @@ paths:
|
|
31606
34473
|
- api_keys_write
|
31607
34474
|
/api/v2/apicatalog/api:
|
31608
34475
|
get:
|
34476
|
+
deprecated: true
|
31609
34477
|
description: List APIs and their IDs.
|
31610
34478
|
operationId: ListAPIs
|
31611
34479
|
parameters:
|
@@ -31667,11 +34535,10 @@ paths:
|
|
31667
34535
|
operator: OR
|
31668
34536
|
permissions:
|
31669
34537
|
- apm_api_catalog_read
|
31670
|
-
x-unstable: '**Note**: This endpoint is
|
31671
|
-
|
31672
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
34538
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31673
34539
|
/api/v2/apicatalog/api/{id}:
|
31674
34540
|
delete:
|
34541
|
+
deprecated: true
|
31675
34542
|
description: Delete a specific API by ID.
|
31676
34543
|
operationId: DeleteOpenAPI
|
31677
34544
|
parameters:
|
@@ -31716,11 +34583,10 @@ paths:
|
|
31716
34583
|
operator: OR
|
31717
34584
|
permissions:
|
31718
34585
|
- apm_api_catalog_write
|
31719
|
-
x-unstable: '**Note**: This endpoint is
|
31720
|
-
|
31721
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
34586
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31722
34587
|
/api/v2/apicatalog/api/{id}/openapi:
|
31723
34588
|
get:
|
34589
|
+
deprecated: true
|
31724
34590
|
description: Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
31725
34591
|
format file.
|
31726
34592
|
operationId: GetOpenAPI
|
@@ -31771,10 +34637,9 @@ paths:
|
|
31771
34637
|
operator: OR
|
31772
34638
|
permissions:
|
31773
34639
|
- apm_api_catalog_read
|
31774
|
-
x-unstable: '**Note**: This endpoint is
|
31775
|
-
|
31776
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
34640
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31777
34641
|
put:
|
34642
|
+
deprecated: true
|
31778
34643
|
description: 'Update information about a specific API. The given content will
|
31779
34644
|
replace all API content of the given ID.
|
31780
34645
|
|
@@ -31835,11 +34700,10 @@ paths:
|
|
31835
34700
|
operator: OR
|
31836
34701
|
permissions:
|
31837
34702
|
- apm_api_catalog_write
|
31838
|
-
x-unstable: '**Note**: This endpoint is
|
31839
|
-
|
31840
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
34703
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31841
34704
|
/api/v2/apicatalog/openapi:
|
31842
34705
|
post:
|
34706
|
+
deprecated: true
|
31843
34707
|
description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
31844
34708
|
specification given.
|
31845
34709
|
|
@@ -31891,9 +34755,7 @@ paths:
|
|
31891
34755
|
operator: OR
|
31892
34756
|
permissions:
|
31893
34757
|
- apm_api_catalog_write
|
31894
|
-
x-unstable: '**Note**: This endpoint is
|
31895
|
-
|
31896
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
34758
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31897
34759
|
/api/v2/apm/config/metrics:
|
31898
34760
|
get:
|
31899
34761
|
description: Get the list of configured span-based metrics with their definitions.
|
@@ -32266,8 +35128,6 @@ paths:
|
|
32266
35128
|
operator: OR
|
32267
35129
|
permissions:
|
32268
35130
|
- apps_write
|
32269
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32270
|
-
and might change at any time.'
|
32271
35131
|
get:
|
32272
35132
|
description: List all apps, with optional filters and sorting. This endpoint
|
32273
35133
|
is paginated. Only basic app information such as the app ID, name, and description
|
@@ -32376,8 +35236,6 @@ paths:
|
|
32376
35236
|
operator: OR
|
32377
35237
|
permissions:
|
32378
35238
|
- apps_run
|
32379
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32380
|
-
and might change at any time.'
|
32381
35239
|
post:
|
32382
35240
|
description: Create a new app, returning the app ID.
|
32383
35241
|
operationId: CreateApp
|
@@ -32417,8 +35275,6 @@ paths:
|
|
32417
35275
|
- apps_write
|
32418
35276
|
- connections_resolve
|
32419
35277
|
- workflows_run
|
32420
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32421
|
-
and might change at any time.'
|
32422
35278
|
/api/v2/app-builder/apps/{app_id}:
|
32423
35279
|
delete:
|
32424
35280
|
description: Delete a single app.
|
@@ -32472,8 +35328,6 @@ paths:
|
|
32472
35328
|
operator: OR
|
32473
35329
|
permissions:
|
32474
35330
|
- apps_write
|
32475
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32476
|
-
and might change at any time.'
|
32477
35331
|
get:
|
32478
35332
|
description: Get the full definition of an app.
|
32479
35333
|
operationId: GetApp
|
@@ -32520,6 +35374,12 @@ paths:
|
|
32520
35374
|
schema:
|
32521
35375
|
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
32522
35376
|
description: Not Found
|
35377
|
+
'410':
|
35378
|
+
content:
|
35379
|
+
application/json:
|
35380
|
+
schema:
|
35381
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
35382
|
+
description: Gone
|
32523
35383
|
'429':
|
32524
35384
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
32525
35385
|
summary: Get App
|
@@ -32530,8 +35390,6 @@ paths:
|
|
32530
35390
|
permissions:
|
32531
35391
|
- apps_run
|
32532
35392
|
- connections_read
|
32533
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32534
|
-
and might change at any time.'
|
32535
35393
|
patch:
|
32536
35394
|
description: Update an existing app. This creates a new version of the app.
|
32537
35395
|
operationId: UpdateApp
|
@@ -32580,8 +35438,6 @@ paths:
|
|
32580
35438
|
- apps_write
|
32581
35439
|
- connections_resolve
|
32582
35440
|
- workflows_run
|
32583
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32584
|
-
and might change at any time.'
|
32585
35441
|
/api/v2/app-builder/apps/{app_id}/deployment:
|
32586
35442
|
delete:
|
32587
35443
|
description: Unpublish an app, removing the live version of the app. Unpublishing
|
@@ -32632,8 +35488,6 @@ paths:
|
|
32632
35488
|
operator: OR
|
32633
35489
|
permissions:
|
32634
35490
|
- apps_write
|
32635
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32636
|
-
and might change at any time.'
|
32637
35491
|
post:
|
32638
35492
|
description: Publish an app for use by other users. To ensure the app is accessible
|
32639
35493
|
to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/)
|
@@ -32682,8 +35536,6 @@ paths:
|
|
32682
35536
|
operator: OR
|
32683
35537
|
permissions:
|
32684
35538
|
- apps_write
|
32685
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32686
|
-
and might change at any time.'
|
32687
35539
|
/api/v2/application_keys:
|
32688
35540
|
get:
|
32689
35541
|
description: List all application keys available for your org
|
@@ -33696,7 +36548,7 @@ paths:
|
|
33696
36548
|
- Software Catalog
|
33697
36549
|
x-pagination:
|
33698
36550
|
limitParam: page[limit]
|
33699
|
-
|
36551
|
+
pageOffsetParam: page[offset]
|
33700
36552
|
resultsPath: data
|
33701
36553
|
post:
|
33702
36554
|
description: Create or update entities in Software Catalog.
|
@@ -34445,7 +37297,8 @@ paths:
|
|
34445
37297
|
permissions:
|
34446
37298
|
- cloud_cost_management_write
|
34447
37299
|
patch:
|
34448
|
-
description: Update the status
|
37300
|
+
description: Update the status (active/archived) and/or account filtering configuration
|
37301
|
+
of an AWS CUR config.
|
34449
37302
|
operationId: UpdateCostAWSCURConfig
|
34450
37303
|
parameters:
|
34451
37304
|
- $ref: '#/components/parameters/CloudAccountID'
|
@@ -40197,7 +43050,7 @@ paths:
|
|
40197
43050
|
required: false
|
40198
43051
|
schema:
|
40199
43052
|
type: boolean
|
40200
|
-
- description: '(
|
43053
|
+
- description: '(Preview) Filter custom metrics that have or have not been queried
|
40201
43054
|
in the specified window[seconds].
|
40202
43055
|
|
40203
43056
|
If no window is provided or the window is less than 2 hours, a default of
|
@@ -40218,6 +43071,14 @@ paths:
|
|
40218
43071
|
required: false
|
40219
43072
|
schema:
|
40220
43073
|
type: string
|
43074
|
+
- description: (Preview) Filter metrics that are used in dashboards, monitors,
|
43075
|
+
notebooks, SLOs.
|
43076
|
+
example: true
|
43077
|
+
in: query
|
43078
|
+
name: filter[related_assets]
|
43079
|
+
required: false
|
43080
|
+
schema:
|
43081
|
+
type: boolean
|
40221
43082
|
- description: 'The number of seconds of look back (from now) to apply to a
|
40222
43083
|
filter[tag] or filter[queried] query.
|
40223
43084
|
|
@@ -42100,6 +44961,285 @@ paths:
|
|
42100
44961
|
operator: OR
|
42101
44962
|
permissions:
|
42102
44963
|
- timeseries_query
|
44964
|
+
/api/v2/remote_config/products/asm/waf/custom_rules:
|
44965
|
+
get:
|
44966
|
+
description: Retrieve a list of WAF custom rule.
|
44967
|
+
operationId: ListApplicationSecurityWAFCustomRules
|
44968
|
+
responses:
|
44969
|
+
'200':
|
44970
|
+
content:
|
44971
|
+
application/json:
|
44972
|
+
schema:
|
44973
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleListResponse'
|
44974
|
+
description: OK
|
44975
|
+
'403':
|
44976
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
44977
|
+
'429':
|
44978
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
44979
|
+
summary: List all WAF custom rules
|
44980
|
+
tags:
|
44981
|
+
- Application Security
|
44982
|
+
post:
|
44983
|
+
description: Create a new WAF custom rule with the given parameters.
|
44984
|
+
operationId: CreateApplicationSecurityWafCustomRule
|
44985
|
+
requestBody:
|
44986
|
+
content:
|
44987
|
+
application/json:
|
44988
|
+
schema:
|
44989
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateRequest'
|
44990
|
+
description: The definition of the new WAF Custom Rule.
|
44991
|
+
required: true
|
44992
|
+
responses:
|
44993
|
+
'201':
|
44994
|
+
content:
|
44995
|
+
application/json:
|
44996
|
+
schema:
|
44997
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
|
44998
|
+
description: Created
|
44999
|
+
'400':
|
45000
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45001
|
+
'403':
|
45002
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45003
|
+
'409':
|
45004
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45005
|
+
'429':
|
45006
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45007
|
+
summary: Create a WAF custom rule
|
45008
|
+
tags:
|
45009
|
+
- Application Security
|
45010
|
+
x-codegen-request-body-name: body
|
45011
|
+
/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}:
|
45012
|
+
delete:
|
45013
|
+
description: Delete a specific WAF custom rule.
|
45014
|
+
operationId: DeleteApplicationSecurityWafCustomRule
|
45015
|
+
parameters:
|
45016
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam'
|
45017
|
+
responses:
|
45018
|
+
'204':
|
45019
|
+
description: No Content
|
45020
|
+
'403':
|
45021
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45022
|
+
'404':
|
45023
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45024
|
+
'409':
|
45025
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45026
|
+
'429':
|
45027
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45028
|
+
summary: Delete a WAF Custom Rule
|
45029
|
+
tags:
|
45030
|
+
- Application Security
|
45031
|
+
x-terraform-resource: appsec_waf_custom_rule
|
45032
|
+
get:
|
45033
|
+
description: Retrieve a WAF custom rule by ID.
|
45034
|
+
operationId: GetApplicationSecurityWafCustomRule
|
45035
|
+
parameters:
|
45036
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam'
|
45037
|
+
responses:
|
45038
|
+
'200':
|
45039
|
+
content:
|
45040
|
+
application/json:
|
45041
|
+
schema:
|
45042
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
|
45043
|
+
description: OK
|
45044
|
+
'403':
|
45045
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45046
|
+
'429':
|
45047
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45048
|
+
summary: Get a WAF custom rule
|
45049
|
+
tags:
|
45050
|
+
- Application Security
|
45051
|
+
x-terraform-resource: appsec_waf_custom_rule
|
45052
|
+
put:
|
45053
|
+
description: 'Update a specific WAF custom Rule.
|
45054
|
+
|
45055
|
+
Returns the Custom Rule object when the request is successful.'
|
45056
|
+
operationId: UpdateApplicationSecurityWafCustomRule
|
45057
|
+
parameters:
|
45058
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam'
|
45059
|
+
requestBody:
|
45060
|
+
content:
|
45061
|
+
application/json:
|
45062
|
+
schema:
|
45063
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateRequest'
|
45064
|
+
description: New definition of the WAF Custom Rule.
|
45065
|
+
required: true
|
45066
|
+
responses:
|
45067
|
+
'200':
|
45068
|
+
content:
|
45069
|
+
application/json:
|
45070
|
+
schema:
|
45071
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
|
45072
|
+
description: OK
|
45073
|
+
'400':
|
45074
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45075
|
+
'403':
|
45076
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45077
|
+
'404':
|
45078
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45079
|
+
'409':
|
45080
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45081
|
+
'429':
|
45082
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45083
|
+
summary: Update a WAF Custom Rule
|
45084
|
+
tags:
|
45085
|
+
- Application Security
|
45086
|
+
x-codegen-request-body-name: body
|
45087
|
+
x-terraform-resource: appsec_waf_custom_rule
|
45088
|
+
/api/v2/remote_config/products/asm/waf/exclusion_filters:
|
45089
|
+
get:
|
45090
|
+
description: Retrieve a list of WAF exclusion filters.
|
45091
|
+
operationId: ListApplicationSecurityWafExclusionFilters
|
45092
|
+
responses:
|
45093
|
+
'200':
|
45094
|
+
content:
|
45095
|
+
application/json:
|
45096
|
+
schema:
|
45097
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse'
|
45098
|
+
description: OK
|
45099
|
+
'403':
|
45100
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45101
|
+
'429':
|
45102
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45103
|
+
summary: List all WAF exclusion filters
|
45104
|
+
tags:
|
45105
|
+
- Application Security
|
45106
|
+
x-permission:
|
45107
|
+
operator: AND
|
45108
|
+
permissions:
|
45109
|
+
- appsec_protect_read
|
45110
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45111
|
+
post:
|
45112
|
+
description: 'Create a new WAF exclusion filter with the given parameters.
|
45113
|
+
|
45114
|
+
|
45115
|
+
A request matched by an exclusion filter will be ignored by the Application
|
45116
|
+
Security WAF product.
|
45117
|
+
|
45118
|
+
Go to https://app.datadoghq.com/security/appsec/passlist to review existing
|
45119
|
+
exclusion filters (also called passlist entries).'
|
45120
|
+
operationId: CreateApplicationSecurityWafExclusionFilter
|
45121
|
+
requestBody:
|
45122
|
+
content:
|
45123
|
+
application/json:
|
45124
|
+
schema:
|
45125
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateRequest'
|
45126
|
+
description: The definition of the new WAF exclusion filter.
|
45127
|
+
required: true
|
45128
|
+
responses:
|
45129
|
+
'200':
|
45130
|
+
content:
|
45131
|
+
application/json:
|
45132
|
+
schema:
|
45133
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
|
45134
|
+
description: OK
|
45135
|
+
'400':
|
45136
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45137
|
+
'403':
|
45138
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45139
|
+
'409':
|
45140
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45141
|
+
'429':
|
45142
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45143
|
+
summary: Create a WAF exclusion filter
|
45144
|
+
tags:
|
45145
|
+
- Application Security
|
45146
|
+
x-codegen-request-body-name: body
|
45147
|
+
x-permission:
|
45148
|
+
operator: AND
|
45149
|
+
permissions:
|
45150
|
+
- appsec_protect_write
|
45151
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45152
|
+
/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}:
|
45153
|
+
delete:
|
45154
|
+
description: Delete a specific WAF exclusion filter using its identifier.
|
45155
|
+
operationId: DeleteApplicationSecurityWafExclusionFilter
|
45156
|
+
parameters:
|
45157
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID'
|
45158
|
+
responses:
|
45159
|
+
'204':
|
45160
|
+
description: OK
|
45161
|
+
'403':
|
45162
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45163
|
+
'404':
|
45164
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45165
|
+
'409':
|
45166
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45167
|
+
'429':
|
45168
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45169
|
+
summary: Delete a WAF exclusion filter
|
45170
|
+
tags:
|
45171
|
+
- Application Security
|
45172
|
+
x-permission:
|
45173
|
+
operator: AND
|
45174
|
+
permissions:
|
45175
|
+
- appsec_protect_write
|
45176
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45177
|
+
get:
|
45178
|
+
description: Retrieve a specific WAF exclusion filter using its identifier.
|
45179
|
+
operationId: GetApplicationSecurityWafExclusionFilter
|
45180
|
+
parameters:
|
45181
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID'
|
45182
|
+
responses:
|
45183
|
+
'200':
|
45184
|
+
content:
|
45185
|
+
application/json:
|
45186
|
+
schema:
|
45187
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
|
45188
|
+
description: OK
|
45189
|
+
'403':
|
45190
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45191
|
+
'404':
|
45192
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45193
|
+
'429':
|
45194
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45195
|
+
summary: Get a WAF exclusion filter
|
45196
|
+
tags:
|
45197
|
+
- Application Security
|
45198
|
+
x-permission:
|
45199
|
+
operator: AND
|
45200
|
+
permissions:
|
45201
|
+
- appsec_protect_read
|
45202
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45203
|
+
put:
|
45204
|
+
description: 'Update a specific WAF exclusion filter using its identifier.
|
45205
|
+
|
45206
|
+
Returns the exclusion filter object when the request is successful.'
|
45207
|
+
operationId: UpdateApplicationSecurityWafExclusionFilter
|
45208
|
+
parameters:
|
45209
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID'
|
45210
|
+
requestBody:
|
45211
|
+
content:
|
45212
|
+
application/json:
|
45213
|
+
schema:
|
45214
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateRequest'
|
45215
|
+
description: The exclusion filter to update.
|
45216
|
+
required: true
|
45217
|
+
responses:
|
45218
|
+
'200':
|
45219
|
+
content:
|
45220
|
+
application/json:
|
45221
|
+
schema:
|
45222
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
|
45223
|
+
description: OK
|
45224
|
+
'400':
|
45225
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45226
|
+
'403':
|
45227
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45228
|
+
'404':
|
45229
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45230
|
+
'409':
|
45231
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45232
|
+
'429':
|
45233
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45234
|
+
summary: Update a WAF exclusion filter
|
45235
|
+
tags:
|
45236
|
+
- Application Security
|
45237
|
+
x-codegen-request-body-name: body
|
45238
|
+
x-permission:
|
45239
|
+
operator: AND
|
45240
|
+
permissions:
|
45241
|
+
- appsec_protect_write
|
45242
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
42103
45243
|
/api/v2/remote_config/products/cws/agent_rules:
|
42104
45244
|
get:
|
42105
45245
|
description: Get the list of Cloud Security Management Threats Agent rules.
|
@@ -43077,6 +46217,167 @@ paths:
|
|
43077
46217
|
operator: OR
|
43078
46218
|
permissions:
|
43079
46219
|
- rum_apps_write
|
46220
|
+
/api/v2/rum/applications/{app_id}/relationships/retention_filters:
|
46221
|
+
patch:
|
46222
|
+
description: 'Order RUM retention filters for a RUM application.
|
46223
|
+
|
46224
|
+
Returns RUM retention filter objects without attributes from the request body
|
46225
|
+
when the request is successful.'
|
46226
|
+
operationId: OrderRetentionFilters
|
46227
|
+
parameters:
|
46228
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46229
|
+
requestBody:
|
46230
|
+
content:
|
46231
|
+
application/json:
|
46232
|
+
schema:
|
46233
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderRequest'
|
46234
|
+
description: New definition of the RUM retention filter.
|
46235
|
+
required: true
|
46236
|
+
responses:
|
46237
|
+
'200':
|
46238
|
+
content:
|
46239
|
+
application/json:
|
46240
|
+
schema:
|
46241
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderResponse'
|
46242
|
+
description: Ordered
|
46243
|
+
'400':
|
46244
|
+
$ref: '#/components/responses/BadRequestResponse'
|
46245
|
+
'403':
|
46246
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46247
|
+
'429':
|
46248
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46249
|
+
summary: Order RUM retention filters
|
46250
|
+
tags:
|
46251
|
+
- Rum Retention Filters
|
46252
|
+
x-codegen-request-body-name: body
|
46253
|
+
/api/v2/rum/applications/{app_id}/retention_filters:
|
46254
|
+
get:
|
46255
|
+
description: Get the list of RUM retention filters for a RUM application.
|
46256
|
+
operationId: ListRetentionFilters
|
46257
|
+
parameters:
|
46258
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46259
|
+
responses:
|
46260
|
+
'200':
|
46261
|
+
content:
|
46262
|
+
application/json:
|
46263
|
+
schema:
|
46264
|
+
$ref: '#/components/schemas/RumRetentionFiltersResponse'
|
46265
|
+
description: OK
|
46266
|
+
'403':
|
46267
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46268
|
+
'429':
|
46269
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46270
|
+
summary: Get all RUM retention filters
|
46271
|
+
tags:
|
46272
|
+
- Rum Retention Filters
|
46273
|
+
post:
|
46274
|
+
description: 'Create a RUM retention filter for a RUM application.
|
46275
|
+
|
46276
|
+
Returns RUM retention filter objects from the request body when the request
|
46277
|
+
is successful.'
|
46278
|
+
operationId: CreateRetentionFilter
|
46279
|
+
parameters:
|
46280
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46281
|
+
requestBody:
|
46282
|
+
content:
|
46283
|
+
application/json:
|
46284
|
+
schema:
|
46285
|
+
$ref: '#/components/schemas/RumRetentionFilterCreateRequest'
|
46286
|
+
description: The definition of the new RUM retention filter.
|
46287
|
+
required: true
|
46288
|
+
responses:
|
46289
|
+
'201':
|
46290
|
+
content:
|
46291
|
+
application/json:
|
46292
|
+
schema:
|
46293
|
+
$ref: '#/components/schemas/RumRetentionFilterResponse'
|
46294
|
+
description: Created
|
46295
|
+
'400':
|
46296
|
+
$ref: '#/components/responses/BadRequestResponse'
|
46297
|
+
'403':
|
46298
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46299
|
+
'429':
|
46300
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46301
|
+
summary: Create a RUM retention filter
|
46302
|
+
tags:
|
46303
|
+
- Rum Retention Filters
|
46304
|
+
x-codegen-request-body-name: body
|
46305
|
+
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}:
|
46306
|
+
delete:
|
46307
|
+
description: Delete a RUM retention filter for a RUM application.
|
46308
|
+
operationId: DeleteRetentionFilter
|
46309
|
+
parameters:
|
46310
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46311
|
+
- $ref: '#/components/parameters/RumRetentionFilterIDParameter'
|
46312
|
+
responses:
|
46313
|
+
'204':
|
46314
|
+
description: No Content
|
46315
|
+
'403':
|
46316
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46317
|
+
'404':
|
46318
|
+
$ref: '#/components/responses/NotFoundResponse'
|
46319
|
+
'429':
|
46320
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46321
|
+
summary: Delete a RUM retention filter
|
46322
|
+
tags:
|
46323
|
+
- Rum Retention Filters
|
46324
|
+
get:
|
46325
|
+
description: Get a RUM retention filter for a RUM application.
|
46326
|
+
operationId: GetRetentionFilter
|
46327
|
+
parameters:
|
46328
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46329
|
+
- $ref: '#/components/parameters/RumRetentionFilterIDParameter'
|
46330
|
+
responses:
|
46331
|
+
'200':
|
46332
|
+
content:
|
46333
|
+
application/json:
|
46334
|
+
schema:
|
46335
|
+
$ref: '#/components/schemas/RumRetentionFilterResponse'
|
46336
|
+
description: OK
|
46337
|
+
'403':
|
46338
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46339
|
+
'404':
|
46340
|
+
$ref: '#/components/responses/NotFoundResponse'
|
46341
|
+
'429':
|
46342
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46343
|
+
summary: Get a RUM retention filter
|
46344
|
+
tags:
|
46345
|
+
- Rum Retention Filters
|
46346
|
+
patch:
|
46347
|
+
description: 'Update a RUM retention filter for a RUM application.
|
46348
|
+
|
46349
|
+
Returns RUM retention filter objects from the request body when the request
|
46350
|
+
is successful.'
|
46351
|
+
operationId: UpdateRetentionFilter
|
46352
|
+
parameters:
|
46353
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46354
|
+
- $ref: '#/components/parameters/RumRetentionFilterIDParameter'
|
46355
|
+
requestBody:
|
46356
|
+
content:
|
46357
|
+
application/json:
|
46358
|
+
schema:
|
46359
|
+
$ref: '#/components/schemas/RumRetentionFilterUpdateRequest'
|
46360
|
+
description: New definition of the RUM retention filter.
|
46361
|
+
required: true
|
46362
|
+
responses:
|
46363
|
+
'200':
|
46364
|
+
content:
|
46365
|
+
application/json:
|
46366
|
+
schema:
|
46367
|
+
$ref: '#/components/schemas/RumRetentionFilterResponse'
|
46368
|
+
description: Updated
|
46369
|
+
'400':
|
46370
|
+
$ref: '#/components/responses/BadRequestResponse'
|
46371
|
+
'403':
|
46372
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46373
|
+
'404':
|
46374
|
+
$ref: '#/components/responses/NotFoundResponse'
|
46375
|
+
'429':
|
46376
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46377
|
+
summary: Update a RUM retention filter
|
46378
|
+
tags:
|
46379
|
+
- Rum Retention Filters
|
46380
|
+
x-codegen-request-body-name: body
|
43080
46381
|
/api/v2/rum/applications/{id}:
|
43081
46382
|
delete:
|
43082
46383
|
description: Delete an existing RUM application in your organization.
|
@@ -43967,9 +47268,14 @@ paths:
|
|
43967
47268
|
security:
|
43968
47269
|
- apiKeyAuth: []
|
43969
47270
|
appKeyAuth: []
|
47271
|
+
- AuthZ:
|
47272
|
+
- appsec_vm_read
|
43970
47273
|
summary: List vulnerable assets
|
43971
47274
|
tags:
|
43972
47275
|
- Security Monitoring
|
47276
|
+
x-unstable: '**Note**: This endpoint is a private preview.
|
47277
|
+
|
47278
|
+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
43973
47279
|
/api/v2/security/cloud_workload/policy/download:
|
43974
47280
|
get:
|
43975
47281
|
description: 'The download endpoint generates a Cloud Workload Security policy
|
@@ -44059,9 +47365,14 @@ paths:
|
|
44059
47365
|
security:
|
44060
47366
|
- apiKeyAuth: []
|
44061
47367
|
appKeyAuth: []
|
47368
|
+
- AuthZ:
|
47369
|
+
- appsec_vm_read
|
44062
47370
|
summary: Get SBOM
|
44063
47371
|
tags:
|
44064
47372
|
- Security Monitoring
|
47373
|
+
x-unstable: '**Note**: This endpoint is a private preview.
|
47374
|
+
|
47375
|
+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
44065
47376
|
/api/v2/security/signals/notification_rules:
|
44066
47377
|
get:
|
44067
47378
|
description: Returns the list of notification rules for security signals.
|
@@ -44078,7 +47389,7 @@ paths:
|
|
44078
47389
|
appKeyAuth: []
|
44079
47390
|
- AuthZ:
|
44080
47391
|
- security_monitoring_notification_profiles_read
|
44081
|
-
summary: Get the list of signal-based rules
|
47392
|
+
summary: Get the list of signal-based notification rules
|
44082
47393
|
tags:
|
44083
47394
|
- Security Monitoring
|
44084
47395
|
x-permission:
|
@@ -44120,7 +47431,7 @@ paths:
|
|
44120
47431
|
appKeyAuth: []
|
44121
47432
|
- AuthZ:
|
44122
47433
|
- security_monitoring_notification_profiles_write
|
44123
|
-
summary: Create a new signal-based rule
|
47434
|
+
summary: Create a new signal-based notification rule
|
44124
47435
|
tags:
|
44125
47436
|
- Security Monitoring
|
44126
47437
|
x-codegen-request-body-name: body
|
@@ -44153,7 +47464,7 @@ paths:
|
|
44153
47464
|
appKeyAuth: []
|
44154
47465
|
- AuthZ:
|
44155
47466
|
- security_monitoring_notification_profiles_write
|
44156
|
-
summary: Delete a signal-based rule
|
47467
|
+
summary: Delete a signal-based notification rule
|
44157
47468
|
tags:
|
44158
47469
|
- Security Monitoring
|
44159
47470
|
x-permission:
|
@@ -44190,7 +47501,7 @@ paths:
|
|
44190
47501
|
appKeyAuth: []
|
44191
47502
|
- AuthZ:
|
44192
47503
|
- security_monitoring_notification_profiles_read
|
44193
|
-
summary: Get details of a signal-based rule
|
47504
|
+
summary: Get details of a signal-based notification rule
|
44194
47505
|
tags:
|
44195
47506
|
- Security Monitoring
|
44196
47507
|
x-permission:
|
@@ -44236,7 +47547,7 @@ paths:
|
|
44236
47547
|
appKeyAuth: []
|
44237
47548
|
- AuthZ:
|
44238
47549
|
- security_monitoring_notification_profiles_write
|
44239
|
-
summary: Patch a signal-based rule
|
47550
|
+
summary: Patch a signal-based notification rule
|
44240
47551
|
tags:
|
44241
47552
|
- Security Monitoring
|
44242
47553
|
x-codegen-request-body-name: body
|
@@ -44617,9 +47928,14 @@ paths:
|
|
44617
47928
|
security:
|
44618
47929
|
- apiKeyAuth: []
|
44619
47930
|
appKeyAuth: []
|
47931
|
+
- AuthZ:
|
47932
|
+
- appsec_vm_read
|
44620
47933
|
summary: List vulnerabilities
|
44621
47934
|
tags:
|
44622
47935
|
- Security Monitoring
|
47936
|
+
x-unstable: '**Note**: This endpoint is a private preview.
|
47937
|
+
|
47938
|
+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
44623
47939
|
/api/v2/security/vulnerabilities/notification_rules:
|
44624
47940
|
get:
|
44625
47941
|
description: Returns the list of notification rules for security vulnerabilities.
|
@@ -44636,7 +47952,7 @@ paths:
|
|
44636
47952
|
appKeyAuth: []
|
44637
47953
|
- AuthZ:
|
44638
47954
|
- security_monitoring_notification_profiles_read
|
44639
|
-
summary: Get the list of vulnerability
|
47955
|
+
summary: Get the list of vulnerability notification rules
|
44640
47956
|
tags:
|
44641
47957
|
- Security Monitoring
|
44642
47958
|
x-permission:
|
@@ -44678,7 +47994,7 @@ paths:
|
|
44678
47994
|
appKeyAuth: []
|
44679
47995
|
- AuthZ:
|
44680
47996
|
- security_monitoring_notification_profiles_write
|
44681
|
-
summary: Create a new vulnerability-based rule
|
47997
|
+
summary: Create a new vulnerability-based notification rule
|
44682
47998
|
tags:
|
44683
47999
|
- Security Monitoring
|
44684
48000
|
x-codegen-request-body-name: body
|
@@ -44711,7 +48027,7 @@ paths:
|
|
44711
48027
|
appKeyAuth: []
|
44712
48028
|
- AuthZ:
|
44713
48029
|
- security_monitoring_notification_profiles_write
|
44714
|
-
summary: Delete a vulnerability-based rule
|
48030
|
+
summary: Delete a vulnerability-based notification rule
|
44715
48031
|
tags:
|
44716
48032
|
- Security Monitoring
|
44717
48033
|
x-permission:
|
@@ -44748,7 +48064,7 @@ paths:
|
|
44748
48064
|
appKeyAuth: []
|
44749
48065
|
- AuthZ:
|
44750
48066
|
- security_monitoring_notification_profiles_read
|
44751
|
-
summary: Get details of a vulnerability
|
48067
|
+
summary: Get details of a vulnerability notification rule
|
44752
48068
|
tags:
|
44753
48069
|
- Security Monitoring
|
44754
48070
|
x-permission:
|
@@ -44794,7 +48110,7 @@ paths:
|
|
44794
48110
|
appKeyAuth: []
|
44795
48111
|
- AuthZ:
|
44796
48112
|
- security_monitoring_notification_profiles_write
|
44797
|
-
summary: Patch a vulnerability-based rule
|
48113
|
+
summary: Patch a vulnerability-based notification rule
|
44798
48114
|
tags:
|
44799
48115
|
- Security Monitoring
|
44800
48116
|
x-codegen-request-body-name: body
|
@@ -45624,6 +48940,42 @@ paths:
|
|
45624
48940
|
operator: OR
|
45625
48941
|
permissions:
|
45626
48942
|
- security_monitoring_rules_write
|
48943
|
+
/api/v2/security_monitoring/rules/{rule_id}/version_history:
|
48944
|
+
get:
|
48945
|
+
description: Get a rule's version history.
|
48946
|
+
operationId: GetRuleVersionHistory
|
48947
|
+
parameters:
|
48948
|
+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
|
48949
|
+
- $ref: '#/components/parameters/PageSize'
|
48950
|
+
- $ref: '#/components/parameters/PageNumber'
|
48951
|
+
responses:
|
48952
|
+
'200':
|
48953
|
+
content:
|
48954
|
+
application/json:
|
48955
|
+
schema:
|
48956
|
+
$ref: '#/components/schemas/GetRuleVersionHistoryResponse'
|
48957
|
+
description: OK
|
48958
|
+
'400':
|
48959
|
+
$ref: '#/components/responses/BadRequestResponse'
|
48960
|
+
'403':
|
48961
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
48962
|
+
'404':
|
48963
|
+
$ref: '#/components/responses/NotFoundResponse'
|
48964
|
+
'429':
|
48965
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
48966
|
+
security:
|
48967
|
+
- apiKeyAuth: []
|
48968
|
+
appKeyAuth: []
|
48969
|
+
- AuthZ:
|
48970
|
+
- security_monitoring_rules_read
|
48971
|
+
summary: Get a rule's version history
|
48972
|
+
tags:
|
48973
|
+
- Security Monitoring
|
48974
|
+
x-permission:
|
48975
|
+
operator: OR
|
48976
|
+
permissions:
|
48977
|
+
- security_monitoring_rules_read
|
48978
|
+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.'
|
45627
48979
|
/api/v2/security_monitoring/signals:
|
45628
48980
|
get:
|
45629
48981
|
description: 'The list endpoint returns security signals that match a search
|
@@ -49736,6 +53088,178 @@ paths:
|
|
49736
53088
|
operator: OR
|
49737
53089
|
permissions:
|
49738
53090
|
- teams_read
|
53091
|
+
/api/v2/workflows:
|
53092
|
+
post:
|
53093
|
+
description: Create a new workflow, returning the workflow ID. This API requires
|
53094
|
+
an application key scoped with the `workflows_write` permission.
|
53095
|
+
operationId: CreateWorkflow
|
53096
|
+
requestBody:
|
53097
|
+
content:
|
53098
|
+
application/json:
|
53099
|
+
schema:
|
53100
|
+
$ref: '#/components/schemas/CreateWorkflowRequest'
|
53101
|
+
required: true
|
53102
|
+
responses:
|
53103
|
+
'201':
|
53104
|
+
content:
|
53105
|
+
application/json:
|
53106
|
+
schema:
|
53107
|
+
$ref: '#/components/schemas/CreateWorkflowResponse'
|
53108
|
+
description: Successfully created a workflow.
|
53109
|
+
'400':
|
53110
|
+
content:
|
53111
|
+
application/json:
|
53112
|
+
schema:
|
53113
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53114
|
+
description: Bad request
|
53115
|
+
'403':
|
53116
|
+
content:
|
53117
|
+
application/json:
|
53118
|
+
schema:
|
53119
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53120
|
+
description: Forbidden
|
53121
|
+
'429':
|
53122
|
+
content:
|
53123
|
+
application/json:
|
53124
|
+
schema:
|
53125
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53126
|
+
description: Too many requests
|
53127
|
+
summary: Create a Workflow
|
53128
|
+
tags:
|
53129
|
+
- Workflow Automation
|
53130
|
+
x-permission:
|
53131
|
+
operator: OR
|
53132
|
+
permissions:
|
53133
|
+
- workflows_write
|
53134
|
+
/api/v2/workflows/{workflow_id}:
|
53135
|
+
delete:
|
53136
|
+
description: Delete a workflow by ID. This API requires an application key scoped
|
53137
|
+
with the `workflows_write` permission.
|
53138
|
+
operationId: DeleteWorkflow
|
53139
|
+
parameters:
|
53140
|
+
- $ref: '#/components/parameters/WorkflowId'
|
53141
|
+
responses:
|
53142
|
+
'204':
|
53143
|
+
description: Successfully deleted a workflow.
|
53144
|
+
'403':
|
53145
|
+
content:
|
53146
|
+
application/json:
|
53147
|
+
schema:
|
53148
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53149
|
+
description: Forbidden
|
53150
|
+
'404':
|
53151
|
+
content:
|
53152
|
+
application/json:
|
53153
|
+
schema:
|
53154
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53155
|
+
description: Not found
|
53156
|
+
'429':
|
53157
|
+
content:
|
53158
|
+
application/json:
|
53159
|
+
schema:
|
53160
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53161
|
+
description: Too many requests
|
53162
|
+
summary: Delete an existing Workflow
|
53163
|
+
tags:
|
53164
|
+
- Workflow Automation
|
53165
|
+
x-permission:
|
53166
|
+
operator: OR
|
53167
|
+
permissions:
|
53168
|
+
- workflows_write
|
53169
|
+
get:
|
53170
|
+
description: Get a workflow by ID. This API requires an application key scoped
|
53171
|
+
with the `workflows_read` permission.
|
53172
|
+
operationId: GetWorkflow
|
53173
|
+
parameters:
|
53174
|
+
- $ref: '#/components/parameters/WorkflowId'
|
53175
|
+
responses:
|
53176
|
+
'200':
|
53177
|
+
content:
|
53178
|
+
application/json:
|
53179
|
+
schema:
|
53180
|
+
$ref: '#/components/schemas/GetWorkflowResponse'
|
53181
|
+
description: Successfully got a workflow.
|
53182
|
+
'400':
|
53183
|
+
content:
|
53184
|
+
application/json:
|
53185
|
+
schema:
|
53186
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53187
|
+
description: Bad request
|
53188
|
+
'403':
|
53189
|
+
content:
|
53190
|
+
application/json:
|
53191
|
+
schema:
|
53192
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53193
|
+
description: Forbidden
|
53194
|
+
'404':
|
53195
|
+
content:
|
53196
|
+
application/json:
|
53197
|
+
schema:
|
53198
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53199
|
+
description: Not found
|
53200
|
+
'429':
|
53201
|
+
content:
|
53202
|
+
application/json:
|
53203
|
+
schema:
|
53204
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53205
|
+
description: Too many requests
|
53206
|
+
summary: Get an existing Workflow
|
53207
|
+
tags:
|
53208
|
+
- Workflow Automation
|
53209
|
+
x-permission:
|
53210
|
+
operator: OR
|
53211
|
+
permissions:
|
53212
|
+
- workflows_read
|
53213
|
+
patch:
|
53214
|
+
description: Update a workflow by ID. This API requires an application key scoped
|
53215
|
+
with the `workflows_write` permission.
|
53216
|
+
operationId: UpdateWorkflow
|
53217
|
+
parameters:
|
53218
|
+
- $ref: '#/components/parameters/WorkflowId'
|
53219
|
+
requestBody:
|
53220
|
+
content:
|
53221
|
+
application/json:
|
53222
|
+
schema:
|
53223
|
+
$ref: '#/components/schemas/UpdateWorkflowRequest'
|
53224
|
+
required: true
|
53225
|
+
responses:
|
53226
|
+
'200':
|
53227
|
+
content:
|
53228
|
+
application/json:
|
53229
|
+
schema:
|
53230
|
+
$ref: '#/components/schemas/UpdateWorkflowResponse'
|
53231
|
+
description: Successfully updated a workflow.
|
53232
|
+
'400':
|
53233
|
+
content:
|
53234
|
+
application/json:
|
53235
|
+
schema:
|
53236
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53237
|
+
description: Bad request
|
53238
|
+
'403':
|
53239
|
+
content:
|
53240
|
+
application/json:
|
53241
|
+
schema:
|
53242
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53243
|
+
description: Forbidden
|
53244
|
+
'404':
|
53245
|
+
content:
|
53246
|
+
application/json:
|
53247
|
+
schema:
|
53248
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53249
|
+
description: Not found
|
53250
|
+
'429':
|
53251
|
+
content:
|
53252
|
+
application/json:
|
53253
|
+
schema:
|
53254
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53255
|
+
description: Too many requests
|
53256
|
+
summary: Update an existing Workflow
|
53257
|
+
tags:
|
53258
|
+
- Workflow Automation
|
53259
|
+
x-permission:
|
53260
|
+
operator: OR
|
53261
|
+
permissions:
|
53262
|
+
- workflows_write
|
49739
53263
|
/api/v2/workflows/{workflow_id}/instances:
|
49740
53264
|
get:
|
49741
53265
|
description: List all instances of a given workflow. This API requires an application
|
@@ -49944,14 +53468,31 @@ tags:
|
|
49944
53468
|
name: Action Connection
|
49945
53469
|
- description: "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin
|
49946
53470
|
your hosts, running containers, and serverless functions\u2014all without\nrequiring
|
49947
|
-
teams to install Agents on every host or where Agents cannot be installed.\
|
49948
|
-
to https://www.datadoghq.com/blog/agentless-scanning/
|
53471
|
+
teams to install Agents on every host or where Agents cannot be installed.\nAgentless
|
53472
|
+
offers also Sensitive Data Scanning capabilities on your storage.\nGo to https://www.datadoghq.com/blog/agentless-scanning/
|
53473
|
+
to learn more."
|
49949
53474
|
name: Agentless Scanning
|
49950
53475
|
- description: Datadog App Builder provides a low-code solution to rapidly develop
|
49951
53476
|
and integrate secure, customized applications into your monitoring stack that
|
49952
53477
|
are built to accelerate remediation at scale. These API endpoints allow you to
|
49953
53478
|
create, read, update, delete, and publish apps.
|
49954
53479
|
name: App Builder
|
53480
|
+
- description: '[Datadog Application Security](https://docs.datadoghq.com/security/application_security/)
|
53481
|
+
provides protection against
|
53482
|
+
|
53483
|
+
application-level attacks that aim to exploit code-level vulnerabilities,
|
53484
|
+
|
53485
|
+
such as Server-Side-Request-Forgery (SSRF), SQL injection, Log4Shell, and
|
53486
|
+
|
53487
|
+
Reflected Cross-Site-Scripting (XSS). You can monitor and protect apps
|
53488
|
+
|
53489
|
+
hosted directly on a server, Docker, Kubernetes, Amazon ECS, and (for
|
53490
|
+
|
53491
|
+
supported languages) AWS Fargate.'
|
53492
|
+
externalDocs:
|
53493
|
+
description: Find out more at
|
53494
|
+
url: https://docs.datadoghq.com/security/application_security/
|
53495
|
+
name: Application Security
|
49955
53496
|
- description: Search your Audit Logs events over HTTP.
|
49956
53497
|
name: Audit
|
49957
53498
|
- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
@@ -50252,6 +53793,9 @@ tags:
|
|
50252
53793
|
description: Find out more at
|
50253
53794
|
url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
|
50254
53795
|
name: Rum Metrics
|
53796
|
+
- description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
|
53797
|
+
of RUM for your organization.
|
53798
|
+
name: Rum Retention Filters
|
50255
53799
|
- description: Create and manage your security rules, signals, filters, and more.
|
50256
53800
|
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
|
50257
53801
|
information.
|
@@ -50339,7 +53883,12 @@ tags:
|
|
50339
53883
|
externalDocs:
|
50340
53884
|
url: https://docs.datadoghq.com/account_management/users
|
50341
53885
|
name: Users
|
50342
|
-
- description:
|
53886
|
+
- description: Datadog Workflow Automation allows you to automate your end-to-end
|
53887
|
+
processes by connecting Datadog with the rest of your tech stack. Build workflows
|
53888
|
+
to auto-remediate your alerts, streamline your incident and security processes,
|
53889
|
+
and reduce manual toil. Workflow Automation supports over 1,000+ OOTB actions,
|
53890
|
+
including AWS, JIRA, ServiceNow, GitHub, and OpenAI. Learn more in our Workflow
|
53891
|
+
Automation docs [here](https://docs.datadoghq.com/service_management/workflows/).
|
50343
53892
|
externalDocs:
|
50344
53893
|
description: Find out more at
|
50345
53894
|
url: https://docs.datadoghq.com/service_management/workflows/
|