datadog_api_client 2.30.0 → 2.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/schemas/v1/openapi.yaml +338 -22
- data/.generator/schemas/v2/openapi.yaml +3672 -98
- data/CHANGELOG.md +37 -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 +21 -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 +188 -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 +154 -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 +135 -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_meta.rb +105 -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_source.rb +29 -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 +175 -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 +223 -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: 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,224 @@ 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
|
+
meta:
|
25522
|
+
$ref: '#/components/schemas/RumRetentionFilterMeta'
|
25523
|
+
type:
|
25524
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25525
|
+
required:
|
25526
|
+
- type
|
25527
|
+
- attributes
|
25528
|
+
type: object
|
25529
|
+
RumRetentionFilterCreateRequest:
|
25530
|
+
description: The RUM retention filter body to create.
|
25531
|
+
properties:
|
25532
|
+
data:
|
25533
|
+
$ref: '#/components/schemas/RumRetentionFilterCreateData'
|
25534
|
+
required:
|
25535
|
+
- data
|
25536
|
+
type: object
|
25537
|
+
RumRetentionFilterData:
|
25538
|
+
description: The RUM retention filter.
|
25539
|
+
properties:
|
25540
|
+
attributes:
|
25541
|
+
$ref: '#/components/schemas/RumRetentionFilterAttributes'
|
25542
|
+
id:
|
25543
|
+
$ref: '#/components/schemas/RumRetentionFilterID'
|
25544
|
+
meta:
|
25545
|
+
$ref: '#/components/schemas/RumRetentionFilterMeta'
|
25546
|
+
type:
|
25547
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25548
|
+
type: object
|
25549
|
+
RumRetentionFilterEnabled:
|
25550
|
+
description: Whether the retention filter is enabled.
|
25551
|
+
example: true
|
25552
|
+
type: boolean
|
25553
|
+
RumRetentionFilterEventType:
|
25554
|
+
description: The type of RUM events to filter on.
|
25555
|
+
enum:
|
25556
|
+
- session
|
25557
|
+
- view
|
25558
|
+
- action
|
25559
|
+
- error
|
25560
|
+
- resource
|
25561
|
+
- long_task
|
25562
|
+
- vital
|
25563
|
+
example: session
|
25564
|
+
type: string
|
25565
|
+
x-enum-varnames:
|
25566
|
+
- SESSION
|
25567
|
+
- VIEW
|
25568
|
+
- ACTION
|
25569
|
+
- ERROR
|
25570
|
+
- RESOURCE
|
25571
|
+
- LONG_TASK
|
25572
|
+
- VITAL
|
25573
|
+
RumRetentionFilterID:
|
25574
|
+
description: ID of retention filter in UUID.
|
25575
|
+
example: 051601eb-54a0-abc0-03f9-cc02efa18892
|
25576
|
+
type: string
|
25577
|
+
RumRetentionFilterMeta:
|
25578
|
+
description: The object describing metadata of a RUM retention filter.
|
25579
|
+
properties:
|
25580
|
+
source:
|
25581
|
+
$ref: '#/components/schemas/RumRetentionFilterSource'
|
25582
|
+
type: object
|
25583
|
+
RumRetentionFilterQuery:
|
25584
|
+
description: The query string for a RUM retention filter.
|
25585
|
+
example: '@session.has_replay:true'
|
25586
|
+
type: string
|
25587
|
+
RumRetentionFilterResponse:
|
25588
|
+
description: The RUM retention filter object.
|
25589
|
+
properties:
|
25590
|
+
data:
|
25591
|
+
$ref: '#/components/schemas/RumRetentionFilterData'
|
25592
|
+
type: object
|
25593
|
+
RumRetentionFilterSampleRate:
|
25594
|
+
description: The sample rate for a RUM retention filter, between 0 and 100.
|
25595
|
+
example: 25
|
25596
|
+
format: int64
|
25597
|
+
maximum: 100
|
25598
|
+
minimum: 0
|
25599
|
+
type: integer
|
25600
|
+
RumRetentionFilterSource:
|
25601
|
+
description: The type of RUM events to filter on.
|
25602
|
+
enum:
|
25603
|
+
- ui
|
25604
|
+
- terraform
|
25605
|
+
- default
|
25606
|
+
- unknown
|
25607
|
+
example: terraform
|
25608
|
+
type: string
|
25609
|
+
x-enum-varnames:
|
25610
|
+
- UI
|
25611
|
+
- TERRAFORM
|
25612
|
+
- DEFAULT
|
25613
|
+
- UNKNOWN
|
25614
|
+
RumRetentionFilterType:
|
25615
|
+
default: retention_filters
|
25616
|
+
description: The type of the resource. The value should always be retention_filters.
|
25617
|
+
enum:
|
25618
|
+
- retention_filters
|
25619
|
+
example: retention_filters
|
25620
|
+
type: string
|
25621
|
+
x-enum-varnames:
|
25622
|
+
- RETENTION_FILTERS
|
25623
|
+
RumRetentionFilterUpdateAttributes:
|
25624
|
+
description: The object describing attributes of a RUM retention filter to update.
|
25625
|
+
properties:
|
25626
|
+
enabled:
|
25627
|
+
$ref: '#/components/schemas/RumRetentionFilterEnabled'
|
25628
|
+
event_type:
|
25629
|
+
$ref: '#/components/schemas/RumRetentionFilterEventType'
|
25630
|
+
name:
|
25631
|
+
$ref: '#/components/schemas/RunRetentionFilterName'
|
25632
|
+
query:
|
25633
|
+
$ref: '#/components/schemas/RumRetentionFilterQuery'
|
25634
|
+
sample_rate:
|
25635
|
+
$ref: '#/components/schemas/RumRetentionFilterSampleRate'
|
25636
|
+
type: object
|
25637
|
+
RumRetentionFilterUpdateData:
|
25638
|
+
description: The new RUM retention filter properties to update.
|
25639
|
+
properties:
|
25640
|
+
attributes:
|
25641
|
+
$ref: '#/components/schemas/RumRetentionFilterUpdateAttributes'
|
25642
|
+
id:
|
25643
|
+
$ref: '#/components/schemas/RumRetentionFilterID'
|
25644
|
+
meta:
|
25645
|
+
$ref: '#/components/schemas/RumRetentionFilterMeta'
|
25646
|
+
type:
|
25647
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25648
|
+
required:
|
25649
|
+
- id
|
25650
|
+
- type
|
25651
|
+
- attributes
|
25652
|
+
type: object
|
25653
|
+
RumRetentionFilterUpdateRequest:
|
25654
|
+
description: The RUM retention filter body to update.
|
25655
|
+
properties:
|
25656
|
+
data:
|
25657
|
+
$ref: '#/components/schemas/RumRetentionFilterUpdateData'
|
25658
|
+
required:
|
25659
|
+
- data
|
25660
|
+
type: object
|
25661
|
+
RumRetentionFiltersOrderData:
|
25662
|
+
description: The RUM retention filter data for ordering.
|
25663
|
+
properties:
|
25664
|
+
id:
|
25665
|
+
$ref: '#/components/schemas/RumRetentionFilterID'
|
25666
|
+
type:
|
25667
|
+
$ref: '#/components/schemas/RumRetentionFilterType'
|
25668
|
+
required:
|
25669
|
+
- id
|
25670
|
+
- type
|
25671
|
+
type: object
|
25672
|
+
RumRetentionFiltersOrderRequest:
|
25673
|
+
description: 'The list of RUM retention filter IDs along with their corresponding
|
25674
|
+
type to reorder.
|
25675
|
+
|
25676
|
+
All retention filter IDs should be included in the list created for an application.'
|
25677
|
+
properties:
|
25678
|
+
data:
|
25679
|
+
description: A list of RUM retention filter IDs along with type.
|
25680
|
+
items:
|
25681
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderData'
|
25682
|
+
type: array
|
25683
|
+
type: object
|
25684
|
+
RumRetentionFiltersOrderResponse:
|
25685
|
+
description: The list of RUM retention filter IDs along with type.
|
25686
|
+
properties:
|
25687
|
+
data:
|
25688
|
+
description: A list of RUM retention filter IDs along with type.
|
25689
|
+
items:
|
25690
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderData'
|
25691
|
+
type: array
|
25692
|
+
type: object
|
25693
|
+
RumRetentionFiltersResponse:
|
25694
|
+
description: All RUM retention filters for an application.
|
25695
|
+
properties:
|
25696
|
+
data:
|
25697
|
+
description: A list of RUM retention filters.
|
25698
|
+
items:
|
25699
|
+
$ref: '#/components/schemas/RumRetentionFilterData'
|
25700
|
+
type: array
|
25701
|
+
type: object
|
23533
25702
|
RunHistoricalJobRequest:
|
23534
25703
|
description: Run a historical job request.
|
23535
25704
|
properties:
|
@@ -23562,6 +25731,10 @@ components:
|
|
23562
25731
|
type: string
|
23563
25732
|
x-enum-varnames:
|
23564
25733
|
- HISTORICALDETECTIONSJOBCREATE
|
25734
|
+
RunRetentionFilterName:
|
25735
|
+
description: The name of a RUM retention filter.
|
25736
|
+
example: Retention filter for session
|
25737
|
+
type: string
|
23565
25738
|
SAMLAssertionAttribute:
|
23566
25739
|
description: SAML assertion attribute.
|
23567
25740
|
properties:
|
@@ -23958,6 +26131,26 @@ components:
|
|
23958
26131
|
type:
|
23959
26132
|
$ref: '#/components/schemas/ScalarFormulaResponseType'
|
23960
26133
|
type: object
|
26134
|
+
ScheduleTrigger:
|
26135
|
+
description: Trigger a workflow VIA a Schedule. The workflow must be published.
|
26136
|
+
properties:
|
26137
|
+
rruleExpression:
|
26138
|
+
description: Recurrence rule expression for scheduling.
|
26139
|
+
example: ''
|
26140
|
+
type: string
|
26141
|
+
required:
|
26142
|
+
- rruleExpression
|
26143
|
+
type: object
|
26144
|
+
ScheduleTriggerWrapper:
|
26145
|
+
description: Schema for a Schedule-based trigger.
|
26146
|
+
properties:
|
26147
|
+
scheduleTrigger:
|
26148
|
+
$ref: '#/components/schemas/ScheduleTrigger'
|
26149
|
+
startStepNames:
|
26150
|
+
$ref: '#/components/schemas/StartStepNames'
|
26151
|
+
required:
|
26152
|
+
- scheduleTrigger
|
26153
|
+
type: object
|
23961
26154
|
ScorecardType:
|
23962
26155
|
default: scorecard
|
23963
26156
|
description: The JSON:API type for scorecard.
|
@@ -24243,6 +26436,11 @@ components:
|
|
24243
26436
|
SecurityMonitoringRuleCase:
|
24244
26437
|
description: Case when signal is generated.
|
24245
26438
|
properties:
|
26439
|
+
actions:
|
26440
|
+
description: Action to perform for each rule case.
|
26441
|
+
items:
|
26442
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseAction'
|
26443
|
+
type: array
|
24246
26444
|
condition:
|
24247
26445
|
description: 'A rule case contains logical operations (`>`,`>=`, `&&`, `||`)
|
24248
26446
|
to determine if a signal should be generated
|
@@ -24261,9 +26459,42 @@ components:
|
|
24261
26459
|
status:
|
24262
26460
|
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
24263
26461
|
type: object
|
26462
|
+
SecurityMonitoringRuleCaseAction:
|
26463
|
+
description: Action to perform when a signal is triggered. Only available for
|
26464
|
+
Application Security rule type.
|
26465
|
+
properties:
|
26466
|
+
options:
|
26467
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptions'
|
26468
|
+
type:
|
26469
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseActionType'
|
26470
|
+
type: object
|
26471
|
+
SecurityMonitoringRuleCaseActionOptions:
|
26472
|
+
description: Options for the rule action
|
26473
|
+
properties:
|
26474
|
+
duration:
|
26475
|
+
description: Duration of the action in seconds. 0 indicates no expiration.
|
26476
|
+
example: 0
|
26477
|
+
format: int64
|
26478
|
+
minimum: 0
|
26479
|
+
type: integer
|
26480
|
+
type: object
|
26481
|
+
SecurityMonitoringRuleCaseActionType:
|
26482
|
+
description: The action type.
|
26483
|
+
enum:
|
26484
|
+
- block_ip
|
26485
|
+
- block_user
|
26486
|
+
type: string
|
26487
|
+
x-enum-varnames:
|
26488
|
+
- BLOCK_IP
|
26489
|
+
- BLOCK_USER
|
24264
26490
|
SecurityMonitoringRuleCaseCreate:
|
24265
26491
|
description: Case when signal is generated.
|
24266
26492
|
properties:
|
26493
|
+
actions:
|
26494
|
+
description: Action to perform for each rule case.
|
26495
|
+
items:
|
26496
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCaseAction'
|
26497
|
+
type: array
|
24267
26498
|
condition:
|
24268
26499
|
description: 'A case contains logical operations (`>`,`>=`, `&&`, `||`)
|
24269
26500
|
to determine if a signal should be generated
|
@@ -24347,6 +26578,10 @@ components:
|
|
24347
26578
|
- 1800
|
24348
26579
|
- 3600
|
24349
26580
|
- 7200
|
26581
|
+
- 10800
|
26582
|
+
- 21600
|
26583
|
+
- 43200
|
26584
|
+
- 86400
|
24350
26585
|
format: int32
|
24351
26586
|
type: integer
|
24352
26587
|
x-enum-varnames:
|
@@ -24358,6 +26593,10 @@ components:
|
|
24358
26593
|
- THIRTY_MINUTES
|
24359
26594
|
- ONE_HOUR
|
24360
26595
|
- TWO_HOURS
|
26596
|
+
- THREE_HOURS
|
26597
|
+
- SIX_HOURS
|
26598
|
+
- TWELVE_HOURS
|
26599
|
+
- ONE_DAY
|
24361
26600
|
SecurityMonitoringRuleHardcodedEvaluatorType:
|
24362
26601
|
description: Hardcoded evaluator type.
|
24363
26602
|
enum:
|
@@ -24394,6 +26633,8 @@ components:
|
|
24394
26633
|
- 7200
|
24395
26634
|
- 10800
|
24396
26635
|
- 21600
|
26636
|
+
- 43200
|
26637
|
+
- 86400
|
24397
26638
|
format: int32
|
24398
26639
|
type: integer
|
24399
26640
|
x-enum-varnames:
|
@@ -24407,6 +26648,8 @@ components:
|
|
24407
26648
|
- TWO_HOURS
|
24408
26649
|
- THREE_HOURS
|
24409
26650
|
- SIX_HOURS
|
26651
|
+
- TWELVE_HOURS
|
26652
|
+
- ONE_DAY
|
24410
26653
|
SecurityMonitoringRuleMaxSignalDuration:
|
24411
26654
|
description: "A signal will \u201Cclose\u201D regardless of the query being
|
24412
26655
|
matched once the time exceeds the maximum duration.\nThis time is calculated
|
@@ -24725,6 +26968,15 @@ components:
|
|
24725
26968
|
items:
|
24726
26969
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
24727
26970
|
type: array
|
26971
|
+
groupSignalsBy:
|
26972
|
+
description: Additional grouping to perform on top of the existing groups
|
26973
|
+
in the query section. Must be a subset of the existing groups.
|
26974
|
+
example:
|
26975
|
+
- service
|
26976
|
+
items:
|
26977
|
+
description: Field to group by.
|
26978
|
+
type: string
|
26979
|
+
type: array
|
24728
26980
|
hasExtendedTitle:
|
24729
26981
|
description: Whether the notifications include the triggering group-by values
|
24730
26982
|
in their title.
|
@@ -25195,6 +27447,7 @@ components:
|
|
25195
27447
|
description: The version of the rule.
|
25196
27448
|
format: int64
|
25197
27449
|
type: integer
|
27450
|
+
type: object
|
25198
27451
|
SecurityMonitoringSignalRuleResponseQuery:
|
25199
27452
|
description: Query for matching rule on signals.
|
25200
27453
|
properties:
|
@@ -25430,6 +27683,15 @@ components:
|
|
25430
27683
|
items:
|
25431
27684
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25432
27685
|
type: array
|
27686
|
+
groupSignalsBy:
|
27687
|
+
description: Additional grouping to perform on top of the existing groups
|
27688
|
+
in the query section. Must be a subset of the existing groups.
|
27689
|
+
example:
|
27690
|
+
- service
|
27691
|
+
items:
|
27692
|
+
description: Field to group by.
|
27693
|
+
type: string
|
27694
|
+
type: array
|
25433
27695
|
hasExtendedTitle:
|
25434
27696
|
description: Whether the notifications include the triggering group-by values
|
25435
27697
|
in their title.
|
@@ -25502,6 +27764,15 @@ components:
|
|
25502
27764
|
items:
|
25503
27765
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25504
27766
|
type: array
|
27767
|
+
groupSignalsBy:
|
27768
|
+
description: Additional grouping to perform on top of the existing groups
|
27769
|
+
in the query section. Must be a subset of the existing groups.
|
27770
|
+
example:
|
27771
|
+
- service
|
27772
|
+
items:
|
27773
|
+
description: Field to group by.
|
27774
|
+
type: string
|
27775
|
+
type: array
|
25505
27776
|
hasExtendedTitle:
|
25506
27777
|
description: Whether the notifications include the triggering group-by values
|
25507
27778
|
in their title.
|
@@ -25643,6 +27914,15 @@ components:
|
|
25643
27914
|
items:
|
25644
27915
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25645
27916
|
type: array
|
27917
|
+
groupSignalsBy:
|
27918
|
+
description: Additional grouping to perform on top of the existing groups
|
27919
|
+
in the query section. Must be a subset of the existing groups.
|
27920
|
+
example:
|
27921
|
+
- service
|
27922
|
+
items:
|
27923
|
+
description: Field to group by.
|
27924
|
+
type: string
|
27925
|
+
type: array
|
25646
27926
|
hasExtendedTitle:
|
25647
27927
|
description: Whether the notifications include the triggering group-by values
|
25648
27928
|
in their title.
|
@@ -25704,6 +27984,7 @@ components:
|
|
25704
27984
|
description: The version of the rule.
|
25705
27985
|
format: int64
|
25706
27986
|
type: integer
|
27987
|
+
type: object
|
25707
27988
|
SecurityMonitoringStandardRuleTestPayload:
|
25708
27989
|
description: The payload of a rule to test
|
25709
27990
|
properties:
|
@@ -25720,6 +28001,15 @@ components:
|
|
25720
28001
|
items:
|
25721
28002
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
25722
28003
|
type: array
|
28004
|
+
groupSignalsBy:
|
28005
|
+
description: Additional grouping to perform on top of the existing groups
|
28006
|
+
in the query section. Must be a subset of the existing groups.
|
28007
|
+
example:
|
28008
|
+
- service
|
28009
|
+
items:
|
28010
|
+
description: Field to group by.
|
28011
|
+
type: string
|
28012
|
+
type: array
|
25723
28013
|
hasExtendedTitle:
|
25724
28014
|
description: Whether the notifications include the triggering group-by values
|
25725
28015
|
in their title.
|
@@ -26125,6 +28415,23 @@ components:
|
|
26125
28415
|
nullable: true
|
26126
28416
|
type: string
|
26127
28417
|
type: object
|
28418
|
+
SecurityTrigger:
|
28419
|
+
description: Trigger a workflow VIA a Security Signal or Finding. For automatic
|
28420
|
+
triggering a handle must be configured and the workflow must be published.
|
28421
|
+
properties:
|
28422
|
+
rateLimit:
|
28423
|
+
$ref: '#/components/schemas/TriggerRateLimit'
|
28424
|
+
type: object
|
28425
|
+
SecurityTriggerWrapper:
|
28426
|
+
description: Schema for a Security-based trigger.
|
28427
|
+
properties:
|
28428
|
+
securityTrigger:
|
28429
|
+
$ref: '#/components/schemas/SecurityTrigger'
|
28430
|
+
startStepNames:
|
28431
|
+
$ref: '#/components/schemas/StartStepNames'
|
28432
|
+
required:
|
28433
|
+
- securityTrigger
|
28434
|
+
type: object
|
26128
28435
|
Selectors:
|
26129
28436
|
description: 'Selectors are used to filter security issues for which notifications
|
26130
28437
|
should be generated.
|
@@ -27880,6 +30187,17 @@ components:
|
|
27880
30187
|
- channel_name
|
27881
30188
|
- redirect_url
|
27882
30189
|
type: object
|
30190
|
+
SlackTriggerWrapper:
|
30191
|
+
description: Schema for a Slack-based trigger.
|
30192
|
+
properties:
|
30193
|
+
slackTrigger:
|
30194
|
+
description: Trigger a workflow VIA Slack. The workflow must be published.
|
30195
|
+
type: object
|
30196
|
+
startStepNames:
|
30197
|
+
$ref: '#/components/schemas/StartStepNames'
|
30198
|
+
required:
|
30199
|
+
- slackTrigger
|
30200
|
+
type: object
|
27883
30201
|
SloReportCreateRequest:
|
27884
30202
|
description: The SLO report request body.
|
27885
30203
|
properties:
|
@@ -28802,6 +31120,41 @@ components:
|
|
28802
31120
|
from the other indexes
|
28803
31121
|
type: string
|
28804
31122
|
type: object
|
31123
|
+
Spec:
|
31124
|
+
description: The spec defines what the workflow does.
|
31125
|
+
properties:
|
31126
|
+
annotations:
|
31127
|
+
description: A list of annotations used in the workflow. These are like
|
31128
|
+
sticky notes for your workflow!
|
31129
|
+
items:
|
31130
|
+
$ref: '#/components/schemas/Annotation'
|
31131
|
+
type: array
|
31132
|
+
connectionEnvs:
|
31133
|
+
description: A list of connections or connection groups used in the workflow.
|
31134
|
+
items:
|
31135
|
+
$ref: '#/components/schemas/ConnectionEnv'
|
31136
|
+
type: array
|
31137
|
+
handle:
|
31138
|
+
description: Unique identifier used to trigger workflows automatically in
|
31139
|
+
Datadog.
|
31140
|
+
type: string
|
31141
|
+
inputSchema:
|
31142
|
+
$ref: '#/components/schemas/InputSchema'
|
31143
|
+
outputSchema:
|
31144
|
+
$ref: '#/components/schemas/OutputSchema'
|
31145
|
+
steps:
|
31146
|
+
description: A `Step` is a sub-component of a workflow. Each `Step` performs
|
31147
|
+
an action.
|
31148
|
+
items:
|
31149
|
+
$ref: '#/components/schemas/Step'
|
31150
|
+
type: array
|
31151
|
+
triggers:
|
31152
|
+
description: The list of triggers that activate this workflow. At least
|
31153
|
+
one trigger is required, and each trigger type may appear at most once.
|
31154
|
+
items:
|
31155
|
+
$ref: '#/components/schemas/Trigger'
|
31156
|
+
type: array
|
31157
|
+
type: object
|
28805
31158
|
SpecVersion:
|
28806
31159
|
description: The version of the CycloneDX specification a BOM conforms to.
|
28807
31160
|
enum:
|
@@ -28820,6 +31173,14 @@ components:
|
|
28820
31173
|
- ONE_THREE
|
28821
31174
|
- ONE_FOUR
|
28822
31175
|
- ONE_FIVE
|
31176
|
+
StartStepNames:
|
31177
|
+
description: A list of steps that run first after a trigger fires.
|
31178
|
+
example:
|
31179
|
+
- ''
|
31180
|
+
items:
|
31181
|
+
description: The `StartStepNames` `items`.
|
31182
|
+
type: string
|
31183
|
+
type: array
|
28823
31184
|
State:
|
28824
31185
|
description: The state of the rule evaluation.
|
28825
31186
|
enum:
|
@@ -28832,6 +31193,104 @@ components:
|
|
28832
31193
|
- PASS
|
28833
31194
|
- FAIL
|
28834
31195
|
- SKIP
|
31196
|
+
StateVariable:
|
31197
|
+
description: A variable, which can be set and read by other components in the
|
31198
|
+
app.
|
31199
|
+
properties:
|
31200
|
+
id:
|
31201
|
+
description: The ID of the state variable.
|
31202
|
+
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
|
31203
|
+
format: uuid
|
31204
|
+
type: string
|
31205
|
+
name:
|
31206
|
+
description: A unique identifier for this state variable. This name is also
|
31207
|
+
used to access the variable's value throughout the app.
|
31208
|
+
example: ordersToSubmit
|
31209
|
+
type: string
|
31210
|
+
properties:
|
31211
|
+
$ref: '#/components/schemas/StateVariableProperties'
|
31212
|
+
type:
|
31213
|
+
$ref: '#/components/schemas/StateVariableType'
|
31214
|
+
required:
|
31215
|
+
- id
|
31216
|
+
- name
|
31217
|
+
- type
|
31218
|
+
- properties
|
31219
|
+
type: object
|
31220
|
+
StateVariableProperties:
|
31221
|
+
description: The properties of the state variable.
|
31222
|
+
properties:
|
31223
|
+
defaultValue:
|
31224
|
+
description: The default value of the state variable.
|
31225
|
+
example: ${['order_3145', 'order_4920']}
|
31226
|
+
type: object
|
31227
|
+
StateVariableType:
|
31228
|
+
default: stateVariable
|
31229
|
+
description: The state variable type.
|
31230
|
+
enum:
|
31231
|
+
- stateVariable
|
31232
|
+
example: stateVariable
|
31233
|
+
type: string
|
31234
|
+
x-enum-varnames:
|
31235
|
+
- STATEVARIABLE
|
31236
|
+
Step:
|
31237
|
+
description: A Step is a sub-component of a workflow. Each Step performs an
|
31238
|
+
action.
|
31239
|
+
properties:
|
31240
|
+
actionId:
|
31241
|
+
description: The unique identifier of an action.
|
31242
|
+
example: ''
|
31243
|
+
type: string
|
31244
|
+
completionGate:
|
31245
|
+
$ref: '#/components/schemas/CompletionGate'
|
31246
|
+
connectionLabel:
|
31247
|
+
description: The unique identifier of a connection defined in the spec.
|
31248
|
+
type: string
|
31249
|
+
display:
|
31250
|
+
$ref: '#/components/schemas/StepDisplay'
|
31251
|
+
errorHandlers:
|
31252
|
+
description: The `Step` `errorHandlers`.
|
31253
|
+
items:
|
31254
|
+
$ref: '#/components/schemas/ErrorHandler'
|
31255
|
+
type: array
|
31256
|
+
name:
|
31257
|
+
description: Name of the step.
|
31258
|
+
example: ''
|
31259
|
+
type: string
|
31260
|
+
outboundEdges:
|
31261
|
+
description: A list of subsequent actions to run.
|
31262
|
+
items:
|
31263
|
+
$ref: '#/components/schemas/OutboundEdge'
|
31264
|
+
type: array
|
31265
|
+
parameters:
|
31266
|
+
description: A list of inputs for an action.
|
31267
|
+
items:
|
31268
|
+
$ref: '#/components/schemas/Parameter'
|
31269
|
+
type: array
|
31270
|
+
readinessGate:
|
31271
|
+
$ref: '#/components/schemas/ReadinessGate'
|
31272
|
+
required:
|
31273
|
+
- name
|
31274
|
+
- actionId
|
31275
|
+
type: object
|
31276
|
+
StepDisplay:
|
31277
|
+
description: The definition of `StepDisplay` object.
|
31278
|
+
properties:
|
31279
|
+
bounds:
|
31280
|
+
$ref: '#/components/schemas/StepDisplayBounds'
|
31281
|
+
type: object
|
31282
|
+
StepDisplayBounds:
|
31283
|
+
description: The definition of `StepDisplayBounds` object.
|
31284
|
+
properties:
|
31285
|
+
x:
|
31286
|
+
description: The `bounds` `x`.
|
31287
|
+
format: double
|
31288
|
+
type: number
|
31289
|
+
y:
|
31290
|
+
description: The `bounds` `y`.
|
31291
|
+
format: double
|
31292
|
+
type: number
|
31293
|
+
type: object
|
28835
31294
|
TagsEventAttribute:
|
28836
31295
|
description: Array of tags associated with your event.
|
28837
31296
|
example:
|
@@ -29638,6 +32097,33 @@ components:
|
|
29638
32097
|
type: string
|
29639
32098
|
x-enum-varnames:
|
29640
32099
|
- SECRET
|
32100
|
+
Trigger:
|
32101
|
+
description: One of the triggers that can start the execution of a workflow.
|
32102
|
+
oneOf:
|
32103
|
+
- $ref: '#/components/schemas/APITriggerWrapper'
|
32104
|
+
- $ref: '#/components/schemas/AppTriggerWrapper'
|
32105
|
+
- $ref: '#/components/schemas/CaseTriggerWrapper'
|
32106
|
+
- $ref: '#/components/schemas/ChangeEventTriggerWrapper'
|
32107
|
+
- $ref: '#/components/schemas/DashboardTriggerWrapper'
|
32108
|
+
- $ref: '#/components/schemas/GithubWebhookTriggerWrapper'
|
32109
|
+
- $ref: '#/components/schemas/IncidentTriggerWrapper'
|
32110
|
+
- $ref: '#/components/schemas/MonitorTriggerWrapper'
|
32111
|
+
- $ref: '#/components/schemas/ScheduleTriggerWrapper'
|
32112
|
+
- $ref: '#/components/schemas/SecurityTriggerWrapper'
|
32113
|
+
- $ref: '#/components/schemas/SlackTriggerWrapper'
|
32114
|
+
- $ref: '#/components/schemas/WorkflowTriggerWrapper'
|
32115
|
+
TriggerRateLimit:
|
32116
|
+
description: Defines a rate limit for a trigger.
|
32117
|
+
properties:
|
32118
|
+
count:
|
32119
|
+
description: The `TriggerRateLimit` `count`.
|
32120
|
+
format: int64
|
32121
|
+
type: integer
|
32122
|
+
interval:
|
32123
|
+
description: The `TriggerRateLimit` `interval`. The expected format is the
|
32124
|
+
number of seconds ending with an s. For example, 1 day is 86400s
|
32125
|
+
type: string
|
32126
|
+
type: object
|
29641
32127
|
TriggerSource:
|
29642
32128
|
description: 'The type of security issues on which the rule applies. Notification
|
29643
32129
|
rules based on security signals need to use the trigger source "security_signals",
|
@@ -29927,6 +32413,81 @@ components:
|
|
29927
32413
|
type:
|
29928
32414
|
$ref: '#/components/schemas/RuleType'
|
29929
32415
|
type: object
|
32416
|
+
UpdateWorkflowRequest:
|
32417
|
+
description: A request object for updating an existing workflow.
|
32418
|
+
example:
|
32419
|
+
data:
|
32420
|
+
attributes:
|
32421
|
+
description: A sample workflow.
|
32422
|
+
name: Example Workflow
|
32423
|
+
published: true
|
32424
|
+
spec:
|
32425
|
+
annotations:
|
32426
|
+
- display:
|
32427
|
+
bounds:
|
32428
|
+
height: 150
|
32429
|
+
width: 300
|
32430
|
+
x: -375
|
32431
|
+
y: -0.5
|
32432
|
+
id: 99999999-9999-9999-9999-999999999999
|
32433
|
+
markdownTextAnnotation:
|
32434
|
+
text: Example annotation.
|
32435
|
+
connectionEnvs:
|
32436
|
+
- connections:
|
32437
|
+
- connectionId: 11111111-1111-1111-1111-111111111111
|
32438
|
+
label: INTEGRATION_DATADOG
|
32439
|
+
env: default
|
32440
|
+
handle: my-handle
|
32441
|
+
inputSchema:
|
32442
|
+
parameters:
|
32443
|
+
- defaultValue: default
|
32444
|
+
name: input
|
32445
|
+
type: STRING
|
32446
|
+
outputSchema:
|
32447
|
+
parameters:
|
32448
|
+
- name: output
|
32449
|
+
type: ARRAY_OBJECT
|
32450
|
+
value: '{{ Steps.Step1 }}'
|
32451
|
+
steps:
|
32452
|
+
- actionId: com.datadoghq.dd.monitor.listMonitors
|
32453
|
+
connectionLabel: INTEGRATION_DATADOG
|
32454
|
+
name: Step1
|
32455
|
+
outboundEdges:
|
32456
|
+
- branchName: main
|
32457
|
+
nextStepName: Step2
|
32458
|
+
parameters:
|
32459
|
+
- name: tags
|
32460
|
+
value: service:monitoring
|
32461
|
+
- actionId: com.datadoghq.core.noop
|
32462
|
+
name: Step2
|
32463
|
+
triggers:
|
32464
|
+
- monitorTrigger:
|
32465
|
+
rateLimit:
|
32466
|
+
count: 1
|
32467
|
+
interval: 3600s
|
32468
|
+
startStepNames:
|
32469
|
+
- Step1
|
32470
|
+
- githubWebhookTrigger: {}
|
32471
|
+
startStepNames:
|
32472
|
+
- Step1
|
32473
|
+
tags:
|
32474
|
+
- team:infra
|
32475
|
+
- service:monitoring
|
32476
|
+
- foo:bar
|
32477
|
+
id: 22222222-2222-2222-2222-222222222222
|
32478
|
+
type: workflows
|
32479
|
+
properties:
|
32480
|
+
data:
|
32481
|
+
$ref: '#/components/schemas/WorkflowDataUpdate'
|
32482
|
+
required:
|
32483
|
+
- data
|
32484
|
+
type: object
|
32485
|
+
UpdateWorkflowResponse:
|
32486
|
+
description: The response object after updating a workflow.
|
32487
|
+
properties:
|
32488
|
+
data:
|
32489
|
+
$ref: '#/components/schemas/WorkflowDataUpdate'
|
32490
|
+
type: object
|
29930
32491
|
UpsertCatalogEntityRequest:
|
29931
32492
|
description: Create or update entity request.
|
29932
32493
|
oneOf:
|
@@ -30978,6 +33539,134 @@ components:
|
|
30978
33539
|
- PAST_SIX_MONTHS
|
30979
33540
|
- PAST_ONE_YEAR
|
30980
33541
|
- ALERT
|
33542
|
+
WorkflowData:
|
33543
|
+
description: Data related to the workflow.
|
33544
|
+
properties:
|
33545
|
+
attributes:
|
33546
|
+
$ref: '#/components/schemas/WorkflowDataAttributes'
|
33547
|
+
id:
|
33548
|
+
description: The workflow identifier
|
33549
|
+
readOnly: true
|
33550
|
+
type: string
|
33551
|
+
relationships:
|
33552
|
+
$ref: '#/components/schemas/WorkflowDataRelationships'
|
33553
|
+
type:
|
33554
|
+
$ref: '#/components/schemas/WorkflowDataType'
|
33555
|
+
required:
|
33556
|
+
- type
|
33557
|
+
- attributes
|
33558
|
+
type: object
|
33559
|
+
WorkflowDataAttributes:
|
33560
|
+
description: The definition of `WorkflowDataAttributes` object.
|
33561
|
+
properties:
|
33562
|
+
createdAt:
|
33563
|
+
description: When the workflow was created.
|
33564
|
+
format: date-time
|
33565
|
+
readOnly: true
|
33566
|
+
type: string
|
33567
|
+
description:
|
33568
|
+
description: Description of the workflow.
|
33569
|
+
type: string
|
33570
|
+
name:
|
33571
|
+
description: Name of the workflow.
|
33572
|
+
example: ''
|
33573
|
+
type: string
|
33574
|
+
published:
|
33575
|
+
description: Set the workflow to published or unpublished. Workflows in
|
33576
|
+
an unpublished state will only be executable via manual runs. Automatic
|
33577
|
+
triggers such as Schedule will not execute the workflow until it is published.
|
33578
|
+
type: boolean
|
33579
|
+
spec:
|
33580
|
+
$ref: '#/components/schemas/Spec'
|
33581
|
+
tags:
|
33582
|
+
description: Tags of the workflow.
|
33583
|
+
items:
|
33584
|
+
type: string
|
33585
|
+
type: array
|
33586
|
+
updatedAt:
|
33587
|
+
description: When the workflow was last updated.
|
33588
|
+
format: date-time
|
33589
|
+
readOnly: true
|
33590
|
+
type: string
|
33591
|
+
webhookSecret:
|
33592
|
+
description: If a Webhook trigger is defined on this workflow, a webhookSecret
|
33593
|
+
is required and should be provided here.
|
33594
|
+
type: string
|
33595
|
+
writeOnly: true
|
33596
|
+
required:
|
33597
|
+
- name
|
33598
|
+
- spec
|
33599
|
+
type: object
|
33600
|
+
WorkflowDataRelationships:
|
33601
|
+
description: The definition of `WorkflowDataRelationships` object.
|
33602
|
+
properties:
|
33603
|
+
creator:
|
33604
|
+
$ref: '#/components/schemas/WorkflowUserRelationship'
|
33605
|
+
owner:
|
33606
|
+
$ref: '#/components/schemas/WorkflowUserRelationship'
|
33607
|
+
readOnly: true
|
33608
|
+
type: object
|
33609
|
+
WorkflowDataType:
|
33610
|
+
description: The definition of `WorkflowDataType` object.
|
33611
|
+
enum:
|
33612
|
+
- workflows
|
33613
|
+
example: workflows
|
33614
|
+
type: string
|
33615
|
+
x-enum-varnames:
|
33616
|
+
- WORKFLOWS
|
33617
|
+
WorkflowDataUpdate:
|
33618
|
+
description: Data related to the workflow being updated.
|
33619
|
+
properties:
|
33620
|
+
attributes:
|
33621
|
+
$ref: '#/components/schemas/WorkflowDataUpdateAttributes'
|
33622
|
+
id:
|
33623
|
+
description: The workflow identifier
|
33624
|
+
type: string
|
33625
|
+
relationships:
|
33626
|
+
$ref: '#/components/schemas/WorkflowDataRelationships'
|
33627
|
+
type:
|
33628
|
+
$ref: '#/components/schemas/WorkflowDataType'
|
33629
|
+
required:
|
33630
|
+
- type
|
33631
|
+
- attributes
|
33632
|
+
type: object
|
33633
|
+
WorkflowDataUpdateAttributes:
|
33634
|
+
description: The definition of `WorkflowDataUpdateAttributes` object.
|
33635
|
+
properties:
|
33636
|
+
createdAt:
|
33637
|
+
description: When the workflow was created.
|
33638
|
+
format: date-time
|
33639
|
+
readOnly: true
|
33640
|
+
type: string
|
33641
|
+
description:
|
33642
|
+
description: Description of the workflow.
|
33643
|
+
type: string
|
33644
|
+
name:
|
33645
|
+
description: Name of the workflow.
|
33646
|
+
type: string
|
33647
|
+
published:
|
33648
|
+
description: Set the workflow to published or unpublished. Workflows in
|
33649
|
+
an unpublished state will only be executable via manual runs. Automatic
|
33650
|
+
triggers such as Schedule will not execute the workflow until it is published.
|
33651
|
+
type: boolean
|
33652
|
+
spec:
|
33653
|
+
$ref: '#/components/schemas/Spec'
|
33654
|
+
tags:
|
33655
|
+
description: Tags of the workflow.
|
33656
|
+
items:
|
33657
|
+
type: string
|
33658
|
+
type: array
|
33659
|
+
updatedAt:
|
33660
|
+
description: When the workflow was last updated.
|
33661
|
+
format: date-time
|
33662
|
+
readOnly: true
|
33663
|
+
type: string
|
33664
|
+
webhookSecret:
|
33665
|
+
description: If a Webhook trigger is defined on this workflow, a webhookSecret
|
33666
|
+
is required and should be provided here.
|
33667
|
+
type: string
|
33668
|
+
writeOnly: true
|
33669
|
+
type: object
|
30981
33670
|
WorkflowInstanceCreateMeta:
|
30982
33671
|
description: Additional information for creating a workflow instance.
|
30983
33672
|
properties:
|
@@ -31044,6 +33733,45 @@ components:
|
|
31044
33733
|
format: int64
|
31045
33734
|
type: integer
|
31046
33735
|
type: object
|
33736
|
+
WorkflowTriggerWrapper:
|
33737
|
+
description: Schema for a Workflow-based trigger.
|
33738
|
+
properties:
|
33739
|
+
startStepNames:
|
33740
|
+
$ref: '#/components/schemas/StartStepNames'
|
33741
|
+
workflowTrigger:
|
33742
|
+
description: Trigger a workflow VIA the Datadog UI. Only required if no
|
33743
|
+
other trigger exists.
|
33744
|
+
type: object
|
33745
|
+
required:
|
33746
|
+
- workflowTrigger
|
33747
|
+
type: object
|
33748
|
+
WorkflowUserRelationship:
|
33749
|
+
description: The definition of `WorkflowUserRelationship` object.
|
33750
|
+
properties:
|
33751
|
+
data:
|
33752
|
+
$ref: '#/components/schemas/WorkflowUserRelationshipData'
|
33753
|
+
type: object
|
33754
|
+
WorkflowUserRelationshipData:
|
33755
|
+
description: The definition of `WorkflowUserRelationshipData` object.
|
33756
|
+
properties:
|
33757
|
+
id:
|
33758
|
+
description: The user identifier
|
33759
|
+
example: ''
|
33760
|
+
type: string
|
33761
|
+
type:
|
33762
|
+
$ref: '#/components/schemas/WorkflowUserRelationshipType'
|
33763
|
+
required:
|
33764
|
+
- type
|
33765
|
+
- id
|
33766
|
+
type: object
|
33767
|
+
WorkflowUserRelationshipType:
|
33768
|
+
description: The definition of `WorkflowUserRelationshipType` object.
|
33769
|
+
enum:
|
33770
|
+
- users
|
33771
|
+
example: users
|
33772
|
+
type: string
|
33773
|
+
x-enum-varnames:
|
33774
|
+
- USERS
|
31047
33775
|
WorklflowCancelInstanceResponse:
|
31048
33776
|
description: Information about the canceled instance.
|
31049
33777
|
properties:
|
@@ -31088,6 +33816,7 @@ components:
|
|
31088
33816
|
type: boolean
|
31089
33817
|
required:
|
31090
33818
|
- include_all
|
33819
|
+
type: object
|
31091
33820
|
XRayServicesIncludeOnly:
|
31092
33821
|
description: Include only these services. Defaults to `[]`.
|
31093
33822
|
nullable: true
|
@@ -31102,6 +33831,7 @@ components:
|
|
31102
33831
|
type: array
|
31103
33832
|
required:
|
31104
33833
|
- include_only
|
33834
|
+
type: object
|
31105
33835
|
XRayServicesList:
|
31106
33836
|
description: AWS X-Ray services to collect traces from. Defaults to `include_only`.
|
31107
33837
|
oneOf:
|
@@ -31120,6 +33850,9 @@ components:
|
|
31120
33850
|
apm_service_catalog_read: View service catalog and service definitions.
|
31121
33851
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
31122
33852
|
when those definitions are maintained by Datadog.
|
33853
|
+
appsec_vm_read: View infrastructure, application code, and library vulnerabilities.
|
33854
|
+
This does not restrict API or inventory SQL access to the vulnerability
|
33855
|
+
data source.
|
31123
33856
|
cases_read: View Cases.
|
31124
33857
|
cases_write: Create and update cases.
|
31125
33858
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
@@ -31403,7 +34136,7 @@ paths:
|
|
31403
34136
|
content:
|
31404
34137
|
application/json:
|
31405
34138
|
schema:
|
31406
|
-
$ref: '#/components/schemas/
|
34139
|
+
$ref: '#/components/schemas/AwsScanOptionsListResponse'
|
31407
34140
|
description: OK
|
31408
34141
|
'403':
|
31409
34142
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
@@ -31412,6 +34145,165 @@ paths:
|
|
31412
34145
|
summary: Get AWS Scan Options
|
31413
34146
|
tags:
|
31414
34147
|
- Agentless Scanning
|
34148
|
+
post:
|
34149
|
+
description: Activate Agentless scan options for an AWS account.
|
34150
|
+
operationId: CreateAwsScanOptions
|
34151
|
+
requestBody:
|
34152
|
+
content:
|
34153
|
+
application/json:
|
34154
|
+
schema:
|
34155
|
+
$ref: '#/components/schemas/AwsScanOptionsCreateRequest'
|
34156
|
+
description: The definition of the new scan options.
|
34157
|
+
required: true
|
34158
|
+
responses:
|
34159
|
+
'201':
|
34160
|
+
content:
|
34161
|
+
application/json:
|
34162
|
+
schema:
|
34163
|
+
$ref: '#/components/schemas/AwsScanOptionsResponse'
|
34164
|
+
description: Agentless scan options enabled successfully.
|
34165
|
+
'400':
|
34166
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34167
|
+
'403':
|
34168
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34169
|
+
'409':
|
34170
|
+
$ref: '#/components/responses/ConflictResponse'
|
34171
|
+
'429':
|
34172
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34173
|
+
summary: Post AWS Scan Options
|
34174
|
+
tags:
|
34175
|
+
- Agentless Scanning
|
34176
|
+
x-codegen-request-body-name: body
|
34177
|
+
/api/v2/agentless_scanning/accounts/aws/{account_id}:
|
34178
|
+
delete:
|
34179
|
+
description: Delete Agentless scan options for an AWS account.
|
34180
|
+
operationId: DeleteAwsScanOptions
|
34181
|
+
parameters:
|
34182
|
+
- $ref: '#/components/parameters/AwsAccountId'
|
34183
|
+
responses:
|
34184
|
+
'204':
|
34185
|
+
description: No Content
|
34186
|
+
'400':
|
34187
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34188
|
+
'403':
|
34189
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34190
|
+
'404':
|
34191
|
+
$ref: '#/components/responses/NotFoundResponse'
|
34192
|
+
'429':
|
34193
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34194
|
+
summary: Delete AWS Scan Options
|
34195
|
+
tags:
|
34196
|
+
- Agentless Scanning
|
34197
|
+
patch:
|
34198
|
+
description: Update the Agentless scan options for an activated account.
|
34199
|
+
operationId: UpdateAwsScanOptions
|
34200
|
+
parameters:
|
34201
|
+
- $ref: '#/components/parameters/AwsAccountId'
|
34202
|
+
requestBody:
|
34203
|
+
content:
|
34204
|
+
application/json:
|
34205
|
+
schema:
|
34206
|
+
$ref: '#/components/schemas/AwsScanOptionsUpdateRequest'
|
34207
|
+
description: New definition of the scan options.
|
34208
|
+
required: true
|
34209
|
+
responses:
|
34210
|
+
'204':
|
34211
|
+
description: No Content
|
34212
|
+
'400':
|
34213
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34214
|
+
'403':
|
34215
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34216
|
+
'404':
|
34217
|
+
$ref: '#/components/responses/NotFoundResponse'
|
34218
|
+
'429':
|
34219
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34220
|
+
summary: Patch AWS Scan Options
|
34221
|
+
tags:
|
34222
|
+
- Agentless Scanning
|
34223
|
+
x-codegen-request-body-name: body
|
34224
|
+
/api/v2/agentless_scanning/ondemand/aws:
|
34225
|
+
get:
|
34226
|
+
description: Fetches the most recent 1000 AWS on demand tasks.
|
34227
|
+
operationId: ListAwsOnDemandTasks
|
34228
|
+
responses:
|
34229
|
+
'200':
|
34230
|
+
content:
|
34231
|
+
application/json:
|
34232
|
+
schema:
|
34233
|
+
$ref: '#/components/schemas/AwsOnDemandListResponse'
|
34234
|
+
description: OK
|
34235
|
+
'403':
|
34236
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34237
|
+
'429':
|
34238
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34239
|
+
summary: Get AWS On Demand tasks
|
34240
|
+
tags:
|
34241
|
+
- Agentless Scanning
|
34242
|
+
x-permission:
|
34243
|
+
operator: OR
|
34244
|
+
permissions:
|
34245
|
+
- security_monitoring_findings_read
|
34246
|
+
post:
|
34247
|
+
description: Trigger the scan of an AWS resource with a high priority. Agentless
|
34248
|
+
scanning must be activated for the AWS account containing the resource to
|
34249
|
+
scan.
|
34250
|
+
operationId: CreateAwsOnDemandTask
|
34251
|
+
requestBody:
|
34252
|
+
content:
|
34253
|
+
application/json:
|
34254
|
+
schema:
|
34255
|
+
$ref: '#/components/schemas/AwsOnDemandCreateRequest'
|
34256
|
+
description: The definition of the on demand task.
|
34257
|
+
required: true
|
34258
|
+
responses:
|
34259
|
+
'201':
|
34260
|
+
content:
|
34261
|
+
application/json:
|
34262
|
+
schema:
|
34263
|
+
$ref: '#/components/schemas/AwsOnDemandResponse'
|
34264
|
+
description: AWS on demand task created successfully.
|
34265
|
+
'400':
|
34266
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34267
|
+
'403':
|
34268
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34269
|
+
'429':
|
34270
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34271
|
+
summary: Post an AWS on demand task
|
34272
|
+
tags:
|
34273
|
+
- Agentless Scanning
|
34274
|
+
x-codegen-request-body-name: body
|
34275
|
+
x-permission:
|
34276
|
+
operator: OR
|
34277
|
+
permissions:
|
34278
|
+
- security_monitoring_findings_write
|
34279
|
+
/api/v2/agentless_scanning/ondemand/aws/{task_id}:
|
34280
|
+
get:
|
34281
|
+
description: Fetch the data of a specific on demand task.
|
34282
|
+
operationId: GetAwsOnDemandTask
|
34283
|
+
parameters:
|
34284
|
+
- $ref: '#/components/parameters/OnDemandTaskId'
|
34285
|
+
responses:
|
34286
|
+
'200':
|
34287
|
+
content:
|
34288
|
+
application/json:
|
34289
|
+
schema:
|
34290
|
+
$ref: '#/components/schemas/AwsOnDemandResponse'
|
34291
|
+
description: OK.
|
34292
|
+
'400':
|
34293
|
+
$ref: '#/components/responses/BadRequestResponse'
|
34294
|
+
'403':
|
34295
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
34296
|
+
'404':
|
34297
|
+
$ref: '#/components/responses/NotFoundResponse'
|
34298
|
+
'429':
|
34299
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
34300
|
+
summary: Get AWS On Demand task by id
|
34301
|
+
tags:
|
34302
|
+
- Agentless Scanning
|
34303
|
+
x-permission:
|
34304
|
+
operator: OR
|
34305
|
+
permissions:
|
34306
|
+
- security_monitoring_findings_read
|
31415
34307
|
/api/v2/api_keys:
|
31416
34308
|
get:
|
31417
34309
|
description: List all API keys available for your account.
|
@@ -31606,6 +34498,7 @@ paths:
|
|
31606
34498
|
- api_keys_write
|
31607
34499
|
/api/v2/apicatalog/api:
|
31608
34500
|
get:
|
34501
|
+
deprecated: true
|
31609
34502
|
description: List APIs and their IDs.
|
31610
34503
|
operationId: ListAPIs
|
31611
34504
|
parameters:
|
@@ -31667,11 +34560,10 @@ paths:
|
|
31667
34560
|
operator: OR
|
31668
34561
|
permissions:
|
31669
34562
|
- 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/).'
|
34563
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31673
34564
|
/api/v2/apicatalog/api/{id}:
|
31674
34565
|
delete:
|
34566
|
+
deprecated: true
|
31675
34567
|
description: Delete a specific API by ID.
|
31676
34568
|
operationId: DeleteOpenAPI
|
31677
34569
|
parameters:
|
@@ -31716,11 +34608,10 @@ paths:
|
|
31716
34608
|
operator: OR
|
31717
34609
|
permissions:
|
31718
34610
|
- 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/).'
|
34611
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31722
34612
|
/api/v2/apicatalog/api/{id}/openapi:
|
31723
34613
|
get:
|
34614
|
+
deprecated: true
|
31724
34615
|
description: Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
31725
34616
|
format file.
|
31726
34617
|
operationId: GetOpenAPI
|
@@ -31771,10 +34662,9 @@ paths:
|
|
31771
34662
|
operator: OR
|
31772
34663
|
permissions:
|
31773
34664
|
- 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/).'
|
34665
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31777
34666
|
put:
|
34667
|
+
deprecated: true
|
31778
34668
|
description: 'Update information about a specific API. The given content will
|
31779
34669
|
replace all API content of the given ID.
|
31780
34670
|
|
@@ -31835,11 +34725,10 @@ paths:
|
|
31835
34725
|
operator: OR
|
31836
34726
|
permissions:
|
31837
34727
|
- 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/).'
|
34728
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31841
34729
|
/api/v2/apicatalog/openapi:
|
31842
34730
|
post:
|
34731
|
+
deprecated: true
|
31843
34732
|
description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
31844
34733
|
specification given.
|
31845
34734
|
|
@@ -31891,9 +34780,7 @@ paths:
|
|
31891
34780
|
operator: OR
|
31892
34781
|
permissions:
|
31893
34782
|
- 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/).'
|
34783
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31897
34784
|
/api/v2/apm/config/metrics:
|
31898
34785
|
get:
|
31899
34786
|
description: Get the list of configured span-based metrics with their definitions.
|
@@ -32266,8 +35153,6 @@ paths:
|
|
32266
35153
|
operator: OR
|
32267
35154
|
permissions:
|
32268
35155
|
- apps_write
|
32269
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32270
|
-
and might change at any time.'
|
32271
35156
|
get:
|
32272
35157
|
description: List all apps, with optional filters and sorting. This endpoint
|
32273
35158
|
is paginated. Only basic app information such as the app ID, name, and description
|
@@ -32376,8 +35261,6 @@ paths:
|
|
32376
35261
|
operator: OR
|
32377
35262
|
permissions:
|
32378
35263
|
- apps_run
|
32379
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32380
|
-
and might change at any time.'
|
32381
35264
|
post:
|
32382
35265
|
description: Create a new app, returning the app ID.
|
32383
35266
|
operationId: CreateApp
|
@@ -32417,8 +35300,6 @@ paths:
|
|
32417
35300
|
- apps_write
|
32418
35301
|
- connections_resolve
|
32419
35302
|
- workflows_run
|
32420
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32421
|
-
and might change at any time.'
|
32422
35303
|
/api/v2/app-builder/apps/{app_id}:
|
32423
35304
|
delete:
|
32424
35305
|
description: Delete a single app.
|
@@ -32472,8 +35353,6 @@ paths:
|
|
32472
35353
|
operator: OR
|
32473
35354
|
permissions:
|
32474
35355
|
- apps_write
|
32475
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32476
|
-
and might change at any time.'
|
32477
35356
|
get:
|
32478
35357
|
description: Get the full definition of an app.
|
32479
35358
|
operationId: GetApp
|
@@ -32520,6 +35399,12 @@ paths:
|
|
32520
35399
|
schema:
|
32521
35400
|
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
32522
35401
|
description: Not Found
|
35402
|
+
'410':
|
35403
|
+
content:
|
35404
|
+
application/json:
|
35405
|
+
schema:
|
35406
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
35407
|
+
description: Gone
|
32523
35408
|
'429':
|
32524
35409
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
32525
35410
|
summary: Get App
|
@@ -32530,8 +35415,6 @@ paths:
|
|
32530
35415
|
permissions:
|
32531
35416
|
- apps_run
|
32532
35417
|
- connections_read
|
32533
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32534
|
-
and might change at any time.'
|
32535
35418
|
patch:
|
32536
35419
|
description: Update an existing app. This creates a new version of the app.
|
32537
35420
|
operationId: UpdateApp
|
@@ -32580,8 +35463,6 @@ paths:
|
|
32580
35463
|
- apps_write
|
32581
35464
|
- connections_resolve
|
32582
35465
|
- workflows_run
|
32583
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32584
|
-
and might change at any time.'
|
32585
35466
|
/api/v2/app-builder/apps/{app_id}/deployment:
|
32586
35467
|
delete:
|
32587
35468
|
description: Unpublish an app, removing the live version of the app. Unpublishing
|
@@ -32632,8 +35513,6 @@ paths:
|
|
32632
35513
|
operator: OR
|
32633
35514
|
permissions:
|
32634
35515
|
- apps_write
|
32635
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32636
|
-
and might change at any time.'
|
32637
35516
|
post:
|
32638
35517
|
description: Publish an app for use by other users. To ensure the app is accessible
|
32639
35518
|
to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/)
|
@@ -32682,8 +35561,6 @@ paths:
|
|
32682
35561
|
operator: OR
|
32683
35562
|
permissions:
|
32684
35563
|
- apps_write
|
32685
|
-
x-unstable: '**Note**: App Builder API endpoints are still under active development
|
32686
|
-
and might change at any time.'
|
32687
35564
|
/api/v2/application_keys:
|
32688
35565
|
get:
|
32689
35566
|
description: List all application keys available for your org
|
@@ -33696,7 +36573,7 @@ paths:
|
|
33696
36573
|
- Software Catalog
|
33697
36574
|
x-pagination:
|
33698
36575
|
limitParam: page[limit]
|
33699
|
-
|
36576
|
+
pageOffsetParam: page[offset]
|
33700
36577
|
resultsPath: data
|
33701
36578
|
post:
|
33702
36579
|
description: Create or update entities in Software Catalog.
|
@@ -34445,7 +37322,8 @@ paths:
|
|
34445
37322
|
permissions:
|
34446
37323
|
- cloud_cost_management_write
|
34447
37324
|
patch:
|
34448
|
-
description: Update the status
|
37325
|
+
description: Update the status (active/archived) and/or account filtering configuration
|
37326
|
+
of an AWS CUR config.
|
34449
37327
|
operationId: UpdateCostAWSCURConfig
|
34450
37328
|
parameters:
|
34451
37329
|
- $ref: '#/components/parameters/CloudAccountID'
|
@@ -40197,7 +43075,7 @@ paths:
|
|
40197
43075
|
required: false
|
40198
43076
|
schema:
|
40199
43077
|
type: boolean
|
40200
|
-
- description: '(
|
43078
|
+
- description: '(Preview) Filter custom metrics that have or have not been queried
|
40201
43079
|
in the specified window[seconds].
|
40202
43080
|
|
40203
43081
|
If no window is provided or the window is less than 2 hours, a default of
|
@@ -40218,6 +43096,14 @@ paths:
|
|
40218
43096
|
required: false
|
40219
43097
|
schema:
|
40220
43098
|
type: string
|
43099
|
+
- description: (Preview) Filter metrics that are used in dashboards, monitors,
|
43100
|
+
notebooks, SLOs.
|
43101
|
+
example: true
|
43102
|
+
in: query
|
43103
|
+
name: filter[related_assets]
|
43104
|
+
required: false
|
43105
|
+
schema:
|
43106
|
+
type: boolean
|
40221
43107
|
- description: 'The number of seconds of look back (from now) to apply to a
|
40222
43108
|
filter[tag] or filter[queried] query.
|
40223
43109
|
|
@@ -42100,6 +44986,285 @@ paths:
|
|
42100
44986
|
operator: OR
|
42101
44987
|
permissions:
|
42102
44988
|
- timeseries_query
|
44989
|
+
/api/v2/remote_config/products/asm/waf/custom_rules:
|
44990
|
+
get:
|
44991
|
+
description: Retrieve a list of WAF custom rule.
|
44992
|
+
operationId: ListApplicationSecurityWAFCustomRules
|
44993
|
+
responses:
|
44994
|
+
'200':
|
44995
|
+
content:
|
44996
|
+
application/json:
|
44997
|
+
schema:
|
44998
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleListResponse'
|
44999
|
+
description: OK
|
45000
|
+
'403':
|
45001
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45002
|
+
'429':
|
45003
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45004
|
+
summary: List all WAF custom rules
|
45005
|
+
tags:
|
45006
|
+
- Application Security
|
45007
|
+
post:
|
45008
|
+
description: Create a new WAF custom rule with the given parameters.
|
45009
|
+
operationId: CreateApplicationSecurityWafCustomRule
|
45010
|
+
requestBody:
|
45011
|
+
content:
|
45012
|
+
application/json:
|
45013
|
+
schema:
|
45014
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateRequest'
|
45015
|
+
description: The definition of the new WAF Custom Rule.
|
45016
|
+
required: true
|
45017
|
+
responses:
|
45018
|
+
'201':
|
45019
|
+
content:
|
45020
|
+
application/json:
|
45021
|
+
schema:
|
45022
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
|
45023
|
+
description: Created
|
45024
|
+
'400':
|
45025
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45026
|
+
'403':
|
45027
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45028
|
+
'409':
|
45029
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45030
|
+
'429':
|
45031
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45032
|
+
summary: Create a WAF custom rule
|
45033
|
+
tags:
|
45034
|
+
- Application Security
|
45035
|
+
x-codegen-request-body-name: body
|
45036
|
+
/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}:
|
45037
|
+
delete:
|
45038
|
+
description: Delete a specific WAF custom rule.
|
45039
|
+
operationId: DeleteApplicationSecurityWafCustomRule
|
45040
|
+
parameters:
|
45041
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam'
|
45042
|
+
responses:
|
45043
|
+
'204':
|
45044
|
+
description: No Content
|
45045
|
+
'403':
|
45046
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45047
|
+
'404':
|
45048
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45049
|
+
'409':
|
45050
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45051
|
+
'429':
|
45052
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45053
|
+
summary: Delete a WAF Custom Rule
|
45054
|
+
tags:
|
45055
|
+
- Application Security
|
45056
|
+
x-terraform-resource: appsec_waf_custom_rule
|
45057
|
+
get:
|
45058
|
+
description: Retrieve a WAF custom rule by ID.
|
45059
|
+
operationId: GetApplicationSecurityWafCustomRule
|
45060
|
+
parameters:
|
45061
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam'
|
45062
|
+
responses:
|
45063
|
+
'200':
|
45064
|
+
content:
|
45065
|
+
application/json:
|
45066
|
+
schema:
|
45067
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
|
45068
|
+
description: OK
|
45069
|
+
'403':
|
45070
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45071
|
+
'429':
|
45072
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45073
|
+
summary: Get a WAF custom rule
|
45074
|
+
tags:
|
45075
|
+
- Application Security
|
45076
|
+
x-terraform-resource: appsec_waf_custom_rule
|
45077
|
+
put:
|
45078
|
+
description: 'Update a specific WAF custom Rule.
|
45079
|
+
|
45080
|
+
Returns the Custom Rule object when the request is successful.'
|
45081
|
+
operationId: UpdateApplicationSecurityWafCustomRule
|
45082
|
+
parameters:
|
45083
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam'
|
45084
|
+
requestBody:
|
45085
|
+
content:
|
45086
|
+
application/json:
|
45087
|
+
schema:
|
45088
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateRequest'
|
45089
|
+
description: New definition of the WAF Custom Rule.
|
45090
|
+
required: true
|
45091
|
+
responses:
|
45092
|
+
'200':
|
45093
|
+
content:
|
45094
|
+
application/json:
|
45095
|
+
schema:
|
45096
|
+
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
|
45097
|
+
description: OK
|
45098
|
+
'400':
|
45099
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45100
|
+
'403':
|
45101
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45102
|
+
'404':
|
45103
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45104
|
+
'409':
|
45105
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45106
|
+
'429':
|
45107
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45108
|
+
summary: Update a WAF Custom Rule
|
45109
|
+
tags:
|
45110
|
+
- Application Security
|
45111
|
+
x-codegen-request-body-name: body
|
45112
|
+
x-terraform-resource: appsec_waf_custom_rule
|
45113
|
+
/api/v2/remote_config/products/asm/waf/exclusion_filters:
|
45114
|
+
get:
|
45115
|
+
description: Retrieve a list of WAF exclusion filters.
|
45116
|
+
operationId: ListApplicationSecurityWafExclusionFilters
|
45117
|
+
responses:
|
45118
|
+
'200':
|
45119
|
+
content:
|
45120
|
+
application/json:
|
45121
|
+
schema:
|
45122
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse'
|
45123
|
+
description: OK
|
45124
|
+
'403':
|
45125
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45126
|
+
'429':
|
45127
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45128
|
+
summary: List all WAF exclusion filters
|
45129
|
+
tags:
|
45130
|
+
- Application Security
|
45131
|
+
x-permission:
|
45132
|
+
operator: AND
|
45133
|
+
permissions:
|
45134
|
+
- appsec_protect_read
|
45135
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45136
|
+
post:
|
45137
|
+
description: 'Create a new WAF exclusion filter with the given parameters.
|
45138
|
+
|
45139
|
+
|
45140
|
+
A request matched by an exclusion filter will be ignored by the Application
|
45141
|
+
Security WAF product.
|
45142
|
+
|
45143
|
+
Go to https://app.datadoghq.com/security/appsec/passlist to review existing
|
45144
|
+
exclusion filters (also called passlist entries).'
|
45145
|
+
operationId: CreateApplicationSecurityWafExclusionFilter
|
45146
|
+
requestBody:
|
45147
|
+
content:
|
45148
|
+
application/json:
|
45149
|
+
schema:
|
45150
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateRequest'
|
45151
|
+
description: The definition of the new WAF exclusion filter.
|
45152
|
+
required: true
|
45153
|
+
responses:
|
45154
|
+
'200':
|
45155
|
+
content:
|
45156
|
+
application/json:
|
45157
|
+
schema:
|
45158
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
|
45159
|
+
description: OK
|
45160
|
+
'400':
|
45161
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45162
|
+
'403':
|
45163
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45164
|
+
'409':
|
45165
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45166
|
+
'429':
|
45167
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45168
|
+
summary: Create a WAF exclusion filter
|
45169
|
+
tags:
|
45170
|
+
- Application Security
|
45171
|
+
x-codegen-request-body-name: body
|
45172
|
+
x-permission:
|
45173
|
+
operator: AND
|
45174
|
+
permissions:
|
45175
|
+
- appsec_protect_write
|
45176
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45177
|
+
/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}:
|
45178
|
+
delete:
|
45179
|
+
description: Delete a specific WAF exclusion filter using its identifier.
|
45180
|
+
operationId: DeleteApplicationSecurityWafExclusionFilter
|
45181
|
+
parameters:
|
45182
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID'
|
45183
|
+
responses:
|
45184
|
+
'204':
|
45185
|
+
description: OK
|
45186
|
+
'403':
|
45187
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45188
|
+
'404':
|
45189
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45190
|
+
'409':
|
45191
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45192
|
+
'429':
|
45193
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45194
|
+
summary: Delete a WAF exclusion filter
|
45195
|
+
tags:
|
45196
|
+
- Application Security
|
45197
|
+
x-permission:
|
45198
|
+
operator: AND
|
45199
|
+
permissions:
|
45200
|
+
- appsec_protect_write
|
45201
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45202
|
+
get:
|
45203
|
+
description: Retrieve a specific WAF exclusion filter using its identifier.
|
45204
|
+
operationId: GetApplicationSecurityWafExclusionFilter
|
45205
|
+
parameters:
|
45206
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID'
|
45207
|
+
responses:
|
45208
|
+
'200':
|
45209
|
+
content:
|
45210
|
+
application/json:
|
45211
|
+
schema:
|
45212
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
|
45213
|
+
description: OK
|
45214
|
+
'403':
|
45215
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45216
|
+
'404':
|
45217
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45218
|
+
'429':
|
45219
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45220
|
+
summary: Get a WAF exclusion filter
|
45221
|
+
tags:
|
45222
|
+
- Application Security
|
45223
|
+
x-permission:
|
45224
|
+
operator: AND
|
45225
|
+
permissions:
|
45226
|
+
- appsec_protect_read
|
45227
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
45228
|
+
put:
|
45229
|
+
description: 'Update a specific WAF exclusion filter using its identifier.
|
45230
|
+
|
45231
|
+
Returns the exclusion filter object when the request is successful.'
|
45232
|
+
operationId: UpdateApplicationSecurityWafExclusionFilter
|
45233
|
+
parameters:
|
45234
|
+
- $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID'
|
45235
|
+
requestBody:
|
45236
|
+
content:
|
45237
|
+
application/json:
|
45238
|
+
schema:
|
45239
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateRequest'
|
45240
|
+
description: The exclusion filter to update.
|
45241
|
+
required: true
|
45242
|
+
responses:
|
45243
|
+
'200':
|
45244
|
+
content:
|
45245
|
+
application/json:
|
45246
|
+
schema:
|
45247
|
+
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
|
45248
|
+
description: OK
|
45249
|
+
'400':
|
45250
|
+
$ref: '#/components/responses/BadRequestResponse'
|
45251
|
+
'403':
|
45252
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45253
|
+
'404':
|
45254
|
+
$ref: '#/components/responses/NotFoundResponse'
|
45255
|
+
'409':
|
45256
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
45257
|
+
'429':
|
45258
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45259
|
+
summary: Update a WAF exclusion filter
|
45260
|
+
tags:
|
45261
|
+
- Application Security
|
45262
|
+
x-codegen-request-body-name: body
|
45263
|
+
x-permission:
|
45264
|
+
operator: AND
|
45265
|
+
permissions:
|
45266
|
+
- appsec_protect_write
|
45267
|
+
x-terraform-resource: appsec_waf_exclusion_filter
|
42103
45268
|
/api/v2/remote_config/products/cws/agent_rules:
|
42104
45269
|
get:
|
42105
45270
|
description: Get the list of Cloud Security Management Threats Agent rules.
|
@@ -43077,6 +46242,167 @@ paths:
|
|
43077
46242
|
operator: OR
|
43078
46243
|
permissions:
|
43079
46244
|
- rum_apps_write
|
46245
|
+
/api/v2/rum/applications/{app_id}/relationships/retention_filters:
|
46246
|
+
patch:
|
46247
|
+
description: 'Order RUM retention filters for an application.
|
46248
|
+
|
46249
|
+
Returns RUM retention filter objects without attributes and meta from the
|
46250
|
+
request body when the request is successful.'
|
46251
|
+
operationId: OrderRetentionFilters
|
46252
|
+
parameters:
|
46253
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46254
|
+
requestBody:
|
46255
|
+
content:
|
46256
|
+
application/json:
|
46257
|
+
schema:
|
46258
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderRequest'
|
46259
|
+
description: New definition of the RUM retention filter.
|
46260
|
+
required: true
|
46261
|
+
responses:
|
46262
|
+
'200':
|
46263
|
+
content:
|
46264
|
+
application/json:
|
46265
|
+
schema:
|
46266
|
+
$ref: '#/components/schemas/RumRetentionFiltersOrderResponse'
|
46267
|
+
description: Ordered
|
46268
|
+
'400':
|
46269
|
+
$ref: '#/components/responses/BadRequestResponse'
|
46270
|
+
'403':
|
46271
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46272
|
+
'429':
|
46273
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46274
|
+
summary: Order RUM retention filters
|
46275
|
+
tags:
|
46276
|
+
- Rum Retention Filters
|
46277
|
+
x-codegen-request-body-name: body
|
46278
|
+
/api/v2/rum/applications/{app_id}/retention_filters:
|
46279
|
+
get:
|
46280
|
+
description: Get the list of RUM retention filters for an application.
|
46281
|
+
operationId: ListRetentionFilters
|
46282
|
+
parameters:
|
46283
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46284
|
+
responses:
|
46285
|
+
'200':
|
46286
|
+
content:
|
46287
|
+
application/json:
|
46288
|
+
schema:
|
46289
|
+
$ref: '#/components/schemas/RumRetentionFiltersResponse'
|
46290
|
+
description: OK
|
46291
|
+
'403':
|
46292
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46293
|
+
'429':
|
46294
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46295
|
+
summary: Get all RUM retention filters
|
46296
|
+
tags:
|
46297
|
+
- Rum Retention Filters
|
46298
|
+
post:
|
46299
|
+
description: 'Create a RUM retention filter for an application.
|
46300
|
+
|
46301
|
+
Returns RUM retention filter objects from the request body when the request
|
46302
|
+
is successful.'
|
46303
|
+
operationId: CreateRetentionFilter
|
46304
|
+
parameters:
|
46305
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46306
|
+
requestBody:
|
46307
|
+
content:
|
46308
|
+
application/json:
|
46309
|
+
schema:
|
46310
|
+
$ref: '#/components/schemas/RumRetentionFilterCreateRequest'
|
46311
|
+
description: The definition of the new RUM retention filter.
|
46312
|
+
required: true
|
46313
|
+
responses:
|
46314
|
+
'201':
|
46315
|
+
content:
|
46316
|
+
application/json:
|
46317
|
+
schema:
|
46318
|
+
$ref: '#/components/schemas/RumRetentionFilterResponse'
|
46319
|
+
description: Created
|
46320
|
+
'400':
|
46321
|
+
$ref: '#/components/responses/BadRequestResponse'
|
46322
|
+
'403':
|
46323
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46324
|
+
'429':
|
46325
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46326
|
+
summary: Create a RUM retention filter
|
46327
|
+
tags:
|
46328
|
+
- Rum Retention Filters
|
46329
|
+
x-codegen-request-body-name: body
|
46330
|
+
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}:
|
46331
|
+
delete:
|
46332
|
+
description: Delete a RUM retention filter for an application.
|
46333
|
+
operationId: DeleteRetentionFilter
|
46334
|
+
parameters:
|
46335
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46336
|
+
- $ref: '#/components/parameters/RumRetentionFilterIDParameter'
|
46337
|
+
responses:
|
46338
|
+
'204':
|
46339
|
+
description: No Content
|
46340
|
+
'403':
|
46341
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46342
|
+
'404':
|
46343
|
+
$ref: '#/components/responses/NotFoundResponse'
|
46344
|
+
'429':
|
46345
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46346
|
+
summary: Delete a RUM retention filter
|
46347
|
+
tags:
|
46348
|
+
- Rum Retention Filters
|
46349
|
+
get:
|
46350
|
+
description: Get a RUM retention filter for an application.
|
46351
|
+
operationId: GetRetentionFilter
|
46352
|
+
parameters:
|
46353
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46354
|
+
- $ref: '#/components/parameters/RumRetentionFilterIDParameter'
|
46355
|
+
responses:
|
46356
|
+
'200':
|
46357
|
+
content:
|
46358
|
+
application/json:
|
46359
|
+
schema:
|
46360
|
+
$ref: '#/components/schemas/RumRetentionFilterResponse'
|
46361
|
+
description: OK
|
46362
|
+
'403':
|
46363
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46364
|
+
'404':
|
46365
|
+
$ref: '#/components/responses/NotFoundResponse'
|
46366
|
+
'429':
|
46367
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46368
|
+
summary: Get a RUM retention filter
|
46369
|
+
tags:
|
46370
|
+
- Rum Retention Filters
|
46371
|
+
patch:
|
46372
|
+
description: 'Update a RUM retention filter for an application.
|
46373
|
+
|
46374
|
+
Returns RUM retention filter objects from the request body when the request
|
46375
|
+
is successful.'
|
46376
|
+
operationId: UpdateRetentionFilter
|
46377
|
+
parameters:
|
46378
|
+
- $ref: '#/components/parameters/RumApplicationIDParameter'
|
46379
|
+
- $ref: '#/components/parameters/RumRetentionFilterIDParameter'
|
46380
|
+
requestBody:
|
46381
|
+
content:
|
46382
|
+
application/json:
|
46383
|
+
schema:
|
46384
|
+
$ref: '#/components/schemas/RumRetentionFilterUpdateRequest'
|
46385
|
+
description: New definition of the RUM retention filter.
|
46386
|
+
required: true
|
46387
|
+
responses:
|
46388
|
+
'200':
|
46389
|
+
content:
|
46390
|
+
application/json:
|
46391
|
+
schema:
|
46392
|
+
$ref: '#/components/schemas/RumRetentionFilterResponse'
|
46393
|
+
description: Updated
|
46394
|
+
'400':
|
46395
|
+
$ref: '#/components/responses/BadRequestResponse'
|
46396
|
+
'403':
|
46397
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46398
|
+
'404':
|
46399
|
+
$ref: '#/components/responses/NotFoundResponse'
|
46400
|
+
'429':
|
46401
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46402
|
+
summary: Update a RUM retention filter
|
46403
|
+
tags:
|
46404
|
+
- Rum Retention Filters
|
46405
|
+
x-codegen-request-body-name: body
|
43080
46406
|
/api/v2/rum/applications/{id}:
|
43081
46407
|
delete:
|
43082
46408
|
description: Delete an existing RUM application in your organization.
|
@@ -43967,9 +47293,14 @@ paths:
|
|
43967
47293
|
security:
|
43968
47294
|
- apiKeyAuth: []
|
43969
47295
|
appKeyAuth: []
|
47296
|
+
- AuthZ:
|
47297
|
+
- appsec_vm_read
|
43970
47298
|
summary: List vulnerable assets
|
43971
47299
|
tags:
|
43972
47300
|
- Security Monitoring
|
47301
|
+
x-unstable: '**Note**: This endpoint is a private preview.
|
47302
|
+
|
47303
|
+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
43973
47304
|
/api/v2/security/cloud_workload/policy/download:
|
43974
47305
|
get:
|
43975
47306
|
description: 'The download endpoint generates a Cloud Workload Security policy
|
@@ -44059,9 +47390,14 @@ paths:
|
|
44059
47390
|
security:
|
44060
47391
|
- apiKeyAuth: []
|
44061
47392
|
appKeyAuth: []
|
47393
|
+
- AuthZ:
|
47394
|
+
- appsec_vm_read
|
44062
47395
|
summary: Get SBOM
|
44063
47396
|
tags:
|
44064
47397
|
- Security Monitoring
|
47398
|
+
x-unstable: '**Note**: This endpoint is a private preview.
|
47399
|
+
|
47400
|
+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
44065
47401
|
/api/v2/security/signals/notification_rules:
|
44066
47402
|
get:
|
44067
47403
|
description: Returns the list of notification rules for security signals.
|
@@ -44078,7 +47414,7 @@ paths:
|
|
44078
47414
|
appKeyAuth: []
|
44079
47415
|
- AuthZ:
|
44080
47416
|
- security_monitoring_notification_profiles_read
|
44081
|
-
summary: Get the list of signal-based rules
|
47417
|
+
summary: Get the list of signal-based notification rules
|
44082
47418
|
tags:
|
44083
47419
|
- Security Monitoring
|
44084
47420
|
x-permission:
|
@@ -44120,7 +47456,7 @@ paths:
|
|
44120
47456
|
appKeyAuth: []
|
44121
47457
|
- AuthZ:
|
44122
47458
|
- security_monitoring_notification_profiles_write
|
44123
|
-
summary: Create a new signal-based rule
|
47459
|
+
summary: Create a new signal-based notification rule
|
44124
47460
|
tags:
|
44125
47461
|
- Security Monitoring
|
44126
47462
|
x-codegen-request-body-name: body
|
@@ -44153,7 +47489,7 @@ paths:
|
|
44153
47489
|
appKeyAuth: []
|
44154
47490
|
- AuthZ:
|
44155
47491
|
- security_monitoring_notification_profiles_write
|
44156
|
-
summary: Delete a signal-based rule
|
47492
|
+
summary: Delete a signal-based notification rule
|
44157
47493
|
tags:
|
44158
47494
|
- Security Monitoring
|
44159
47495
|
x-permission:
|
@@ -44190,7 +47526,7 @@ paths:
|
|
44190
47526
|
appKeyAuth: []
|
44191
47527
|
- AuthZ:
|
44192
47528
|
- security_monitoring_notification_profiles_read
|
44193
|
-
summary: Get details of a signal-based rule
|
47529
|
+
summary: Get details of a signal-based notification rule
|
44194
47530
|
tags:
|
44195
47531
|
- Security Monitoring
|
44196
47532
|
x-permission:
|
@@ -44236,7 +47572,7 @@ paths:
|
|
44236
47572
|
appKeyAuth: []
|
44237
47573
|
- AuthZ:
|
44238
47574
|
- security_monitoring_notification_profiles_write
|
44239
|
-
summary: Patch a signal-based rule
|
47575
|
+
summary: Patch a signal-based notification rule
|
44240
47576
|
tags:
|
44241
47577
|
- Security Monitoring
|
44242
47578
|
x-codegen-request-body-name: body
|
@@ -44617,9 +47953,14 @@ paths:
|
|
44617
47953
|
security:
|
44618
47954
|
- apiKeyAuth: []
|
44619
47955
|
appKeyAuth: []
|
47956
|
+
- AuthZ:
|
47957
|
+
- appsec_vm_read
|
44620
47958
|
summary: List vulnerabilities
|
44621
47959
|
tags:
|
44622
47960
|
- Security Monitoring
|
47961
|
+
x-unstable: '**Note**: This endpoint is a private preview.
|
47962
|
+
|
47963
|
+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
44623
47964
|
/api/v2/security/vulnerabilities/notification_rules:
|
44624
47965
|
get:
|
44625
47966
|
description: Returns the list of notification rules for security vulnerabilities.
|
@@ -44636,7 +47977,7 @@ paths:
|
|
44636
47977
|
appKeyAuth: []
|
44637
47978
|
- AuthZ:
|
44638
47979
|
- security_monitoring_notification_profiles_read
|
44639
|
-
summary: Get the list of vulnerability
|
47980
|
+
summary: Get the list of vulnerability notification rules
|
44640
47981
|
tags:
|
44641
47982
|
- Security Monitoring
|
44642
47983
|
x-permission:
|
@@ -44678,7 +48019,7 @@ paths:
|
|
44678
48019
|
appKeyAuth: []
|
44679
48020
|
- AuthZ:
|
44680
48021
|
- security_monitoring_notification_profiles_write
|
44681
|
-
summary: Create a new vulnerability-based rule
|
48022
|
+
summary: Create a new vulnerability-based notification rule
|
44682
48023
|
tags:
|
44683
48024
|
- Security Monitoring
|
44684
48025
|
x-codegen-request-body-name: body
|
@@ -44711,7 +48052,7 @@ paths:
|
|
44711
48052
|
appKeyAuth: []
|
44712
48053
|
- AuthZ:
|
44713
48054
|
- security_monitoring_notification_profiles_write
|
44714
|
-
summary: Delete a vulnerability-based rule
|
48055
|
+
summary: Delete a vulnerability-based notification rule
|
44715
48056
|
tags:
|
44716
48057
|
- Security Monitoring
|
44717
48058
|
x-permission:
|
@@ -44748,7 +48089,7 @@ paths:
|
|
44748
48089
|
appKeyAuth: []
|
44749
48090
|
- AuthZ:
|
44750
48091
|
- security_monitoring_notification_profiles_read
|
44751
|
-
summary: Get details of a vulnerability
|
48092
|
+
summary: Get details of a vulnerability notification rule
|
44752
48093
|
tags:
|
44753
48094
|
- Security Monitoring
|
44754
48095
|
x-permission:
|
@@ -44794,7 +48135,7 @@ paths:
|
|
44794
48135
|
appKeyAuth: []
|
44795
48136
|
- AuthZ:
|
44796
48137
|
- security_monitoring_notification_profiles_write
|
44797
|
-
summary: Patch a vulnerability-based rule
|
48138
|
+
summary: Patch a vulnerability-based notification rule
|
44798
48139
|
tags:
|
44799
48140
|
- Security Monitoring
|
44800
48141
|
x-codegen-request-body-name: body
|
@@ -45624,6 +48965,42 @@ paths:
|
|
45624
48965
|
operator: OR
|
45625
48966
|
permissions:
|
45626
48967
|
- security_monitoring_rules_write
|
48968
|
+
/api/v2/security_monitoring/rules/{rule_id}/version_history:
|
48969
|
+
get:
|
48970
|
+
description: Get a rule's version history.
|
48971
|
+
operationId: GetRuleVersionHistory
|
48972
|
+
parameters:
|
48973
|
+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
|
48974
|
+
- $ref: '#/components/parameters/PageSize'
|
48975
|
+
- $ref: '#/components/parameters/PageNumber'
|
48976
|
+
responses:
|
48977
|
+
'200':
|
48978
|
+
content:
|
48979
|
+
application/json:
|
48980
|
+
schema:
|
48981
|
+
$ref: '#/components/schemas/GetRuleVersionHistoryResponse'
|
48982
|
+
description: OK
|
48983
|
+
'400':
|
48984
|
+
$ref: '#/components/responses/BadRequestResponse'
|
48985
|
+
'403':
|
48986
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
48987
|
+
'404':
|
48988
|
+
$ref: '#/components/responses/NotFoundResponse'
|
48989
|
+
'429':
|
48990
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
48991
|
+
security:
|
48992
|
+
- apiKeyAuth: []
|
48993
|
+
appKeyAuth: []
|
48994
|
+
- AuthZ:
|
48995
|
+
- security_monitoring_rules_read
|
48996
|
+
summary: Get a rule's version history
|
48997
|
+
tags:
|
48998
|
+
- Security Monitoring
|
48999
|
+
x-permission:
|
49000
|
+
operator: OR
|
49001
|
+
permissions:
|
49002
|
+
- security_monitoring_rules_read
|
49003
|
+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.'
|
45627
49004
|
/api/v2/security_monitoring/signals:
|
45628
49005
|
get:
|
45629
49006
|
description: 'The list endpoint returns security signals that match a search
|
@@ -49736,6 +53113,178 @@ paths:
|
|
49736
53113
|
operator: OR
|
49737
53114
|
permissions:
|
49738
53115
|
- teams_read
|
53116
|
+
/api/v2/workflows:
|
53117
|
+
post:
|
53118
|
+
description: Create a new workflow, returning the workflow ID. This API requires
|
53119
|
+
an application key scoped with the `workflows_write` permission.
|
53120
|
+
operationId: CreateWorkflow
|
53121
|
+
requestBody:
|
53122
|
+
content:
|
53123
|
+
application/json:
|
53124
|
+
schema:
|
53125
|
+
$ref: '#/components/schemas/CreateWorkflowRequest'
|
53126
|
+
required: true
|
53127
|
+
responses:
|
53128
|
+
'201':
|
53129
|
+
content:
|
53130
|
+
application/json:
|
53131
|
+
schema:
|
53132
|
+
$ref: '#/components/schemas/CreateWorkflowResponse'
|
53133
|
+
description: Successfully created a workflow.
|
53134
|
+
'400':
|
53135
|
+
content:
|
53136
|
+
application/json:
|
53137
|
+
schema:
|
53138
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53139
|
+
description: Bad request
|
53140
|
+
'403':
|
53141
|
+
content:
|
53142
|
+
application/json:
|
53143
|
+
schema:
|
53144
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53145
|
+
description: Forbidden
|
53146
|
+
'429':
|
53147
|
+
content:
|
53148
|
+
application/json:
|
53149
|
+
schema:
|
53150
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53151
|
+
description: Too many requests
|
53152
|
+
summary: Create a Workflow
|
53153
|
+
tags:
|
53154
|
+
- Workflow Automation
|
53155
|
+
x-permission:
|
53156
|
+
operator: OR
|
53157
|
+
permissions:
|
53158
|
+
- workflows_write
|
53159
|
+
/api/v2/workflows/{workflow_id}:
|
53160
|
+
delete:
|
53161
|
+
description: Delete a workflow by ID. This API requires an application key scoped
|
53162
|
+
with the `workflows_write` permission.
|
53163
|
+
operationId: DeleteWorkflow
|
53164
|
+
parameters:
|
53165
|
+
- $ref: '#/components/parameters/WorkflowId'
|
53166
|
+
responses:
|
53167
|
+
'204':
|
53168
|
+
description: Successfully deleted a workflow.
|
53169
|
+
'403':
|
53170
|
+
content:
|
53171
|
+
application/json:
|
53172
|
+
schema:
|
53173
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53174
|
+
description: Forbidden
|
53175
|
+
'404':
|
53176
|
+
content:
|
53177
|
+
application/json:
|
53178
|
+
schema:
|
53179
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53180
|
+
description: Not found
|
53181
|
+
'429':
|
53182
|
+
content:
|
53183
|
+
application/json:
|
53184
|
+
schema:
|
53185
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53186
|
+
description: Too many requests
|
53187
|
+
summary: Delete an existing Workflow
|
53188
|
+
tags:
|
53189
|
+
- Workflow Automation
|
53190
|
+
x-permission:
|
53191
|
+
operator: OR
|
53192
|
+
permissions:
|
53193
|
+
- workflows_write
|
53194
|
+
get:
|
53195
|
+
description: Get a workflow by ID. This API requires an application key scoped
|
53196
|
+
with the `workflows_read` permission.
|
53197
|
+
operationId: GetWorkflow
|
53198
|
+
parameters:
|
53199
|
+
- $ref: '#/components/parameters/WorkflowId'
|
53200
|
+
responses:
|
53201
|
+
'200':
|
53202
|
+
content:
|
53203
|
+
application/json:
|
53204
|
+
schema:
|
53205
|
+
$ref: '#/components/schemas/GetWorkflowResponse'
|
53206
|
+
description: Successfully got a workflow.
|
53207
|
+
'400':
|
53208
|
+
content:
|
53209
|
+
application/json:
|
53210
|
+
schema:
|
53211
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53212
|
+
description: Bad request
|
53213
|
+
'403':
|
53214
|
+
content:
|
53215
|
+
application/json:
|
53216
|
+
schema:
|
53217
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53218
|
+
description: Forbidden
|
53219
|
+
'404':
|
53220
|
+
content:
|
53221
|
+
application/json:
|
53222
|
+
schema:
|
53223
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53224
|
+
description: Not found
|
53225
|
+
'429':
|
53226
|
+
content:
|
53227
|
+
application/json:
|
53228
|
+
schema:
|
53229
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53230
|
+
description: Too many requests
|
53231
|
+
summary: Get an existing Workflow
|
53232
|
+
tags:
|
53233
|
+
- Workflow Automation
|
53234
|
+
x-permission:
|
53235
|
+
operator: OR
|
53236
|
+
permissions:
|
53237
|
+
- workflows_read
|
53238
|
+
patch:
|
53239
|
+
description: Update a workflow by ID. This API requires an application key scoped
|
53240
|
+
with the `workflows_write` permission.
|
53241
|
+
operationId: UpdateWorkflow
|
53242
|
+
parameters:
|
53243
|
+
- $ref: '#/components/parameters/WorkflowId'
|
53244
|
+
requestBody:
|
53245
|
+
content:
|
53246
|
+
application/json:
|
53247
|
+
schema:
|
53248
|
+
$ref: '#/components/schemas/UpdateWorkflowRequest'
|
53249
|
+
required: true
|
53250
|
+
responses:
|
53251
|
+
'200':
|
53252
|
+
content:
|
53253
|
+
application/json:
|
53254
|
+
schema:
|
53255
|
+
$ref: '#/components/schemas/UpdateWorkflowResponse'
|
53256
|
+
description: Successfully updated a workflow.
|
53257
|
+
'400':
|
53258
|
+
content:
|
53259
|
+
application/json:
|
53260
|
+
schema:
|
53261
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53262
|
+
description: Bad request
|
53263
|
+
'403':
|
53264
|
+
content:
|
53265
|
+
application/json:
|
53266
|
+
schema:
|
53267
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53268
|
+
description: Forbidden
|
53269
|
+
'404':
|
53270
|
+
content:
|
53271
|
+
application/json:
|
53272
|
+
schema:
|
53273
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53274
|
+
description: Not found
|
53275
|
+
'429':
|
53276
|
+
content:
|
53277
|
+
application/json:
|
53278
|
+
schema:
|
53279
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
53280
|
+
description: Too many requests
|
53281
|
+
summary: Update an existing Workflow
|
53282
|
+
tags:
|
53283
|
+
- Workflow Automation
|
53284
|
+
x-permission:
|
53285
|
+
operator: OR
|
53286
|
+
permissions:
|
53287
|
+
- workflows_write
|
49739
53288
|
/api/v2/workflows/{workflow_id}/instances:
|
49740
53289
|
get:
|
49741
53290
|
description: List all instances of a given workflow. This API requires an application
|
@@ -49944,14 +53493,31 @@ tags:
|
|
49944
53493
|
name: Action Connection
|
49945
53494
|
- description: "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin
|
49946
53495
|
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/
|
53496
|
+
teams to install Agents on every host or where Agents cannot be installed.\nAgentless
|
53497
|
+
offers also Sensitive Data Scanning capabilities on your storage.\nGo to https://www.datadoghq.com/blog/agentless-scanning/
|
53498
|
+
to learn more."
|
49949
53499
|
name: Agentless Scanning
|
49950
53500
|
- description: Datadog App Builder provides a low-code solution to rapidly develop
|
49951
53501
|
and integrate secure, customized applications into your monitoring stack that
|
49952
53502
|
are built to accelerate remediation at scale. These API endpoints allow you to
|
49953
53503
|
create, read, update, delete, and publish apps.
|
49954
53504
|
name: App Builder
|
53505
|
+
- description: '[Datadog Application Security](https://docs.datadoghq.com/security/application_security/)
|
53506
|
+
provides protection against
|
53507
|
+
|
53508
|
+
application-level attacks that aim to exploit code-level vulnerabilities,
|
53509
|
+
|
53510
|
+
such as Server-Side-Request-Forgery (SSRF), SQL injection, Log4Shell, and
|
53511
|
+
|
53512
|
+
Reflected Cross-Site-Scripting (XSS). You can monitor and protect apps
|
53513
|
+
|
53514
|
+
hosted directly on a server, Docker, Kubernetes, Amazon ECS, and (for
|
53515
|
+
|
53516
|
+
supported languages) AWS Fargate.'
|
53517
|
+
externalDocs:
|
53518
|
+
description: Find out more at
|
53519
|
+
url: https://docs.datadoghq.com/security/application_security/
|
53520
|
+
name: Application Security
|
49955
53521
|
- description: Search your Audit Logs events over HTTP.
|
49956
53522
|
name: Audit
|
49957
53523
|
- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
@@ -50252,6 +53818,9 @@ tags:
|
|
50252
53818
|
description: Find out more at
|
50253
53819
|
url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
|
50254
53820
|
name: Rum Metrics
|
53821
|
+
- description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
|
53822
|
+
for your organization.
|
53823
|
+
name: Rum Retention Filters
|
50255
53824
|
- description: Create and manage your security rules, signals, filters, and more.
|
50256
53825
|
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
|
50257
53826
|
information.
|
@@ -50339,7 +53908,12 @@ tags:
|
|
50339
53908
|
externalDocs:
|
50340
53909
|
url: https://docs.datadoghq.com/account_management/users
|
50341
53910
|
name: Users
|
50342
|
-
- description:
|
53911
|
+
- description: Datadog Workflow Automation allows you to automate your end-to-end
|
53912
|
+
processes by connecting Datadog with the rest of your tech stack. Build workflows
|
53913
|
+
to auto-remediate your alerts, streamline your incident and security processes,
|
53914
|
+
and reduce manual toil. Workflow Automation supports over 1,000+ OOTB actions,
|
53915
|
+
including AWS, JIRA, ServiceNow, GitHub, and OpenAI. Learn more in our Workflow
|
53916
|
+
Automation docs [here](https://docs.datadoghq.com/service_management/workflows/).
|
50343
53917
|
externalDocs:
|
50344
53918
|
description: Find out more at
|
50345
53919
|
url: https://docs.datadoghq.com/service_management/workflows/
|