datadog_api_client 2.33.0 → 2.34.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/conftest.py +2 -1
- data/.generator/schemas/v1/openapi.yaml +18 -3
- data/.generator/schemas/v2/openapi.yaml +2577 -883
- data/.generator/src/generator/templates/configuration.j2 +2 -2
- data/.github/workflows/publish.yml +16 -8
- data/.github/workflows/release.yml +57 -61
- data/CHANGELOG.md +16 -0
- data/Gemfile +2 -1
- data/examples/v2/csm-threats/CreateCSMThreatsAgentPolicy.rb +21 -0
- data/examples/v2/csm-threats/CreateCSMThreatsAgentRule.rb +7 -4
- data/examples/v2/csm-threats/CreateCloudWorkloadSecurityAgentRule.rb +3 -2
- data/examples/v2/csm-threats/DeleteCSMThreatsAgentPolicy.rb +8 -0
- data/examples/v2/csm-threats/DeleteCSMThreatsAgentRule.rb +8 -2
- data/examples/v2/csm-threats/DeleteCloudWorkloadSecurityAgentRule.rb +1 -1
- data/examples/v2/csm-threats/DownloadCSMThreatsPolicy.rb +1 -1
- data/examples/v2/csm-threats/DownloadCloudWorkloadPolicyFile.rb +1 -1
- data/examples/v2/csm-threats/GetCSMThreatsAgentPolicy.rb +8 -0
- data/examples/v2/csm-threats/GetCSMThreatsAgentRule.rb +8 -2
- data/examples/v2/csm-threats/GetCloudWorkloadSecurityAgentRule.rb +1 -1
- data/examples/v2/csm-threats/ListCSMThreatsAgentPolicies.rb +5 -0
- data/examples/v2/csm-threats/ListCSMThreatsAgentRules.rb +1 -1
- data/examples/v2/csm-threats/ListCloudWorkloadSecurityAgentRules.rb +1 -1
- data/examples/v2/csm-threats/UpdateCSMThreatsAgentPolicy.rb +25 -0
- data/examples/v2/csm-threats/UpdateCSMThreatsAgentRule.rb +12 -4
- data/examples/v2/csm-threats/UpdateCloudWorkloadSecurityAgentRule.rb +3 -4
- data/examples/v2/dora-metrics/GetDORADeployment.rb +5 -0
- data/examples/v2/dora-metrics/GetDORAFailure.rb +5 -0
- data/examples/v2/dora-metrics/ListDORADeployments.rb +16 -0
- data/examples/v2/dora-metrics/ListDORAFailures.rb +16 -0
- data/examples/v2/network-device-monitoring/ListDevices_2712868412.rb +5 -0
- data/examples/v2/on-call/CreateOnCallEscalationPolicy.rb +19 -17
- data/examples/v2/on-call/CreateOnCallSchedule.rb +11 -15
- data/examples/v2/on-call/DeleteOnCallEscalationPolicy.rb +2 -2
- data/examples/v2/on-call/DeleteOnCallSchedule.rb +2 -2
- data/examples/v2/on-call/GetOnCallEscalationPolicy.rb +6 -3
- data/examples/v2/on-call/GetOnCallSchedule.rb +2 -2
- data/examples/v2/on-call/GetOnCallTeamRoutingRules.rb +5 -0
- data/examples/v2/on-call/GetScheduleOnCallUser.rb +8 -0
- data/examples/v2/on-call/SetOnCallTeamRoutingRules.rb +57 -0
- data/examples/v2/on-call/UpdateOnCallEscalationPolicy.rb +8 -9
- data/examples/v2/on-call/UpdateOnCallSchedule.rb +11 -16
- data/examples/v2/on-call-paging/AcknowledgeOnCallPage.rb +5 -0
- data/examples/v2/on-call-paging/CreateOnCallPage.rb +23 -0
- data/examples/v2/on-call-paging/EscalateOnCallPage.rb +5 -0
- data/examples/v2/on-call-paging/ResolveOnCallPage.rb +5 -0
- data/examples/v2/rum-metrics/CreateRumMetric.rb +1 -1
- data/examples/v2/security-monitoring/GetResourceEvaluationFilters.rb +9 -0
- data/examples/v2/security-monitoring/UpdateResourceEvaluationFilters.rb +21 -0
- data/examples/v2/software-catalog/ListCatalogRelation.rb +5 -0
- data/examples/v2/software-catalog/ListCatalogRelation_1311054087.rb +8 -0
- data/examples/v2/workflow-automation/CreateWorkflow.rb +0 -1
- data/examples/v2/workflow-automation/UpdateWorkflow.rb +0 -1
- data/lib/datadog_api_client/configuration.rb +203 -15
- data/lib/datadog_api_client/inflector.rb +104 -43
- data/lib/datadog_api_client/v1/models/synthetics_assertion_body_hash_target.rb +2 -2
- data/lib/datadog_api_client/v1/models/synthetics_assertion_json_path_target_target.rb +2 -2
- data/lib/datadog_api_client/v1/models/synthetics_assertion_target.rb +2 -2
- data/lib/datadog_api_client/v1/models/synthetics_assertion_target_value.rb +63 -0
- data/lib/datadog_api_client/v1/models/synthetics_assertion_x_path_target_target.rb +2 -2
- data/lib/datadog_api_client/v2/api/csm_threats_api.rb +424 -52
- data/lib/datadog_api_client/v2/api/dora_metrics_api.rb +265 -1
- data/lib/datadog_api_client/v2/api/metrics_api.rb +5 -5
- data/lib/datadog_api_client/v2/api/network_device_monitoring_api.rb +25 -3
- data/lib/datadog_api_client/v2/api/on_call_api.rb +234 -24
- data/lib/datadog_api_client/v2/api/on_call_paging_api.rb +292 -0
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +133 -0
- data/lib/datadog_api_client/v2/api/software_catalog_api.rb +101 -0
- data/lib/datadog_api_client/v2/models/{schedule_update_request_data_relationships_teams.rb → cloud_workload_security_agent_policies_list_response.rb} +5 -5
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_attributes.rb +300 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_create_attributes.rb +167 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_update_request_data_relationships_teams_data_items.rb → cloud_workload_security_agent_policy_create_data.rb} +19 -19
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/{schedule_create_request_data_attributes_layers_items_restrictions_items.rb → cloud_workload_security_agent_policy_update_attributes.rb} +46 -33
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_update_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_updater_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +31 -19
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_create_attributes.rb +27 -5
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_create_data.rb +2 -2
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_create_request.rb +2 -2
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_creator_attributes.rb +3 -3
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_data.rb +4 -4
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_kill.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_response.rb +2 -2
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_type.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_update_attributes.rb +29 -7
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_update_data.rb +4 -4
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_update_request.rb +2 -2
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_updater_attributes.rb +3 -3
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rules_list_response.rb +2 -2
- data/lib/datadog_api_client/v2/models/create_page_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/create_page_request_data.rb +133 -0
- data/lib/datadog_api_client/v2/models/create_page_request_data_attributes.rb +187 -0
- data/lib/datadog_api_client/v2/models/create_page_request_data_attributes_target.rb +115 -0
- data/lib/datadog_api_client/v2/models/create_page_request_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/create_page_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/create_page_response_data.rb +133 -0
- data/lib/datadog_api_client/v2/models/create_page_response_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_framework_without_requirements.rb +2 -24
- data/lib/datadog_api_client/v2/models/{schedule_data_relationships_teams.rb → data_relationships_teams.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{schedule_data_relationships_teams_data_items.rb → data_relationships_teams_data_items.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{schedule_data_relationships_teams_data_items_type.rb → data_relationships_teams_data_items_type.rb} +1 -1
- data/lib/datadog_api_client/v2/models/{escalation_policy_update_request_data_attributes_steps_items_targets_items.rb → dora_event.rb} +17 -7
- data/lib/datadog_api_client/v2/models/dora_fetch_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/dora_list_deployments_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/dora_list_deployments_request_attributes.rb +163 -0
- data/lib/datadog_api_client/v2/models/dora_list_deployments_request_data.rb +133 -0
- data/lib/datadog_api_client/v2/models/dora_list_deployments_request_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_update_request_data_relationships_teams.rb → dora_list_failures_request.rb} +25 -9
- data/lib/datadog_api_client/v2/models/dora_list_failures_request_attributes.rb +163 -0
- data/lib/datadog_api_client/v2/models/dora_list_failures_request_data.rb +133 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_create_request_data_relationships_teams_data_items_type.rb → dora_list_failures_request_data_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{schedule_create_request_data_relationships_teams.rb → dora_list_response.rb} +5 -5
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_code_location_item.rb +1 -21
- data/lib/datadog_api_client/v2/models/escalation_policy_create_request_data_attributes.rb +1 -11
- data/lib/datadog_api_client/v2/models/escalation_policy_create_request_data_attributes_steps_items.rb +2 -2
- data/lib/datadog_api_client/v2/models/escalation_policy_create_request_data_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/escalation_policy_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/escalation_policy_data_attributes.rb +2 -12
- data/lib/datadog_api_client/v2/models/escalation_policy_data_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/escalation_policy_included.rb +2 -3
- data/lib/datadog_api_client/v2/models/escalation_policy_step_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/{escalation_policy_create_request_data_attributes_steps_items_targets_items.rb → escalation_policy_step_target.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{escalation_policy_create_request_data_attributes_steps_items_targets_items_type.rb → escalation_policy_step_target_type.rb} +1 -1
- data/lib/datadog_api_client/v2/models/escalation_policy_update_request_data_attributes.rb +1 -11
- data/lib/datadog_api_client/v2/models/escalation_policy_update_request_data_attributes_steps_items.rb +2 -2
- data/lib/datadog_api_client/v2/models/escalation_policy_update_request_data_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/escalation_policy_user.rb +143 -0
- data/lib/datadog_api_client/v2/models/escalation_policy_user_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/{team_reference_relationships_oncall_users_data_items_type.rb → escalation_policy_user_type.rb} +1 -1
- data/lib/datadog_api_client/v2/models/{team_reference_relationships_oncall_users.rb → escalation_targets.rb} +5 -5
- data/lib/datadog_api_client/v2/models/full_custom_framework_data_attributes.rb +2 -34
- data/lib/datadog_api_client/v2/models/get_resource_evaluation_filters_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/get_resource_evaluation_filters_response_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/historical_job_options.rb +2 -2
- data/lib/datadog_api_client/v2/models/historical_job_query.rb +1 -1
- data/lib/datadog_api_client/v2/models/http_integration.rb +0 -6
- data/lib/datadog_api_client/v2/models/http_integration_update.rb +1 -14
- data/lib/datadog_api_client/v2/models/incident_severity.rb +1 -0
- data/lib/datadog_api_client/v2/models/layer_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/list_relation_catalog_response.rb +139 -0
- data/lib/datadog_api_client/v2/models/list_relation_catalog_response_links.rb +125 -0
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_attributes.rb +1 -16
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb +1 -16
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb +1 -16
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_cloud_storage_destination.rb +2 -13
- data/lib/datadog_api_client/v2/models/observability_pipeline_metadata_entry.rb +1 -1
- data/lib/datadog_api_client/v2/models/on_call_page_target_type.rb +28 -0
- data/lib/datadog_api_client/v2/models/{schedule_update_request_data_relationships_teams_data_items_type.rb → page_urgency.rb} +4 -3
- data/lib/datadog_api_client/v2/models/relation_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/relation_entity.rb +125 -0
- data/lib/datadog_api_client/v2/models/relation_include_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/relation_meta.rb +135 -0
- data/lib/datadog_api_client/v2/models/relation_relationships.rb +115 -0
- data/lib/datadog_api_client/v2/models/relation_response.rb +155 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_data_relationships_teams.rb → relation_response_meta.rb} +21 -13
- data/lib/datadog_api_client/v2/models/{schedule_create_request_data_relationships_teams_data_items_type.rb → relation_response_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/relation_to_entity.rb +115 -0
- data/lib/datadog_api_client/v2/models/resource_filter_attributes.rb +133 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_data_relationships_teams_data_items_type.rb → resource_filter_request_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/routing_rule.rb +153 -0
- data/lib/datadog_api_client/v2/models/routing_rule_action.rb +63 -0
- data/lib/datadog_api_client/v2/models/routing_rule_attributes.rb +137 -0
- data/lib/datadog_api_client/v2/models/{schedule_update_request_data_attributes_layers_items_members_items_user.rb → routing_rule_relationships.rb} +11 -11
- data/lib/datadog_api_client/v2/models/routing_rule_relationships_policy.rb +105 -0
- data/lib/datadog_api_client/v2/models/{team_reference_relationships_oncall_users_data_items.rb → routing_rule_relationships_policy_data.rb} +6 -6
- data/lib/datadog_api_client/v2/models/routing_rule_relationships_policy_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/routing_rule_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/schedule_create_request_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes.rb +3 -15
- data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items.rb +4 -4
- data/lib/datadog_api_client/v2/models/schedule_create_request_data_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/schedule_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/schedule_data_attributes.rb +2 -14
- data/lib/datadog_api_client/v2/models/schedule_data_relationships.rb +1 -1
- data/lib/datadog_api_client/v2/models/{schedule_create_request_data_attributes_layers_items_members_items.rb → schedule_request_data_attributes_layers_items_members_items.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{schedule_create_request_data_attributes_layers_items_members_items_user.rb → schedule_request_data_attributes_layers_items_members_items_user.rb} +2 -2
- data/lib/datadog_api_client/v2/models/schedule_update_request.rb +1 -1
- data/lib/datadog_api_client/v2/models/schedule_update_request_data.rb +2 -2
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes.rb +2 -14
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items.rb +4 -4
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/schedule_user_attributes.rb +13 -3
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_keep_alive.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_max_signal_duration.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +2 -2
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_data_source.rb +2 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb +1 -1
- data/lib/datadog_api_client/v2/models/send_slack_message_action.rb +165 -0
- data/lib/datadog_api_client/v2/models/send_slack_message_action_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/send_teams_message_action.rb +186 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_update_request_data_relationships_teams_data_items_type.rb → send_teams_message_action_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{escalation_policy_create_request_data_relationships_teams.rb → shift.rb} +19 -9
- data/lib/datadog_api_client/v2/models/shift_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/shift_data_attributes.rb +115 -0
- data/lib/datadog_api_client/v2/models/{schedule_update_request_data_attributes_layers_items_members_items.rb → shift_data_relationships.rb} +5 -6
- data/lib/datadog_api_client/v2/models/shift_data_relationships_user.rb +123 -0
- data/lib/datadog_api_client/v2/models/{schedule_update_request_data_relationships_teams_data_items.rb → shift_data_relationships_user_data.rb} +6 -6
- data/lib/datadog_api_client/v2/models/shift_data_relationships_user_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/shift_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/shift_included.rb +62 -0
- data/lib/datadog_api_client/v2/models/team_reference.rb +1 -11
- data/lib/datadog_api_client/v2/models/team_routing_rules.rb +117 -0
- data/lib/datadog_api_client/v2/models/team_routing_rules_data.rb +143 -0
- data/lib/datadog_api_client/v2/models/team_routing_rules_data_relationships.rb +105 -0
- data/lib/datadog_api_client/v2/models/team_routing_rules_data_relationships_rules.rb +107 -0
- data/lib/datadog_api_client/v2/models/{schedule_create_request_data_relationships_teams_data_items.rb → team_routing_rules_data_relationships_rules_data_items.rb} +6 -7
- data/lib/datadog_api_client/v2/models/team_routing_rules_data_relationships_rules_data_items_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_routing_rules_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_routing_rules_included.rb +62 -0
- data/lib/datadog_api_client/v2/models/team_routing_rules_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_data_relationships_teams_data_items.rb → team_routing_rules_request_data.rb} +18 -19
- data/lib/datadog_api_client/v2/models/team_routing_rules_request_data_attributes.rb +107 -0
- data/lib/datadog_api_client/v2/models/team_routing_rules_request_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/{schedule_update_request_data_attributes_layers_items_restrictions_items.rb → team_routing_rules_request_rule.rb} +44 -33
- data/lib/datadog_api_client/v2/models/{layer_attributes_restrictions_items.rb → time_restriction.rb} +9 -10
- data/lib/datadog_api_client/v2/models/{schedule_create_request_data_attributes_layers_items_interval.rb → time_restrictions.rb} +32 -30
- data/lib/datadog_api_client/v2/models/update_resource_evaluation_filters_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/update_resource_evaluation_filters_request_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/update_resource_evaluation_filters_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/{escalation_policy_create_request_data_relationships_teams_data_items.rb → update_resource_evaluation_filters_response_data.rb} +24 -14
- data/lib/datadog_api_client/v2/models/urgency.rb +28 -0
- data/lib/datadog_api_client/v2/models/user_attributes_status.rb +28 -0
- data/lib/datadog_api_client/v2/models/{layer_attributes_restrictions_items_end_day.rb → weekday.rb} +2 -2
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +128 -51
- data/.github/workflows/prepare_release.yml +0 -112
- data/RELEASING.md +0 -43
- data/lib/datadog_api_client/v2/models/escalation_policy_create_request_data_attributes_steps_items_assignment.rb +0 -27
- data/lib/datadog_api_client/v2/models/escalation_policy_update_request_data_attributes_steps_items_assignment.rb +0 -27
- data/lib/datadog_api_client/v2/models/escalation_policy_update_request_data_attributes_steps_items_targets_items_type.rb +0 -28
- data/lib/datadog_api_client/v2/models/layer_attributes_restrictions_items_start_day.rb +0 -32
- data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items_restrictions_items_end_day.rb +0 -32
- data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items_restrictions_items_start_day.rb +0 -32
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_interval.rb +0 -144
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_restrictions_items_end_day.rb +0 -32
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_restrictions_items_start_day.rb +0 -32
- data/lib/datadog_api_client/v2/models/team_reference_relationships.rb +0 -105
@@ -216,13 +216,29 @@ components:
|
|
216
216
|
schema:
|
217
217
|
type: string
|
218
218
|
CloudWorkloadSecurityAgentRuleID:
|
219
|
-
description: The ID of the Agent rule
|
219
|
+
description: The ID of the Agent rule
|
220
220
|
example: 3b5-v82-ns6
|
221
221
|
in: path
|
222
222
|
name: agent_rule_id
|
223
223
|
required: true
|
224
224
|
schema:
|
225
225
|
type: string
|
226
|
+
CloudWorkloadSecurityPathAgentPolicyID:
|
227
|
+
description: The ID of the Agent policy
|
228
|
+
example: 6517fcc1-cec7-4394-a655-8d6e9d085255
|
229
|
+
in: path
|
230
|
+
name: policy_id
|
231
|
+
required: true
|
232
|
+
schema:
|
233
|
+
type: string
|
234
|
+
CloudWorkloadSecurityQueryAgentPolicyID:
|
235
|
+
description: The ID of the Agent policy
|
236
|
+
example: 6517fcc1-cec7-4394-a655-8d6e9d085255
|
237
|
+
in: query
|
238
|
+
name: policy_id
|
239
|
+
required: false
|
240
|
+
schema:
|
241
|
+
type: string
|
226
242
|
ConfluentAccountID:
|
227
243
|
description: Confluent Account ID.
|
228
244
|
in: path
|
@@ -335,6 +351,7 @@ components:
|
|
335
351
|
type: string
|
336
352
|
FilterByRef:
|
337
353
|
description: Filter entities by reference
|
354
|
+
example: service:shopping-cart
|
338
355
|
explode: true
|
339
356
|
in: query
|
340
357
|
name: filter[ref]
|
@@ -349,6 +366,32 @@ components:
|
|
349
366
|
required: false
|
350
367
|
schema:
|
351
368
|
$ref: '#/components/schemas/RelationType'
|
369
|
+
FilterRelationByFromRef:
|
370
|
+
description: Filter relations by the reference of the first entity in the relation.
|
371
|
+
example: service:shopping-cart
|
372
|
+
explode: true
|
373
|
+
in: query
|
374
|
+
name: filter[from_ref]
|
375
|
+
required: false
|
376
|
+
schema:
|
377
|
+
type: string
|
378
|
+
FilterRelationByToRef:
|
379
|
+
description: Filter relations by the reference of the second entity in the relation.
|
380
|
+
example: service:shopping-cart
|
381
|
+
explode: true
|
382
|
+
in: query
|
383
|
+
name: filter[to_ref]
|
384
|
+
required: false
|
385
|
+
schema:
|
386
|
+
type: string
|
387
|
+
FilterRelationByType:
|
388
|
+
description: Filter relations by type.
|
389
|
+
explode: true
|
390
|
+
in: query
|
391
|
+
name: filter[type]
|
392
|
+
required: false
|
393
|
+
schema:
|
394
|
+
$ref: '#/components/schemas/RelationType'
|
352
395
|
GCPSTSServiceAccountID:
|
353
396
|
description: Your GCP STS enabled service account's unique ID.
|
354
397
|
in: path
|
@@ -659,6 +702,14 @@ components:
|
|
659
702
|
required: true
|
660
703
|
schema:
|
661
704
|
type: string
|
705
|
+
RelationInclude:
|
706
|
+
description: Include relationship data.
|
707
|
+
explode: true
|
708
|
+
in: query
|
709
|
+
name: include
|
710
|
+
required: false
|
711
|
+
schema:
|
712
|
+
$ref: '#/components/schemas/RelationIncludeType'
|
662
713
|
ReportID:
|
663
714
|
description: The ID of the report job.
|
664
715
|
in: path
|
@@ -673,6 +724,21 @@ components:
|
|
673
724
|
required: true
|
674
725
|
schema:
|
675
726
|
type: string
|
727
|
+
ResourceFilterAccountID:
|
728
|
+
description: Filter resource filters by cloud provider account ID. This parameter
|
729
|
+
is only valid when provider is specified.
|
730
|
+
in: query
|
731
|
+
name: account_id
|
732
|
+
required: false
|
733
|
+
schema:
|
734
|
+
type: string
|
735
|
+
ResourceFilterProvider:
|
736
|
+
description: Filter resource filters by cloud provider (e.g. aws, gcp, azure).
|
737
|
+
in: query
|
738
|
+
name: cloud_provider
|
739
|
+
required: false
|
740
|
+
schema:
|
741
|
+
type: string
|
676
742
|
ResourceID:
|
677
743
|
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
|
678
744
|
`dashboard`, `integration-account`, `integration-service`, `integration-webhook`,
|
@@ -791,6 +857,13 @@ components:
|
|
791
857
|
required: true
|
792
858
|
schema:
|
793
859
|
type: string
|
860
|
+
SkipCache:
|
861
|
+
description: Skip cache for resource filters.
|
862
|
+
in: query
|
863
|
+
name: skip_cache
|
864
|
+
required: false
|
865
|
+
schema:
|
866
|
+
type: boolean
|
794
867
|
SpansMetricIDParameter:
|
795
868
|
description: The name of the span-based metric.
|
796
869
|
in: path
|
@@ -7212,8 +7285,240 @@ components:
|
|
7212
7285
|
type: string
|
7213
7286
|
x-enum-varnames:
|
7214
7287
|
- CLOUD_CONFIGURATION
|
7288
|
+
CloudWorkloadSecurityAgentPoliciesListResponse:
|
7289
|
+
description: Response object that includes a list of Agent policies
|
7290
|
+
properties:
|
7291
|
+
data:
|
7292
|
+
description: A list of Agent policy objects
|
7293
|
+
items:
|
7294
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData'
|
7295
|
+
type: array
|
7296
|
+
type: object
|
7297
|
+
CloudWorkloadSecurityAgentPolicyAttributes:
|
7298
|
+
description: A Cloud Workload Security Agent policy returned by the API
|
7299
|
+
properties:
|
7300
|
+
blockingRulesCount:
|
7301
|
+
description: The number of rules with the blocking feature in this policy
|
7302
|
+
example: 100
|
7303
|
+
format: int32
|
7304
|
+
maximum: 2147483647
|
7305
|
+
type: integer
|
7306
|
+
datadogManaged:
|
7307
|
+
description: Whether the policy is managed by Datadog
|
7308
|
+
example: false
|
7309
|
+
type: boolean
|
7310
|
+
description:
|
7311
|
+
description: The description of the policy
|
7312
|
+
example: My agent policy
|
7313
|
+
type: string
|
7314
|
+
disabledRulesCount:
|
7315
|
+
description: The number of rules that are disabled in this policy
|
7316
|
+
example: 100
|
7317
|
+
format: int32
|
7318
|
+
maximum: 2147483647
|
7319
|
+
type: integer
|
7320
|
+
enabled:
|
7321
|
+
description: Whether the Agent policy is enabled
|
7322
|
+
example: true
|
7323
|
+
type: boolean
|
7324
|
+
hostTags:
|
7325
|
+
description: The host tags defining where this policy is deployed
|
7326
|
+
items:
|
7327
|
+
type: string
|
7328
|
+
type: array
|
7329
|
+
hostTagsLists:
|
7330
|
+
description: The host tags defining where this policy is deployed, the inner
|
7331
|
+
values are linked with AND, the outer values are linked with OR
|
7332
|
+
items:
|
7333
|
+
items:
|
7334
|
+
type: string
|
7335
|
+
type: array
|
7336
|
+
type: array
|
7337
|
+
monitoringRulesCount:
|
7338
|
+
description: The number of rules in the monitoring state in this policy
|
7339
|
+
example: 100
|
7340
|
+
format: int32
|
7341
|
+
maximum: 2147483647
|
7342
|
+
type: integer
|
7343
|
+
name:
|
7344
|
+
description: The name of the policy
|
7345
|
+
example: my_agent_policy
|
7346
|
+
type: string
|
7347
|
+
policyVersion:
|
7348
|
+
description: The version of the policy
|
7349
|
+
example: '1'
|
7350
|
+
type: string
|
7351
|
+
priority:
|
7352
|
+
description: The priority of the policy
|
7353
|
+
example: 10
|
7354
|
+
format: int64
|
7355
|
+
type: integer
|
7356
|
+
ruleCount:
|
7357
|
+
description: The number of rules in this policy
|
7358
|
+
example: 100
|
7359
|
+
format: int32
|
7360
|
+
maximum: 2147483647
|
7361
|
+
type: integer
|
7362
|
+
updateDate:
|
7363
|
+
description: Timestamp in milliseconds when the policy was last updated
|
7364
|
+
example: 1624366480320
|
7365
|
+
format: int64
|
7366
|
+
type: integer
|
7367
|
+
updatedAt:
|
7368
|
+
description: When the policy was last updated, timestamp in milliseconds
|
7369
|
+
example: 1624366480320
|
7370
|
+
format: int64
|
7371
|
+
type: integer
|
7372
|
+
updater:
|
7373
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdaterAttributes'
|
7374
|
+
type: object
|
7375
|
+
CloudWorkloadSecurityAgentPolicyCreateAttributes:
|
7376
|
+
description: Create a new Cloud Workload Security Agent policy
|
7377
|
+
properties:
|
7378
|
+
description:
|
7379
|
+
description: The description of the policy
|
7380
|
+
example: My agent policy
|
7381
|
+
type: string
|
7382
|
+
enabled:
|
7383
|
+
description: Whether the policy is enabled
|
7384
|
+
example: true
|
7385
|
+
type: boolean
|
7386
|
+
hostTags:
|
7387
|
+
description: The host tags defining where this policy is deployed
|
7388
|
+
items:
|
7389
|
+
type: string
|
7390
|
+
type: array
|
7391
|
+
hostTagsLists:
|
7392
|
+
description: The host tags defining where this policy is deployed, the inner
|
7393
|
+
values are linked with AND, the outer values are linked with OR
|
7394
|
+
items:
|
7395
|
+
items:
|
7396
|
+
type: string
|
7397
|
+
type: array
|
7398
|
+
type: array
|
7399
|
+
name:
|
7400
|
+
description: The name of the policy
|
7401
|
+
example: my_agent_policy
|
7402
|
+
type: string
|
7403
|
+
required:
|
7404
|
+
- name
|
7405
|
+
type: object
|
7406
|
+
CloudWorkloadSecurityAgentPolicyCreateData:
|
7407
|
+
description: Object for a single Agent rule
|
7408
|
+
properties:
|
7409
|
+
attributes:
|
7410
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateAttributes'
|
7411
|
+
type:
|
7412
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType'
|
7413
|
+
required:
|
7414
|
+
- attributes
|
7415
|
+
- type
|
7416
|
+
type: object
|
7417
|
+
CloudWorkloadSecurityAgentPolicyCreateRequest:
|
7418
|
+
description: Request object that includes the Agent policy to create
|
7419
|
+
properties:
|
7420
|
+
data:
|
7421
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateData'
|
7422
|
+
required:
|
7423
|
+
- data
|
7424
|
+
type: object
|
7425
|
+
CloudWorkloadSecurityAgentPolicyData:
|
7426
|
+
description: Object for a single Agent policy
|
7427
|
+
properties:
|
7428
|
+
attributes:
|
7429
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyAttributes'
|
7430
|
+
id:
|
7431
|
+
description: The ID of the Agent policy
|
7432
|
+
example: 6517fcc1-cec7-4394-a655-8d6e9d085255
|
7433
|
+
type: string
|
7434
|
+
type:
|
7435
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType'
|
7436
|
+
type: object
|
7437
|
+
CloudWorkloadSecurityAgentPolicyID:
|
7438
|
+
description: The ID of the Agent policy
|
7439
|
+
example: 6517fcc1-cec7-4394-a655-8d6e9d085255
|
7440
|
+
type: string
|
7441
|
+
CloudWorkloadSecurityAgentPolicyResponse:
|
7442
|
+
description: Response object that includes an Agent policy
|
7443
|
+
properties:
|
7444
|
+
data:
|
7445
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData'
|
7446
|
+
type: object
|
7447
|
+
CloudWorkloadSecurityAgentPolicyType:
|
7448
|
+
default: policy
|
7449
|
+
description: The type of the resource, must always be `policy`
|
7450
|
+
enum:
|
7451
|
+
- policy
|
7452
|
+
example: policy
|
7453
|
+
type: string
|
7454
|
+
x-enum-varnames:
|
7455
|
+
- POLICY
|
7456
|
+
CloudWorkloadSecurityAgentPolicyUpdateAttributes:
|
7457
|
+
description: Update an existing Cloud Workload Security Agent policy
|
7458
|
+
properties:
|
7459
|
+
description:
|
7460
|
+
description: The description of the policy
|
7461
|
+
example: My agent policy
|
7462
|
+
type: string
|
7463
|
+
enabled:
|
7464
|
+
description: Whether the policy is enabled
|
7465
|
+
example: true
|
7466
|
+
type: boolean
|
7467
|
+
hostTags:
|
7468
|
+
description: The host tags defining where this policy is deployed
|
7469
|
+
items:
|
7470
|
+
type: string
|
7471
|
+
type: array
|
7472
|
+
hostTagsLists:
|
7473
|
+
description: The host tags defining where this policy is deployed, the inner
|
7474
|
+
values are linked with AND, the outer values are linked with OR
|
7475
|
+
items:
|
7476
|
+
items:
|
7477
|
+
type: string
|
7478
|
+
type: array
|
7479
|
+
type: array
|
7480
|
+
name:
|
7481
|
+
description: The name of the policy
|
7482
|
+
example: my_agent_policy
|
7483
|
+
type: string
|
7484
|
+
type: object
|
7485
|
+
CloudWorkloadSecurityAgentPolicyUpdateData:
|
7486
|
+
description: Object for a single Agent policy
|
7487
|
+
properties:
|
7488
|
+
attributes:
|
7489
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateAttributes'
|
7490
|
+
id:
|
7491
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyID'
|
7492
|
+
type:
|
7493
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType'
|
7494
|
+
required:
|
7495
|
+
- attributes
|
7496
|
+
- type
|
7497
|
+
type: object
|
7498
|
+
CloudWorkloadSecurityAgentPolicyUpdateRequest:
|
7499
|
+
description: Request object that includes the Agent policy with the attributes
|
7500
|
+
to update
|
7501
|
+
properties:
|
7502
|
+
data:
|
7503
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateData'
|
7504
|
+
required:
|
7505
|
+
- data
|
7506
|
+
type: object
|
7507
|
+
CloudWorkloadSecurityAgentPolicyUpdaterAttributes:
|
7508
|
+
description: The attributes of the user who last updated the policy
|
7509
|
+
properties:
|
7510
|
+
handle:
|
7511
|
+
description: The handle of the user
|
7512
|
+
example: datadog.user@example.com
|
7513
|
+
type: string
|
7514
|
+
name:
|
7515
|
+
description: The name of the user
|
7516
|
+
example: Datadog User
|
7517
|
+
nullable: true
|
7518
|
+
type: string
|
7519
|
+
type: object
|
7215
7520
|
CloudWorkloadSecurityAgentRuleAction:
|
7216
|
-
description: The action the rule can perform if triggered
|
7521
|
+
description: The action the rule can perform if triggered
|
7217
7522
|
properties:
|
7218
7523
|
filter:
|
7219
7524
|
description: SECL expression used to target the container to apply the action
|
@@ -7223,77 +7528,82 @@ components:
|
|
7223
7528
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
|
7224
7529
|
type: object
|
7225
7530
|
CloudWorkloadSecurityAgentRuleActions:
|
7226
|
-
description: The array of actions the rule can perform if triggered
|
7531
|
+
description: The array of actions the rule can perform if triggered
|
7227
7532
|
items:
|
7228
7533
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAction'
|
7229
7534
|
nullable: true
|
7230
7535
|
type: array
|
7231
7536
|
CloudWorkloadSecurityAgentRuleAttributes:
|
7232
|
-
description: A Cloud Workload Security Agent rule returned by the API
|
7537
|
+
description: A Cloud Workload Security Agent rule returned by the API
|
7233
7538
|
properties:
|
7234
7539
|
actions:
|
7235
7540
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
7236
7541
|
agentConstraint:
|
7237
|
-
description: The version of the
|
7542
|
+
description: The version of the Agent
|
7238
7543
|
type: string
|
7239
7544
|
category:
|
7240
|
-
description: The category of the Agent rule
|
7545
|
+
description: The category of the Agent rule
|
7241
7546
|
example: Process Activity
|
7242
7547
|
type: string
|
7243
7548
|
creationAuthorUuId:
|
7244
|
-
description: The ID of the user who created the rule
|
7549
|
+
description: The ID of the user who created the rule
|
7245
7550
|
example: e51c9744-d158-11ec-ad23-da7ad0900002
|
7246
7551
|
type: string
|
7247
7552
|
creationDate:
|
7248
|
-
description: When the Agent rule was created, timestamp in milliseconds
|
7553
|
+
description: When the Agent rule was created, timestamp in milliseconds
|
7249
7554
|
example: 1624366480320
|
7250
7555
|
format: int64
|
7251
7556
|
type: integer
|
7252
7557
|
creator:
|
7253
7558
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreatorAttributes'
|
7254
7559
|
defaultRule:
|
7255
|
-
description: Whether the rule is included by default
|
7560
|
+
description: Whether the rule is included by default
|
7256
7561
|
example: false
|
7257
7562
|
type: boolean
|
7258
7563
|
description:
|
7259
|
-
description: The description of the Agent rule
|
7564
|
+
description: The description of the Agent rule
|
7260
7565
|
example: My Agent rule
|
7261
7566
|
type: string
|
7262
7567
|
enabled:
|
7263
|
-
description: Whether the Agent rule is enabled
|
7568
|
+
description: Whether the Agent rule is enabled
|
7264
7569
|
example: true
|
7265
7570
|
type: boolean
|
7266
7571
|
expression:
|
7267
|
-
description: The SECL expression of the Agent rule
|
7268
|
-
example: exec.file.name ==
|
7572
|
+
description: The SECL expression of the Agent rule
|
7573
|
+
example: exec.file.name == "sh"
|
7269
7574
|
type: string
|
7270
7575
|
filters:
|
7271
|
-
description: The platforms the Agent rule is supported on
|
7576
|
+
description: The platforms the Agent rule is supported on
|
7272
7577
|
items:
|
7273
7578
|
type: string
|
7274
7579
|
type: array
|
7275
7580
|
name:
|
7276
|
-
description: The name of the Agent rule
|
7581
|
+
description: The name of the Agent rule
|
7277
7582
|
example: my_agent_rule
|
7278
7583
|
type: string
|
7584
|
+
product_tags:
|
7585
|
+
description: The list of product tags associated with the rule
|
7586
|
+
items:
|
7587
|
+
type: string
|
7588
|
+
type: array
|
7279
7589
|
updateAuthorUuId:
|
7280
|
-
description: The ID of the user who updated the rule
|
7590
|
+
description: The ID of the user who updated the rule
|
7281
7591
|
example: e51c9744-d158-11ec-ad23-da7ad0900002
|
7282
7592
|
type: string
|
7283
7593
|
updateDate:
|
7284
|
-
description: Timestamp in milliseconds when the Agent rule was last updated
|
7594
|
+
description: Timestamp in milliseconds when the Agent rule was last updated
|
7285
7595
|
example: 1624366480320
|
7286
7596
|
format: int64
|
7287
7597
|
type: integer
|
7288
7598
|
updatedAt:
|
7289
|
-
description: When the Agent rule was last updated, timestamp in milliseconds
|
7599
|
+
description: When the Agent rule was last updated, timestamp in milliseconds
|
7290
7600
|
example: 1624366480320
|
7291
7601
|
format: int64
|
7292
7602
|
type: integer
|
7293
7603
|
updater:
|
7294
7604
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdaterAttributes'
|
7295
7605
|
version:
|
7296
|
-
description: The version of the Agent rule
|
7606
|
+
description: The version of the Agent rule
|
7297
7607
|
example: 23
|
7298
7608
|
format: int64
|
7299
7609
|
type: integer
|
@@ -7306,15 +7616,15 @@ components:
|
|
7306
7616
|
example: My Agent rule
|
7307
7617
|
type: string
|
7308
7618
|
enabled:
|
7309
|
-
description: Whether the Agent rule is enabled
|
7619
|
+
description: Whether the Agent rule is enabled
|
7310
7620
|
example: true
|
7311
7621
|
type: boolean
|
7312
7622
|
expression:
|
7313
7623
|
description: The SECL expression of the Agent rule.
|
7314
|
-
example: exec.file.name ==
|
7624
|
+
example: exec.file.name == "sh"
|
7315
7625
|
type: string
|
7316
7626
|
filters:
|
7317
|
-
description: The platforms the Agent rule is supported on
|
7627
|
+
description: The platforms the Agent rule is supported on
|
7318
7628
|
items:
|
7319
7629
|
type: string
|
7320
7630
|
type: array
|
@@ -7322,12 +7632,21 @@ components:
|
|
7322
7632
|
description: The name of the Agent rule.
|
7323
7633
|
example: my_agent_rule
|
7324
7634
|
type: string
|
7635
|
+
policy_id:
|
7636
|
+
description: The ID of the policy where the Agent rule is saved
|
7637
|
+
example: a8c8e364-6556-434d-b798-a4c23de29c0b
|
7638
|
+
type: string
|
7639
|
+
product_tags:
|
7640
|
+
description: The list of product tags associated with the rule
|
7641
|
+
items:
|
7642
|
+
type: string
|
7643
|
+
type: array
|
7325
7644
|
required:
|
7326
7645
|
- name
|
7327
7646
|
- expression
|
7328
7647
|
type: object
|
7329
7648
|
CloudWorkloadSecurityAgentRuleCreateData:
|
7330
|
-
description: Object for a single Agent rule
|
7649
|
+
description: Object for a single Agent rule
|
7331
7650
|
properties:
|
7332
7651
|
attributes:
|
7333
7652
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateAttributes'
|
@@ -7338,7 +7657,7 @@ components:
|
|
7338
7657
|
- type
|
7339
7658
|
type: object
|
7340
7659
|
CloudWorkloadSecurityAgentRuleCreateRequest:
|
7341
|
-
description: Request object that includes the Agent rule to create
|
7660
|
+
description: Request object that includes the Agent rule to create
|
7342
7661
|
properties:
|
7343
7662
|
data:
|
7344
7663
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateData'
|
@@ -7346,50 +7665,50 @@ components:
|
|
7346
7665
|
- data
|
7347
7666
|
type: object
|
7348
7667
|
CloudWorkloadSecurityAgentRuleCreatorAttributes:
|
7349
|
-
description: The attributes of the user who created the Agent rule
|
7668
|
+
description: The attributes of the user who created the Agent rule
|
7350
7669
|
properties:
|
7351
7670
|
handle:
|
7352
|
-
description: The handle of the user
|
7671
|
+
description: The handle of the user
|
7353
7672
|
example: datadog.user@example.com
|
7354
7673
|
type: string
|
7355
7674
|
name:
|
7356
|
-
description: The name of the user
|
7675
|
+
description: The name of the user
|
7357
7676
|
example: Datadog User
|
7358
7677
|
nullable: true
|
7359
7678
|
type: string
|
7360
7679
|
type: object
|
7361
7680
|
CloudWorkloadSecurityAgentRuleData:
|
7362
|
-
description: Object for a single Agent rule
|
7681
|
+
description: Object for a single Agent rule
|
7363
7682
|
properties:
|
7364
7683
|
attributes:
|
7365
7684
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAttributes'
|
7366
7685
|
id:
|
7367
|
-
description: The ID of the Agent rule
|
7686
|
+
description: The ID of the Agent rule
|
7368
7687
|
example: 3dd-0uc-h1s
|
7369
7688
|
type: string
|
7370
7689
|
type:
|
7371
7690
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
|
7372
7691
|
type: object
|
7373
7692
|
CloudWorkloadSecurityAgentRuleID:
|
7374
|
-
description: The ID of the
|
7693
|
+
description: The ID of the Agent rule
|
7375
7694
|
example: 3dd-0uc-h1s
|
7376
7695
|
type: string
|
7377
7696
|
CloudWorkloadSecurityAgentRuleKill:
|
7378
7697
|
description: Kill system call applied on the container matching the rule
|
7379
7698
|
properties:
|
7380
7699
|
signal:
|
7381
|
-
description: Supported signals for the kill system call
|
7700
|
+
description: Supported signals for the kill system call
|
7382
7701
|
type: string
|
7383
7702
|
type: object
|
7384
7703
|
CloudWorkloadSecurityAgentRuleResponse:
|
7385
|
-
description: Response object that includes an Agent rule
|
7704
|
+
description: Response object that includes an Agent rule
|
7386
7705
|
properties:
|
7387
7706
|
data:
|
7388
7707
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData'
|
7389
7708
|
type: object
|
7390
7709
|
CloudWorkloadSecurityAgentRuleType:
|
7391
7710
|
default: agent_rule
|
7392
|
-
description: The type of the resource
|
7711
|
+
description: The type of the resource, must always be `agent_rule`
|
7393
7712
|
enum:
|
7394
7713
|
- agent_rule
|
7395
7714
|
example: agent_rule
|
@@ -7397,23 +7716,32 @@ components:
|
|
7397
7716
|
x-enum-varnames:
|
7398
7717
|
- AGENT_RULE
|
7399
7718
|
CloudWorkloadSecurityAgentRuleUpdateAttributes:
|
7400
|
-
description: Update an existing Cloud Workload Security Agent rule
|
7719
|
+
description: Update an existing Cloud Workload Security Agent rule
|
7401
7720
|
properties:
|
7402
7721
|
description:
|
7403
|
-
description: The description of the Agent rule
|
7722
|
+
description: The description of the Agent rule
|
7404
7723
|
example: My Agent rule
|
7405
7724
|
type: string
|
7406
7725
|
enabled:
|
7407
|
-
description: Whether the Agent rule is enabled
|
7726
|
+
description: Whether the Agent rule is enabled
|
7408
7727
|
example: true
|
7409
7728
|
type: boolean
|
7410
7729
|
expression:
|
7411
|
-
description: The SECL expression of the Agent rule
|
7412
|
-
example: exec.file.name ==
|
7730
|
+
description: The SECL expression of the Agent rule
|
7731
|
+
example: exec.file.name == "sh"
|
7413
7732
|
type: string
|
7733
|
+
policy_id:
|
7734
|
+
description: The ID of the policy where the Agent rule is saved
|
7735
|
+
example: a8c8e364-6556-434d-b798-a4c23de29c0b
|
7736
|
+
type: string
|
7737
|
+
product_tags:
|
7738
|
+
description: The list of product tags associated with the rule
|
7739
|
+
items:
|
7740
|
+
type: string
|
7741
|
+
type: array
|
7414
7742
|
type: object
|
7415
7743
|
CloudWorkloadSecurityAgentRuleUpdateData:
|
7416
|
-
description: Object for a single Agent rule
|
7744
|
+
description: Object for a single Agent rule
|
7417
7745
|
properties:
|
7418
7746
|
attributes:
|
7419
7747
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes'
|
@@ -7427,7 +7755,7 @@ components:
|
|
7427
7755
|
type: object
|
7428
7756
|
CloudWorkloadSecurityAgentRuleUpdateRequest:
|
7429
7757
|
description: Request object that includes the Agent rule with the attributes
|
7430
|
-
to update
|
7758
|
+
to update
|
7431
7759
|
properties:
|
7432
7760
|
data:
|
7433
7761
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateData'
|
@@ -7435,23 +7763,23 @@ components:
|
|
7435
7763
|
- data
|
7436
7764
|
type: object
|
7437
7765
|
CloudWorkloadSecurityAgentRuleUpdaterAttributes:
|
7438
|
-
description: The attributes of the user who last updated the Agent rule
|
7766
|
+
description: The attributes of the user who last updated the Agent rule
|
7439
7767
|
properties:
|
7440
7768
|
handle:
|
7441
|
-
description: The handle of the user
|
7769
|
+
description: The handle of the user
|
7442
7770
|
example: datadog.user@example.com
|
7443
7771
|
type: string
|
7444
7772
|
name:
|
7445
|
-
description: The name of the user
|
7773
|
+
description: The name of the user
|
7446
7774
|
example: Datadog User
|
7447
7775
|
nullable: true
|
7448
7776
|
type: string
|
7449
7777
|
type: object
|
7450
7778
|
CloudWorkloadSecurityAgentRulesListResponse:
|
7451
|
-
description: Response object that includes a list of Agent rule
|
7779
|
+
description: Response object that includes a list of Agent rule
|
7452
7780
|
properties:
|
7453
7781
|
data:
|
7454
|
-
description: A list of Agent rules objects
|
7782
|
+
description: A list of Agent rules objects
|
7455
7783
|
items:
|
7456
7784
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData'
|
7457
7785
|
type: array
|
@@ -9200,6 +9528,107 @@ components:
|
|
9200
9528
|
id:
|
9201
9529
|
$ref: '#/components/schemas/ApiID'
|
9202
9530
|
type: object
|
9531
|
+
CreatePageRequest:
|
9532
|
+
description: Full request to trigger an On-Call Page.
|
9533
|
+
example:
|
9534
|
+
data:
|
9535
|
+
attributes:
|
9536
|
+
description: Page details.
|
9537
|
+
tags:
|
9538
|
+
- service:test
|
9539
|
+
target:
|
9540
|
+
identifier: my-team
|
9541
|
+
type: team_handle
|
9542
|
+
title: Page title
|
9543
|
+
urgency: low
|
9544
|
+
type: pages
|
9545
|
+
properties:
|
9546
|
+
data:
|
9547
|
+
$ref: '#/components/schemas/CreatePageRequestData'
|
9548
|
+
type: object
|
9549
|
+
CreatePageRequestData:
|
9550
|
+
description: The main request body, including attributes and resource type.
|
9551
|
+
properties:
|
9552
|
+
attributes:
|
9553
|
+
$ref: '#/components/schemas/CreatePageRequestDataAttributes'
|
9554
|
+
type:
|
9555
|
+
$ref: '#/components/schemas/CreatePageRequestDataType'
|
9556
|
+
required:
|
9557
|
+
- type
|
9558
|
+
type: object
|
9559
|
+
CreatePageRequestDataAttributes:
|
9560
|
+
description: Details about the On-Call Page you want to create.
|
9561
|
+
properties:
|
9562
|
+
description:
|
9563
|
+
description: A short summary of the issue or context.
|
9564
|
+
type: string
|
9565
|
+
tags:
|
9566
|
+
description: Tags to help categorize or filter the page.
|
9567
|
+
items:
|
9568
|
+
type: string
|
9569
|
+
type: array
|
9570
|
+
target:
|
9571
|
+
$ref: '#/components/schemas/CreatePageRequestDataAttributesTarget'
|
9572
|
+
title:
|
9573
|
+
description: The title of the page.
|
9574
|
+
example: 'Service: Test is down'
|
9575
|
+
type: string
|
9576
|
+
urgency:
|
9577
|
+
$ref: '#/components/schemas/PageUrgency'
|
9578
|
+
required:
|
9579
|
+
- target
|
9580
|
+
- title
|
9581
|
+
- urgency
|
9582
|
+
type: object
|
9583
|
+
CreatePageRequestDataAttributesTarget:
|
9584
|
+
description: Information about the target to notify (such as a team or user).
|
9585
|
+
properties:
|
9586
|
+
identifier:
|
9587
|
+
description: Identifier for the target (for example, team handle or user
|
9588
|
+
ID).
|
9589
|
+
type: string
|
9590
|
+
type:
|
9591
|
+
$ref: '#/components/schemas/OnCallPageTargetType'
|
9592
|
+
type: object
|
9593
|
+
CreatePageRequestDataType:
|
9594
|
+
default: pages
|
9595
|
+
description: The type of resource used when creating an On-Call Page.
|
9596
|
+
enum:
|
9597
|
+
- pages
|
9598
|
+
example: pages
|
9599
|
+
type: string
|
9600
|
+
x-enum-varnames:
|
9601
|
+
- PAGES
|
9602
|
+
CreatePageResponse:
|
9603
|
+
description: The full response object after creating a new On-Call Page.
|
9604
|
+
example:
|
9605
|
+
data:
|
9606
|
+
id: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
|
9607
|
+
type: pages
|
9608
|
+
properties:
|
9609
|
+
data:
|
9610
|
+
$ref: '#/components/schemas/CreatePageResponseData'
|
9611
|
+
type: object
|
9612
|
+
CreatePageResponseData:
|
9613
|
+
description: The information returned after successfully creating a page.
|
9614
|
+
properties:
|
9615
|
+
id:
|
9616
|
+
description: The unique ID of the created page.
|
9617
|
+
type: string
|
9618
|
+
type:
|
9619
|
+
$ref: '#/components/schemas/CreatePageResponseDataType'
|
9620
|
+
required:
|
9621
|
+
- type
|
9622
|
+
type: object
|
9623
|
+
CreatePageResponseDataType:
|
9624
|
+
default: pages
|
9625
|
+
description: The type of resource used when creating an On-Call Page.
|
9626
|
+
enum:
|
9627
|
+
- pages
|
9628
|
+
example: pages
|
9629
|
+
type: string
|
9630
|
+
x-enum-varnames:
|
9631
|
+
- PAGES
|
9203
9632
|
CreateRuleRequest:
|
9204
9633
|
description: Scorecard create rule request.
|
9205
9634
|
properties:
|
@@ -10564,8 +10993,6 @@ components:
|
|
10564
10993
|
- handle
|
10565
10994
|
- version
|
10566
10995
|
- name
|
10567
|
-
- description
|
10568
|
-
- icon_url
|
10569
10996
|
type: object
|
10570
10997
|
DORADeploymentRequest:
|
10571
10998
|
description: Request to create a DORA deployment event.
|
@@ -10656,6 +11083,25 @@ components:
|
|
10656
11083
|
type: string
|
10657
11084
|
x-enum-varnames:
|
10658
11085
|
- DORA_DEPLOYMENT
|
11086
|
+
DORAEvent:
|
11087
|
+
description: A DORA event.
|
11088
|
+
properties:
|
11089
|
+
attributes:
|
11090
|
+
description: The attributes of the event.
|
11091
|
+
type: object
|
11092
|
+
id:
|
11093
|
+
description: The ID of the event.
|
11094
|
+
type: string
|
11095
|
+
type:
|
11096
|
+
description: The type of the event.
|
11097
|
+
type: string
|
11098
|
+
type: object
|
11099
|
+
DORAFetchResponse:
|
11100
|
+
description: Response for the DORA fetch endpoints.
|
11101
|
+
properties:
|
11102
|
+
data:
|
11103
|
+
$ref: '#/components/schemas/DORAEvent'
|
11104
|
+
type: object
|
10659
11105
|
DORAGitInfo:
|
10660
11106
|
description: Git info for DORA Metrics events.
|
10661
11107
|
properties:
|
@@ -10691,7 +11137,8 @@ components:
|
|
10691
11137
|
git:
|
10692
11138
|
$ref: '#/components/schemas/DORAGitInfo'
|
10693
11139
|
id:
|
10694
|
-
description: Incident ID.
|
11140
|
+
description: Incident ID. Must have at least 16 characters. Required to
|
11141
|
+
update a previously sent incident.
|
10695
11142
|
type: string
|
10696
11143
|
name:
|
10697
11144
|
description: Incident name.
|
@@ -10766,6 +11213,113 @@ components:
|
|
10766
11213
|
type: string
|
10767
11214
|
x-enum-varnames:
|
10768
11215
|
- DORA_INCIDENT
|
11216
|
+
DORAListDeploymentsRequest:
|
11217
|
+
description: Request to get a list of deployments.
|
11218
|
+
properties:
|
11219
|
+
data:
|
11220
|
+
$ref: '#/components/schemas/DORAListDeploymentsRequestData'
|
11221
|
+
required:
|
11222
|
+
- data
|
11223
|
+
type: object
|
11224
|
+
DORAListDeploymentsRequestAttributes:
|
11225
|
+
description: Attributes to get a list of deployments.
|
11226
|
+
properties:
|
11227
|
+
from:
|
11228
|
+
description: Minimum timestamp for requested events.
|
11229
|
+
format: date-time
|
11230
|
+
type: string
|
11231
|
+
limit:
|
11232
|
+
default: 10
|
11233
|
+
description: Maximum number of events in the response.
|
11234
|
+
format: int32
|
11235
|
+
maximum: 1000
|
11236
|
+
type: integer
|
11237
|
+
query:
|
11238
|
+
description: Search query with event platform syntax.
|
11239
|
+
type: string
|
11240
|
+
sort:
|
11241
|
+
description: Sort order (prefixed with `-` for descending).
|
11242
|
+
type: string
|
11243
|
+
to:
|
11244
|
+
description: Maximum timestamp for requested events.
|
11245
|
+
format: date-time
|
11246
|
+
type: string
|
11247
|
+
type: object
|
11248
|
+
DORAListDeploymentsRequestData:
|
11249
|
+
description: The JSON:API data.
|
11250
|
+
properties:
|
11251
|
+
attributes:
|
11252
|
+
$ref: '#/components/schemas/DORAListDeploymentsRequestAttributes'
|
11253
|
+
type:
|
11254
|
+
$ref: '#/components/schemas/DORAListDeploymentsRequestDataType'
|
11255
|
+
required:
|
11256
|
+
- attributes
|
11257
|
+
type: object
|
11258
|
+
DORAListDeploymentsRequestDataType:
|
11259
|
+
description: The definition of `DORAListDeploymentsRequestDataType` object.
|
11260
|
+
enum:
|
11261
|
+
- dora_deployments_list_request
|
11262
|
+
type: string
|
11263
|
+
x-enum-varnames:
|
11264
|
+
- DORA_DEPLOYMENTS_LIST_REQUEST
|
11265
|
+
DORAListFailuresRequest:
|
11266
|
+
description: Request to get a list of failures.
|
11267
|
+
properties:
|
11268
|
+
data:
|
11269
|
+
$ref: '#/components/schemas/DORAListFailuresRequestData'
|
11270
|
+
required:
|
11271
|
+
- data
|
11272
|
+
type: object
|
11273
|
+
DORAListFailuresRequestAttributes:
|
11274
|
+
description: Attributes to get a list of failures.
|
11275
|
+
properties:
|
11276
|
+
from:
|
11277
|
+
description: Minimum timestamp for requested events.
|
11278
|
+
format: date-time
|
11279
|
+
type: string
|
11280
|
+
limit:
|
11281
|
+
default: 10
|
11282
|
+
description: Maximum number of events in the response.
|
11283
|
+
format: int32
|
11284
|
+
maximum: 1000
|
11285
|
+
type: integer
|
11286
|
+
query:
|
11287
|
+
description: Search query with event platform syntax.
|
11288
|
+
type: string
|
11289
|
+
sort:
|
11290
|
+
description: Sort order (prefixed with `-` for descending).
|
11291
|
+
type: string
|
11292
|
+
to:
|
11293
|
+
description: Maximum timestamp for requested events.
|
11294
|
+
format: date-time
|
11295
|
+
type: string
|
11296
|
+
type: object
|
11297
|
+
DORAListFailuresRequestData:
|
11298
|
+
description: The JSON:API data.
|
11299
|
+
properties:
|
11300
|
+
attributes:
|
11301
|
+
$ref: '#/components/schemas/DORAListFailuresRequestAttributes'
|
11302
|
+
type:
|
11303
|
+
$ref: '#/components/schemas/DORAListFailuresRequestDataType'
|
11304
|
+
required:
|
11305
|
+
- attributes
|
11306
|
+
type: object
|
11307
|
+
DORAListFailuresRequestDataType:
|
11308
|
+
description: The definition of `DORAListFailuresRequestDataType` object.
|
11309
|
+
enum:
|
11310
|
+
- dora_failures_list_request
|
11311
|
+
type: string
|
11312
|
+
x-enum-varnames:
|
11313
|
+
- DORA_FAILURES_LIST_REQUEST
|
11314
|
+
DORAListResponse:
|
11315
|
+
description: Response for the DORA list endpoints.
|
11316
|
+
properties:
|
11317
|
+
data:
|
11318
|
+
description: The list of DORA events.
|
11319
|
+
items:
|
11320
|
+
$ref: '#/components/schemas/DORAEvent'
|
11321
|
+
type: array
|
11322
|
+
type: object
|
10769
11323
|
DashboardListAddItemsRequest:
|
10770
11324
|
description: Request containing a list of dashboards to add.
|
10771
11325
|
properties:
|
@@ -11097,6 +11651,38 @@ components:
|
|
11097
11651
|
example: canceled
|
11098
11652
|
type: string
|
11099
11653
|
type: object
|
11654
|
+
DataRelationshipsTeams:
|
11655
|
+
description: Associates teams with this schedule in a data structure.
|
11656
|
+
properties:
|
11657
|
+
data:
|
11658
|
+
description: An array of team references for this schedule.
|
11659
|
+
items:
|
11660
|
+
$ref: '#/components/schemas/DataRelationshipsTeamsDataItems'
|
11661
|
+
type: array
|
11662
|
+
type: object
|
11663
|
+
DataRelationshipsTeamsDataItems:
|
11664
|
+
description: Relates a team to this schedule, identified by `id` and `type`
|
11665
|
+
(must be `teams`).
|
11666
|
+
properties:
|
11667
|
+
id:
|
11668
|
+
description: The unique identifier of the team in this relationship.
|
11669
|
+
example: 00000000-da3a-0000-0000-000000000000
|
11670
|
+
type: string
|
11671
|
+
type:
|
11672
|
+
$ref: '#/components/schemas/DataRelationshipsTeamsDataItemsType'
|
11673
|
+
required:
|
11674
|
+
- type
|
11675
|
+
- id
|
11676
|
+
type: object
|
11677
|
+
DataRelationshipsTeamsDataItemsType:
|
11678
|
+
default: teams
|
11679
|
+
description: Teams resource type.
|
11680
|
+
enum:
|
11681
|
+
- teams
|
11682
|
+
example: teams
|
11683
|
+
type: string
|
11684
|
+
x-enum-varnames:
|
11685
|
+
- TEAMS
|
11100
11686
|
DataScalarColumn:
|
11101
11687
|
description: A column containing the numerical results for a formula or query.
|
11102
11688
|
properties:
|
@@ -12646,7 +13232,6 @@ components:
|
|
12646
13232
|
type: array
|
12647
13233
|
repositoryURL:
|
12648
13234
|
description: The repository path of the source code of the entity.
|
12649
|
-
pattern: url
|
12650
13235
|
type: string
|
12651
13236
|
type: object
|
12652
13237
|
EntityV3DatadogCodeLocations:
|
@@ -13172,7 +13757,6 @@ components:
|
|
13172
13757
|
example:
|
13173
13758
|
data:
|
13174
13759
|
attributes:
|
13175
|
-
description: Escalation Policy 1 description
|
13176
13760
|
name: Escalation Policy 1
|
13177
13761
|
resolve_page_on_policy_end: true
|
13178
13762
|
retries: 2
|
@@ -13231,7 +13815,6 @@ components:
|
|
13231
13815
|
example:
|
13232
13816
|
data:
|
13233
13817
|
attributes:
|
13234
|
-
description: Escalation Policy 1 description
|
13235
13818
|
name: Escalation Policy 1
|
13236
13819
|
resolve_page_on_policy_end: true
|
13237
13820
|
retries: 2
|
@@ -13282,13 +13865,9 @@ components:
|
|
13282
13865
|
description: Defines the attributes for creating an escalation policy, including
|
13283
13866
|
its description, name, resolution behavior, retries, and steps.
|
13284
13867
|
properties:
|
13285
|
-
description:
|
13286
|
-
description: Provides a detailed text description of the new escalation
|
13287
|
-
policy.
|
13288
|
-
type: string
|
13289
13868
|
name:
|
13290
13869
|
description: Specifies the name for the new escalation policy.
|
13291
|
-
example: On-
|
13870
|
+
example: On-Call Escalation Policy
|
13292
13871
|
type: string
|
13293
13872
|
resolve_page_on_policy_end:
|
13294
13873
|
description: Indicates whether the page is automatically resolved when the
|
@@ -13314,7 +13893,7 @@ components:
|
|
13314
13893
|
request. Contains assignment strategy, escalation timeout, and a list of targets.
|
13315
13894
|
properties:
|
13316
13895
|
assignment:
|
13317
|
-
$ref: '#/components/schemas/
|
13896
|
+
$ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment'
|
13318
13897
|
escalate_after_seconds:
|
13319
13898
|
description: Defines how many seconds to wait before escalating to the next
|
13320
13899
|
step.
|
@@ -13323,87 +13902,21 @@ components:
|
|
13323
13902
|
type: integer
|
13324
13903
|
targets:
|
13325
13904
|
description: Specifies the collection of escalation targets for this step.
|
13905
|
+
example:
|
13906
|
+
- users
|
13326
13907
|
items:
|
13327
|
-
$ref: '#/components/schemas/
|
13908
|
+
$ref: '#/components/schemas/EscalationPolicyStepTarget'
|
13328
13909
|
type: array
|
13329
13910
|
required:
|
13330
13911
|
- targets
|
13331
13912
|
type: object
|
13332
|
-
EscalationPolicyCreateRequestDataAttributesStepsItemsAssignment:
|
13333
|
-
description: Specifies how this escalation step will assign targets (example
|
13334
|
-
`default` or `round-robin`).
|
13335
|
-
enum:
|
13336
|
-
- default
|
13337
|
-
- round-robin
|
13338
|
-
example: default
|
13339
|
-
type: string
|
13340
|
-
x-enum-varnames:
|
13341
|
-
- DEFAULT
|
13342
|
-
- ROUND_ROBIN
|
13343
|
-
EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItems:
|
13344
|
-
description: Defines a single escalation target within a step for an escalation
|
13345
|
-
policy creation request. Contains `id` and `type`.
|
13346
|
-
properties:
|
13347
|
-
id:
|
13348
|
-
description: Specifies the unique identifier for this target.
|
13349
|
-
example: 00000000-aba1-0000-0000-000000000000
|
13350
|
-
type: string
|
13351
|
-
type:
|
13352
|
-
$ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItemsType'
|
13353
|
-
type: object
|
13354
|
-
EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItemsType:
|
13355
|
-
description: Specifies the type of escalation target (example `users`, `schedules`,
|
13356
|
-
or `teams`).
|
13357
|
-
enum:
|
13358
|
-
- users
|
13359
|
-
- schedules
|
13360
|
-
- teams
|
13361
|
-
example: users
|
13362
|
-
type: string
|
13363
|
-
x-enum-varnames:
|
13364
|
-
- USERS
|
13365
|
-
- SCHEDULES
|
13366
|
-
- TEAMS
|
13367
13913
|
EscalationPolicyCreateRequestDataRelationships:
|
13368
13914
|
description: Represents relationships in an escalation policy creation request,
|
13369
13915
|
including references to teams.
|
13370
13916
|
properties:
|
13371
13917
|
teams:
|
13372
|
-
$ref: '#/components/schemas/
|
13373
|
-
type: object
|
13374
|
-
EscalationPolicyCreateRequestDataRelationshipsTeams:
|
13375
|
-
description: Defines the relationship to teams within an escalation policy creation
|
13376
|
-
request, referencing the teams to be associated with the policy.
|
13377
|
-
properties:
|
13378
|
-
data:
|
13379
|
-
description: An array of team references for the new escalation policy.
|
13380
|
-
items:
|
13381
|
-
$ref: '#/components/schemas/EscalationPolicyCreateRequestDataRelationshipsTeamsDataItems'
|
13382
|
-
type: array
|
13918
|
+
$ref: '#/components/schemas/DataRelationshipsTeams'
|
13383
13919
|
type: object
|
13384
|
-
EscalationPolicyCreateRequestDataRelationshipsTeamsDataItems:
|
13385
|
-
description: Defines a single relationship to a team within an escalation policy
|
13386
|
-
creation request. Contains the team's `id` and `type`.
|
13387
|
-
properties:
|
13388
|
-
id:
|
13389
|
-
description: Specifies the unique identifier for the related team.
|
13390
|
-
example: 00000000-aba1-0000-0000-000000000000
|
13391
|
-
type: string
|
13392
|
-
type:
|
13393
|
-
$ref: '#/components/schemas/EscalationPolicyCreateRequestDataRelationshipsTeamsDataItemsType'
|
13394
|
-
required:
|
13395
|
-
- type
|
13396
|
-
- id
|
13397
|
-
type: object
|
13398
|
-
EscalationPolicyCreateRequestDataRelationshipsTeamsDataItemsType:
|
13399
|
-
default: teams
|
13400
|
-
description: Indicates that the resource is of type `teams`.
|
13401
|
-
enum:
|
13402
|
-
- teams
|
13403
|
-
example: teams
|
13404
|
-
type: string
|
13405
|
-
x-enum-varnames:
|
13406
|
-
- TEAMS
|
13407
13920
|
EscalationPolicyCreateRequestDataType:
|
13408
13921
|
default: policies
|
13409
13922
|
description: Indicates that the resource is of type `policies`.
|
@@ -13432,14 +13945,11 @@ components:
|
|
13432
13945
|
type: object
|
13433
13946
|
EscalationPolicyDataAttributes:
|
13434
13947
|
description: Defines the main attributes of an escalation policy, such as its
|
13435
|
-
|
13948
|
+
name and behavior on policy end.
|
13436
13949
|
properties:
|
13437
|
-
description:
|
13438
|
-
description: Provides a detailed text description of the escalation policy.
|
13439
|
-
type: string
|
13440
13950
|
name:
|
13441
13951
|
description: Specifies the name of the escalation policy.
|
13442
|
-
example: On-
|
13952
|
+
example: On-Call Escalation Policy
|
13443
13953
|
type: string
|
13444
13954
|
resolve_page_on_policy_end:
|
13445
13955
|
description: Indicates whether the page is automatically resolved when the
|
@@ -13460,7 +13970,7 @@ components:
|
|
13460
13970
|
steps:
|
13461
13971
|
$ref: '#/components/schemas/EscalationPolicyDataRelationshipsSteps'
|
13462
13972
|
teams:
|
13463
|
-
$ref: '#/components/schemas/
|
13973
|
+
$ref: '#/components/schemas/DataRelationshipsTeams'
|
13464
13974
|
required:
|
13465
13975
|
- steps
|
13466
13976
|
type: object
|
@@ -13498,40 +14008,6 @@ components:
|
|
13498
14008
|
type: string
|
13499
14009
|
x-enum-varnames:
|
13500
14010
|
- STEPS
|
13501
|
-
EscalationPolicyDataRelationshipsTeams:
|
13502
|
-
description: Defines the relationship to a collection of teams within an escalation
|
13503
|
-
policy. Contains an array of team data references.
|
13504
|
-
properties:
|
13505
|
-
data:
|
13506
|
-
description: An array of references to the teams associated with this escalation
|
13507
|
-
policy.
|
13508
|
-
items:
|
13509
|
-
$ref: '#/components/schemas/EscalationPolicyDataRelationshipsTeamsDataItems'
|
13510
|
-
type: array
|
13511
|
-
type: object
|
13512
|
-
EscalationPolicyDataRelationshipsTeamsDataItems:
|
13513
|
-
description: Defines a relationship to a single team within an escalation policy.
|
13514
|
-
Contains the team's `id` and `type`.
|
13515
|
-
properties:
|
13516
|
-
id:
|
13517
|
-
description: Specifies the unique identifier for the team resource.
|
13518
|
-
example: 00000000-aba1-0000-0000-000000000000
|
13519
|
-
type: string
|
13520
|
-
type:
|
13521
|
-
$ref: '#/components/schemas/EscalationPolicyDataRelationshipsTeamsDataItemsType'
|
13522
|
-
required:
|
13523
|
-
- type
|
13524
|
-
- id
|
13525
|
-
type: object
|
13526
|
-
EscalationPolicyDataRelationshipsTeamsDataItemsType:
|
13527
|
-
default: teams
|
13528
|
-
description: Indicates that the resource is of type `teams`.
|
13529
|
-
enum:
|
13530
|
-
- teams
|
13531
|
-
example: teams
|
13532
|
-
type: string
|
13533
|
-
x-enum-varnames:
|
13534
|
-
- TEAMS
|
13535
14011
|
EscalationPolicyDataType:
|
13536
14012
|
default: policies
|
13537
14013
|
description: Indicates that the resource is of type `policies`.
|
@@ -13547,9 +14023,8 @@ components:
|
|
13547
14023
|
oneOf:
|
13548
14024
|
- $ref: '#/components/schemas/TeamReference'
|
13549
14025
|
- $ref: '#/components/schemas/EscalationPolicyStep'
|
13550
|
-
- $ref: '#/components/schemas/
|
13551
|
-
- $ref: '#/components/schemas/
|
13552
|
-
- $ref: '#/components/schemas/TeamTarget'
|
14026
|
+
- $ref: '#/components/schemas/EscalationPolicyUser'
|
14027
|
+
- $ref: '#/components/schemas/ScheduleData'
|
13553
14028
|
EscalationPolicyStep:
|
13554
14029
|
description: Represents a single step in an escalation policy, including its
|
13555
14030
|
attributes, relationships, and resource type.
|
@@ -13593,8 +14068,32 @@ components:
|
|
13593
14068
|
targets.
|
13594
14069
|
properties:
|
13595
14070
|
targets:
|
13596
|
-
$ref: '#/components/schemas/
|
14071
|
+
$ref: '#/components/schemas/EscalationTargets'
|
14072
|
+
type: object
|
14073
|
+
EscalationPolicyStepTarget:
|
14074
|
+
description: Defines a single escalation target within a step for an escalation
|
14075
|
+
policy creation request. Contains `id` and `type`.
|
14076
|
+
properties:
|
14077
|
+
id:
|
14078
|
+
description: Specifies the unique identifier for this target.
|
14079
|
+
example: 00000000-aba1-0000-0000-000000000000
|
14080
|
+
type: string
|
14081
|
+
type:
|
14082
|
+
$ref: '#/components/schemas/EscalationPolicyStepTargetType'
|
13597
14083
|
type: object
|
14084
|
+
EscalationPolicyStepTargetType:
|
14085
|
+
description: Specifies the type of escalation target (example `users`, `schedules`,
|
14086
|
+
or `teams`).
|
14087
|
+
enum:
|
14088
|
+
- users
|
14089
|
+
- schedules
|
14090
|
+
- teams
|
14091
|
+
example: users
|
14092
|
+
type: string
|
14093
|
+
x-enum-varnames:
|
14094
|
+
- USERS
|
14095
|
+
- SCHEDULES
|
14096
|
+
- TEAMS
|
13598
14097
|
EscalationPolicyStepType:
|
13599
14098
|
default: steps
|
13600
14099
|
description: Indicates that the resource is of type `steps`.
|
@@ -13610,7 +14109,6 @@ components:
|
|
13610
14109
|
example:
|
13611
14110
|
data:
|
13612
14111
|
attributes:
|
13613
|
-
description: Escalation Policy 1 description
|
13614
14112
|
name: Escalation Policy 1
|
13615
14113
|
resolve_page_on_policy_end: false
|
13616
14114
|
retries: 2
|
@@ -13660,12 +14158,9 @@ components:
|
|
13660
14158
|
description: Defines the attributes that can be updated for an escalation policy,
|
13661
14159
|
such as description, name, resolution behavior, retries, and steps.
|
13662
14160
|
properties:
|
13663
|
-
description:
|
13664
|
-
description: Provides a detailed text description of the escalation policy.
|
13665
|
-
type: string
|
13666
14161
|
name:
|
13667
14162
|
description: Specifies the name of the escalation policy.
|
13668
|
-
example: On-
|
14163
|
+
example: On-Call Escalation Policy
|
13669
14164
|
type: string
|
13670
14165
|
resolve_page_on_policy_end:
|
13671
14166
|
description: Indicates whether the page is automatically resolved when the
|
@@ -13692,7 +14187,7 @@ components:
|
|
13692
14187
|
ID, and a list of targets.
|
13693
14188
|
properties:
|
13694
14189
|
assignment:
|
13695
|
-
$ref: '#/components/schemas/
|
14190
|
+
$ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment'
|
13696
14191
|
escalate_after_seconds:
|
13697
14192
|
description: Defines how many seconds to wait before escalating to the next
|
13698
14193
|
step.
|
@@ -13706,95 +14201,65 @@ components:
|
|
13706
14201
|
targets:
|
13707
14202
|
description: Specifies the collection of escalation targets for this step.
|
13708
14203
|
items:
|
13709
|
-
$ref: '#/components/schemas/
|
14204
|
+
$ref: '#/components/schemas/EscalationPolicyStepTarget'
|
13710
14205
|
type: array
|
13711
14206
|
required:
|
13712
14207
|
- targets
|
13713
14208
|
type: object
|
13714
|
-
EscalationPolicyUpdateRequestDataAttributesStepsItemsAssignment:
|
13715
|
-
description: Specifies how this escalation step will assign targets (example
|
13716
|
-
`default` or `round-robin`).
|
13717
|
-
enum:
|
13718
|
-
- default
|
13719
|
-
- round-robin
|
13720
|
-
example: default
|
13721
|
-
type: string
|
13722
|
-
x-enum-varnames:
|
13723
|
-
- DEFAULT
|
13724
|
-
- ROUND_ROBIN
|
13725
|
-
EscalationPolicyUpdateRequestDataAttributesStepsItemsTargetsItems:
|
13726
|
-
description: Defines a single escalation target within a step for an escalation
|
13727
|
-
policy update request. Contains `id` and `type`.
|
13728
|
-
properties:
|
13729
|
-
id:
|
13730
|
-
description: Specifies the unique identifier for this target.
|
13731
|
-
example: 00000000-aba1-0000-0000-000000000000
|
13732
|
-
type: string
|
13733
|
-
type:
|
13734
|
-
$ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItemsTargetsItemsType'
|
13735
|
-
type: object
|
13736
|
-
EscalationPolicyUpdateRequestDataAttributesStepsItemsTargetsItemsType:
|
13737
|
-
description: Specifies the type of escalation target (example `users`, `schedules`,
|
13738
|
-
or `teams`).
|
13739
|
-
enum:
|
13740
|
-
- users
|
13741
|
-
- schedules
|
13742
|
-
- teams
|
13743
|
-
example: users
|
13744
|
-
type: string
|
13745
|
-
x-enum-varnames:
|
13746
|
-
- USERS
|
13747
|
-
- SCHEDULES
|
13748
|
-
- TEAMS
|
13749
14209
|
EscalationPolicyUpdateRequestDataRelationships:
|
13750
14210
|
description: Represents relationships in an escalation policy update request,
|
13751
14211
|
including references to teams.
|
13752
14212
|
properties:
|
13753
14213
|
teams:
|
13754
|
-
$ref: '#/components/schemas/
|
14214
|
+
$ref: '#/components/schemas/DataRelationshipsTeams'
|
13755
14215
|
type: object
|
13756
|
-
|
13757
|
-
|
13758
|
-
|
13759
|
-
|
13760
|
-
|
13761
|
-
|
13762
|
-
|
13763
|
-
|
13764
|
-
|
13765
|
-
|
13766
|
-
|
13767
|
-
|
13768
|
-
update request. Contains the team's `id` and `type`.
|
14216
|
+
EscalationPolicyUpdateRequestDataType:
|
14217
|
+
default: policies
|
14218
|
+
description: Indicates that the resource is of type `policies`.
|
14219
|
+
enum:
|
14220
|
+
- policies
|
14221
|
+
example: policies
|
14222
|
+
type: string
|
14223
|
+
x-enum-varnames:
|
14224
|
+
- POLICIES
|
14225
|
+
EscalationPolicyUser:
|
14226
|
+
description: Represents a user object in the context of an escalation policy,
|
14227
|
+
including their `id`, type, and basic attributes.
|
13769
14228
|
properties:
|
14229
|
+
attributes:
|
14230
|
+
$ref: '#/components/schemas/EscalationPolicyUserAttributes'
|
13770
14231
|
id:
|
13771
|
-
description:
|
13772
|
-
example: 00000000-aba1-0000-0000-000000000000
|
14232
|
+
description: The unique user identifier.
|
13773
14233
|
type: string
|
13774
14234
|
type:
|
13775
|
-
$ref: '#/components/schemas/
|
14235
|
+
$ref: '#/components/schemas/EscalationPolicyUserType'
|
13776
14236
|
required:
|
13777
14237
|
- type
|
13778
|
-
- id
|
13779
14238
|
type: object
|
13780
|
-
|
13781
|
-
|
13782
|
-
|
13783
|
-
|
13784
|
-
|
13785
|
-
|
13786
|
-
|
13787
|
-
|
13788
|
-
|
13789
|
-
|
13790
|
-
|
13791
|
-
|
14239
|
+
EscalationPolicyUserAttributes:
|
14240
|
+
description: Provides basic user information for an escalation policy, including
|
14241
|
+
a name and email address.
|
14242
|
+
properties:
|
14243
|
+
email:
|
14244
|
+
description: The user's email address.
|
14245
|
+
example: jane.doe@example.com
|
14246
|
+
type: string
|
14247
|
+
name:
|
14248
|
+
description: The user's name.
|
14249
|
+
example: Jane Doe
|
14250
|
+
type: string
|
14251
|
+
status:
|
14252
|
+
$ref: '#/components/schemas/UserAttributesStatus'
|
14253
|
+
type: object
|
14254
|
+
EscalationPolicyUserType:
|
14255
|
+
default: users
|
14256
|
+
description: Users resource type.
|
13792
14257
|
enum:
|
13793
|
-
-
|
13794
|
-
example:
|
14258
|
+
- users
|
14259
|
+
example: users
|
13795
14260
|
type: string
|
13796
14261
|
x-enum-varnames:
|
13797
|
-
-
|
14262
|
+
- USERS
|
13798
14263
|
EscalationTarget:
|
13799
14264
|
description: Represents an escalation target, which can be a team, user, or
|
13800
14265
|
schedule.
|
@@ -13802,6 +14267,15 @@ components:
|
|
13802
14267
|
- $ref: '#/components/schemas/TeamTarget'
|
13803
14268
|
- $ref: '#/components/schemas/UserTarget'
|
13804
14269
|
- $ref: '#/components/schemas/ScheduleTarget'
|
14270
|
+
EscalationTargets:
|
14271
|
+
description: A list of escalation targets for a step
|
14272
|
+
properties:
|
14273
|
+
data:
|
14274
|
+
description: The `EscalationTargets` `data`.
|
14275
|
+
items:
|
14276
|
+
$ref: '#/components/schemas/EscalationTarget'
|
14277
|
+
type: array
|
14278
|
+
type: object
|
13805
14279
|
Event:
|
13806
14280
|
description: The metadata associated with a request.
|
13807
14281
|
properties:
|
@@ -14965,10 +15439,6 @@ components:
|
|
14965
15439
|
FullCustomFrameworkDataAttributes:
|
14966
15440
|
description: Full Framework Data Attributes.
|
14967
15441
|
properties:
|
14968
|
-
description:
|
14969
|
-
description: Framework Description
|
14970
|
-
example: this is a security framework
|
14971
|
-
type: string
|
14972
15442
|
handle:
|
14973
15443
|
description: Framework Handle
|
14974
15444
|
example: sec2
|
@@ -14994,8 +15464,6 @@ components:
|
|
14994
15464
|
- handle
|
14995
15465
|
- version
|
14996
15466
|
- name
|
14997
|
-
- description
|
14998
|
-
- icon_url
|
14999
15467
|
- requirements
|
15000
15468
|
type: object
|
15001
15469
|
GCPMetricNamespaceConfig:
|
@@ -15426,6 +15894,26 @@ components:
|
|
15426
15894
|
$ref: '#/components/schemas/GetInterfacesData'
|
15427
15895
|
type: array
|
15428
15896
|
type: object
|
15897
|
+
GetResourceEvaluationFiltersResponse:
|
15898
|
+
description: The definition of `GetResourceEvaluationFiltersResponse` object.
|
15899
|
+
properties:
|
15900
|
+
data:
|
15901
|
+
$ref: '#/components/schemas/GetResourceEvaluationFiltersResponseData'
|
15902
|
+
required:
|
15903
|
+
- data
|
15904
|
+
type: object
|
15905
|
+
GetResourceEvaluationFiltersResponseData:
|
15906
|
+
description: The definition of `GetResourceFilterResponseData` object.
|
15907
|
+
properties:
|
15908
|
+
attributes:
|
15909
|
+
$ref: '#/components/schemas/ResourceFilterAttributes'
|
15910
|
+
id:
|
15911
|
+
description: The `data` `id`.
|
15912
|
+
example: csm_resource_filter
|
15913
|
+
type: string
|
15914
|
+
type:
|
15915
|
+
$ref: '#/components/schemas/ResourceFilterRequestType'
|
15916
|
+
type: object
|
15429
15917
|
GetRuleVersionHistoryData:
|
15430
15918
|
description: Data for the rule version history.
|
15431
15919
|
properties:
|
@@ -15630,7 +16118,6 @@ components:
|
|
15630
16118
|
base_url:
|
15631
16119
|
description: Base HTTP url for the integration
|
15632
16120
|
example: http://datadoghq.com
|
15633
|
-
pattern: url
|
15634
16121
|
type: string
|
15635
16122
|
credentials:
|
15636
16123
|
$ref: '#/components/schemas/HTTPCredentials'
|
@@ -15655,7 +16142,6 @@ components:
|
|
15655
16142
|
base_url:
|
15656
16143
|
description: Base HTTP url for the integration
|
15657
16144
|
example: http://datadoghq.com
|
15658
|
-
pattern: url
|
15659
16145
|
type: string
|
15660
16146
|
credentials:
|
15661
16147
|
$ref: '#/components/schemas/HTTPCredentialsUpdate'
|
@@ -17400,6 +17886,7 @@ components:
|
|
17400
17886
|
description: The incident severity.
|
17401
17887
|
enum:
|
17402
17888
|
- UNKNOWN
|
17889
|
+
- SEV-0
|
17403
17890
|
- SEV-1
|
17404
17891
|
- SEV-2
|
17405
17892
|
- SEV-3
|
@@ -17409,6 +17896,7 @@ components:
|
|
17409
17896
|
type: string
|
17410
17897
|
x-enum-varnames:
|
17411
17898
|
- UNKNOWN
|
17899
|
+
- SEV_0
|
17412
17900
|
- SEV_1
|
17413
17901
|
- SEV_2
|
17414
17902
|
- SEV_3
|
@@ -18671,7 +19159,7 @@ components:
|
|
18671
19159
|
description: An optional list of time restrictions for when this layer is
|
18672
19160
|
in effect.
|
18673
19161
|
items:
|
18674
|
-
$ref: '#/components/schemas/
|
19162
|
+
$ref: '#/components/schemas/TimeRestriction'
|
18675
19163
|
type: array
|
18676
19164
|
rotation_start:
|
18677
19165
|
description: The date/time when the rotation starts (ISO 8601).
|
@@ -18695,63 +19183,6 @@ components:
|
|
18695
19183
|
maximum: 2592000
|
18696
19184
|
type: integer
|
18697
19185
|
type: object
|
18698
|
-
LayerAttributesRestrictionsItems:
|
18699
|
-
description: 'Represents a time restriction within a layer, specifying the days
|
18700
|
-
and times
|
18701
|
-
|
18702
|
-
when this layer is active or inactive.'
|
18703
|
-
properties:
|
18704
|
-
end_day:
|
18705
|
-
$ref: '#/components/schemas/LayerAttributesRestrictionsItemsEndDay'
|
18706
|
-
end_time:
|
18707
|
-
description: The time of day the restriction ends (hh:mm:ss).
|
18708
|
-
example: '17:00:00'
|
18709
|
-
type: string
|
18710
|
-
start_day:
|
18711
|
-
$ref: '#/components/schemas/LayerAttributesRestrictionsItemsStartDay'
|
18712
|
-
start_time:
|
18713
|
-
description: The time of day the restriction begins (hh:mm:ss).
|
18714
|
-
example: 09:00:00
|
18715
|
-
type: string
|
18716
|
-
type: object
|
18717
|
-
LayerAttributesRestrictionsItemsEndDay:
|
18718
|
-
description: Defines the end day of the restriction within a Layer.
|
18719
|
-
enum:
|
18720
|
-
- monday
|
18721
|
-
- tuesday
|
18722
|
-
- wednesday
|
18723
|
-
- thursday
|
18724
|
-
- friday
|
18725
|
-
- saturday
|
18726
|
-
- sunday
|
18727
|
-
type: string
|
18728
|
-
x-enum-varnames:
|
18729
|
-
- MONDAY
|
18730
|
-
- TUESDAY
|
18731
|
-
- WEDNESDAY
|
18732
|
-
- THURSDAY
|
18733
|
-
- FRIDAY
|
18734
|
-
- SATURDAY
|
18735
|
-
- SUNDAY
|
18736
|
-
LayerAttributesRestrictionsItemsStartDay:
|
18737
|
-
description: Defines the start day of the restriction within a Layer.
|
18738
|
-
enum:
|
18739
|
-
- monday
|
18740
|
-
- tuesday
|
18741
|
-
- wednesday
|
18742
|
-
- thursday
|
18743
|
-
- friday
|
18744
|
-
- saturday
|
18745
|
-
- sunday
|
18746
|
-
type: string
|
18747
|
-
x-enum-varnames:
|
18748
|
-
- MONDAY
|
18749
|
-
- TUESDAY
|
18750
|
-
- WEDNESDAY
|
18751
|
-
- THURSDAY
|
18752
|
-
- FRIDAY
|
18753
|
-
- SATURDAY
|
18754
|
-
- SUNDAY
|
18755
19186
|
LayerRelationships:
|
18756
19187
|
description: Holds references to objects related to the Layer entity, such as
|
18757
19188
|
its members.
|
@@ -19217,6 +19648,38 @@ components:
|
|
19217
19648
|
meta:
|
19218
19649
|
$ref: '#/components/schemas/PowerpacksResponseMeta'
|
19219
19650
|
type: object
|
19651
|
+
ListRelationCatalogResponse:
|
19652
|
+
description: List entity relation response.
|
19653
|
+
properties:
|
19654
|
+
data:
|
19655
|
+
$ref: '#/components/schemas/RelationResponseData'
|
19656
|
+
included:
|
19657
|
+
$ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
|
19658
|
+
links:
|
19659
|
+
$ref: '#/components/schemas/ListRelationCatalogResponseLinks'
|
19660
|
+
meta:
|
19661
|
+
$ref: '#/components/schemas/RelationResponseMeta'
|
19662
|
+
type: object
|
19663
|
+
ListRelationCatalogResponseIncluded:
|
19664
|
+
description: List relation response included entities.
|
19665
|
+
items:
|
19666
|
+
$ref: '#/components/schemas/EntityData'
|
19667
|
+
type: array
|
19668
|
+
ListRelationCatalogResponseLinks:
|
19669
|
+
description: List relation response links.
|
19670
|
+
properties:
|
19671
|
+
next:
|
19672
|
+
description: Next link.
|
19673
|
+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
|
19674
|
+
type: string
|
19675
|
+
previous:
|
19676
|
+
description: Previous link.
|
19677
|
+
type: string
|
19678
|
+
self:
|
19679
|
+
description: Current link.
|
19680
|
+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
|
19681
|
+
type: string
|
19682
|
+
type: object
|
19220
19683
|
ListRulesResponse:
|
19221
19684
|
description: Scorecard rules response.
|
19222
19685
|
properties:
|
@@ -20939,38 +21402,8 @@ components:
|
|
20939
21402
|
- space
|
20940
21403
|
type: object
|
20941
21404
|
MetricCustomAggregations:
|
20942
|
-
description:
|
20943
|
-
|
20944
|
-
|
20945
|
-
By default, count and rate metrics require the (time: sum, space: sum) aggregation
|
20946
|
-
and
|
20947
|
-
|
20948
|
-
Gauge metrics require the (time: avg, space: avg) aggregation.
|
20949
|
-
|
20950
|
-
Additional time & space combinations are also available:
|
20951
|
-
|
20952
|
-
|
20953
|
-
- time: avg, space: avg
|
20954
|
-
|
20955
|
-
- time: avg, space: max
|
20956
|
-
|
20957
|
-
- time: avg, space: min
|
20958
|
-
|
20959
|
-
- time: avg, space: sum
|
20960
|
-
|
20961
|
-
- time: count, space: sum
|
20962
|
-
|
20963
|
-
- time: max, space: max
|
20964
|
-
|
20965
|
-
- time: min, space: min
|
20966
|
-
|
20967
|
-
- time: sum, space: avg
|
20968
|
-
|
20969
|
-
- time: sum, space: sum
|
20970
|
-
|
20971
|
-
|
20972
|
-
Can only be applied to non_distribution metrics that have a `metric_type`
|
20973
|
-
of `count`, `rate`, or `gauge`.'
|
21405
|
+
description: Deprecated. You no longer need to configure specific time and space
|
21406
|
+
aggregations for Metrics Without Limits.
|
20974
21407
|
example:
|
20975
21408
|
- space: sum
|
20976
21409
|
time: sum
|
@@ -24174,7 +24607,8 @@ components:
|
|
24174
24607
|
description: Optional prefix for object keys within the GCS bucket.
|
24175
24608
|
type: string
|
24176
24609
|
metadata:
|
24177
|
-
description: Custom metadata
|
24610
|
+
description: Custom metadata to attach to each object uploaded to the GCS
|
24611
|
+
bucket.
|
24178
24612
|
items:
|
24179
24613
|
$ref: '#/components/schemas/ObservabilityPipelineMetadataEntry'
|
24180
24614
|
type: array
|
@@ -24190,7 +24624,6 @@ components:
|
|
24190
24624
|
- auth
|
24191
24625
|
- storage_class
|
24192
24626
|
- acl
|
24193
|
-
- metadata
|
24194
24627
|
type: object
|
24195
24628
|
ObservabilityPipelineGoogleCloudStorageDestinationAcl:
|
24196
24629
|
description: Access control list setting for objects written to the bucket.
|
@@ -24469,8 +24902,7 @@ components:
|
|
24469
24902
|
x-enum-varnames:
|
24470
24903
|
- LOGSTASH
|
24471
24904
|
ObservabilityPipelineMetadataEntry:
|
24472
|
-
description: A custom metadata entry
|
24473
|
-
GCS bucket.
|
24905
|
+
description: A custom metadata entry.
|
24474
24906
|
properties:
|
24475
24907
|
name:
|
24476
24908
|
description: The metadata key.
|
@@ -26268,6 +26700,18 @@ components:
|
|
26268
26700
|
$ref: '#/components/schemas/OktaAccountResponseData'
|
26269
26701
|
type: array
|
26270
26702
|
type: object
|
26703
|
+
OnCallPageTargetType:
|
26704
|
+
description: The kind of target, `team_id` | `team_handle` | `user_id`.
|
26705
|
+
enum:
|
26706
|
+
- team_id
|
26707
|
+
- team_handle
|
26708
|
+
- user_id
|
26709
|
+
example: team_id
|
26710
|
+
type: string
|
26711
|
+
x-enum-varnames:
|
26712
|
+
- TEAM_ID
|
26713
|
+
- TEAM_HANDLE
|
26714
|
+
- USER_ID
|
26271
26715
|
OnDemandConcurrencyCap:
|
26272
26716
|
description: On-demand concurrency cap.
|
26273
26717
|
properties:
|
@@ -26898,6 +27342,17 @@ components:
|
|
26898
27342
|
- ARRAY_NUMBER
|
26899
27343
|
- ARRAY_BOOLEAN
|
26900
27344
|
- ARRAY_OBJECT
|
27345
|
+
PageUrgency:
|
27346
|
+
default: high
|
27347
|
+
description: On-Call Page urgency level.
|
27348
|
+
enum:
|
27349
|
+
- low
|
27350
|
+
- high
|
27351
|
+
example: high
|
27352
|
+
type: string
|
27353
|
+
x-enum-varnames:
|
27354
|
+
- LOW
|
27355
|
+
- HIGH
|
26901
27356
|
Pagination:
|
26902
27357
|
description: Pagination object.
|
26903
27358
|
properties:
|
@@ -28519,6 +28974,114 @@ components:
|
|
28519
28974
|
x-enum-varnames:
|
28520
28975
|
- ANY
|
28521
28976
|
- ALL
|
28977
|
+
RelationAttributes:
|
28978
|
+
description: Relation attributes.
|
28979
|
+
properties:
|
28980
|
+
from:
|
28981
|
+
$ref: '#/components/schemas/RelationEntity'
|
28982
|
+
to:
|
28983
|
+
$ref: '#/components/schemas/RelationEntity'
|
28984
|
+
type:
|
28985
|
+
$ref: '#/components/schemas/RelationType'
|
28986
|
+
type: object
|
28987
|
+
RelationEntity:
|
28988
|
+
description: Relation entity reference.
|
28989
|
+
properties:
|
28990
|
+
kind:
|
28991
|
+
description: Entity kind.
|
28992
|
+
type: string
|
28993
|
+
name:
|
28994
|
+
description: Entity name.
|
28995
|
+
type: string
|
28996
|
+
namespace:
|
28997
|
+
description: Entity namespace.
|
28998
|
+
type: string
|
28999
|
+
type: object
|
29000
|
+
RelationIncludeType:
|
29001
|
+
description: Supported include types for relations.
|
29002
|
+
enum:
|
29003
|
+
- entity
|
29004
|
+
- schema
|
29005
|
+
type: string
|
29006
|
+
x-enum-varnames:
|
29007
|
+
- ENTITY
|
29008
|
+
- SCHEMA
|
29009
|
+
RelationMeta:
|
29010
|
+
description: Relation metadata.
|
29011
|
+
properties:
|
29012
|
+
createdAt:
|
29013
|
+
description: Relation creation time.
|
29014
|
+
format: date-time
|
29015
|
+
type: string
|
29016
|
+
definedBy:
|
29017
|
+
description: Relation defined by.
|
29018
|
+
type: string
|
29019
|
+
modifiedAt:
|
29020
|
+
description: Relation modification time.
|
29021
|
+
format: date-time
|
29022
|
+
type: string
|
29023
|
+
source:
|
29024
|
+
description: Relation source.
|
29025
|
+
type: string
|
29026
|
+
type: object
|
29027
|
+
RelationRelationships:
|
29028
|
+
description: Relation relationships.
|
29029
|
+
properties:
|
29030
|
+
fromEntity:
|
29031
|
+
$ref: '#/components/schemas/RelationToEntity'
|
29032
|
+
toEntity:
|
29033
|
+
$ref: '#/components/schemas/RelationToEntity'
|
29034
|
+
type: object
|
29035
|
+
RelationResponse:
|
29036
|
+
description: Relation response data.
|
29037
|
+
properties:
|
29038
|
+
attributes:
|
29039
|
+
$ref: '#/components/schemas/RelationAttributes'
|
29040
|
+
id:
|
29041
|
+
description: Relation ID.
|
29042
|
+
type: string
|
29043
|
+
meta:
|
29044
|
+
$ref: '#/components/schemas/RelationMeta'
|
29045
|
+
relationships:
|
29046
|
+
$ref: '#/components/schemas/RelationRelationships'
|
29047
|
+
subtype:
|
29048
|
+
description: Relation subtype.
|
29049
|
+
type: string
|
29050
|
+
type:
|
29051
|
+
$ref: '#/components/schemas/RelationResponseType'
|
29052
|
+
type: object
|
29053
|
+
RelationResponseData:
|
29054
|
+
description: Array of relation responses
|
29055
|
+
items:
|
29056
|
+
$ref: '#/components/schemas/RelationResponse'
|
29057
|
+
type: array
|
29058
|
+
RelationResponseMeta:
|
29059
|
+
description: Relation response metadata.
|
29060
|
+
properties:
|
29061
|
+
count:
|
29062
|
+
description: Total relations count.
|
29063
|
+
format: int64
|
29064
|
+
type: integer
|
29065
|
+
includeCount:
|
29066
|
+
description: Total included data count.
|
29067
|
+
format: int64
|
29068
|
+
type: integer
|
29069
|
+
type: object
|
29070
|
+
RelationResponseType:
|
29071
|
+
description: Relation type.
|
29072
|
+
enum:
|
29073
|
+
- relation
|
29074
|
+
type: string
|
29075
|
+
x-enum-varnames:
|
29076
|
+
- RELATION
|
29077
|
+
RelationToEntity:
|
29078
|
+
description: Relation to entity.
|
29079
|
+
properties:
|
29080
|
+
data:
|
29081
|
+
$ref: '#/components/schemas/RelationshipItem'
|
29082
|
+
meta:
|
29083
|
+
$ref: '#/components/schemas/EntityMeta'
|
29084
|
+
type: object
|
28522
29085
|
RelationType:
|
28523
29086
|
description: Supported relation types.
|
28524
29087
|
enum:
|
@@ -29058,6 +29621,46 @@ components:
|
|
29058
29621
|
required:
|
29059
29622
|
- data
|
29060
29623
|
type: object
|
29624
|
+
ResourceFilterAttributes:
|
29625
|
+
description: Attributes of a resource filter.
|
29626
|
+
example:
|
29627
|
+
aws:
|
29628
|
+
'123456789':
|
29629
|
+
- environment:production
|
29630
|
+
- team:devops
|
29631
|
+
azure:
|
29632
|
+
sub-001:
|
29633
|
+
- app:frontend
|
29634
|
+
gcp:
|
29635
|
+
project-abc:
|
29636
|
+
- region:us-central1
|
29637
|
+
properties:
|
29638
|
+
cloud_provider:
|
29639
|
+
additionalProperties:
|
29640
|
+
additionalProperties:
|
29641
|
+
items:
|
29642
|
+
description: Tag filter in format "key:value"
|
29643
|
+
example: environment:production
|
29644
|
+
type: string
|
29645
|
+
type: array
|
29646
|
+
type: object
|
29647
|
+
description: A map of cloud provider names (e.g., "aws", "gcp", "azure")
|
29648
|
+
to a map of account/resource IDs and their associated tag filters.
|
29649
|
+
type: object
|
29650
|
+
uuid:
|
29651
|
+
description: The UUID of the resource filter.
|
29652
|
+
type: string
|
29653
|
+
required:
|
29654
|
+
- cloud_provider
|
29655
|
+
type: object
|
29656
|
+
ResourceFilterRequestType:
|
29657
|
+
description: Constant string to identify the request type.
|
29658
|
+
enum:
|
29659
|
+
- csm_resource_filter
|
29660
|
+
example: csm_resource_filter
|
29661
|
+
type: string
|
29662
|
+
x-enum-varnames:
|
29663
|
+
- CSM_RESOURCE_FILTER
|
29061
29664
|
ResponseMetaAttributes:
|
29062
29665
|
description: Object describing meta attributes of response.
|
29063
29666
|
properties:
|
@@ -29761,6 +30364,93 @@ components:
|
|
29761
30364
|
type: string
|
29762
30365
|
x-enum-varnames:
|
29763
30366
|
- ROLES
|
30367
|
+
RoutingRule:
|
30368
|
+
description: Represents a routing rule, including its attributes, relationships,
|
30369
|
+
and unique identifier.
|
30370
|
+
properties:
|
30371
|
+
attributes:
|
30372
|
+
$ref: '#/components/schemas/RoutingRuleAttributes'
|
30373
|
+
id:
|
30374
|
+
description: Specifies the unique identifier of this routing rule.
|
30375
|
+
type: string
|
30376
|
+
relationships:
|
30377
|
+
$ref: '#/components/schemas/RoutingRuleRelationships'
|
30378
|
+
type:
|
30379
|
+
$ref: '#/components/schemas/RoutingRuleType'
|
30380
|
+
required:
|
30381
|
+
- type
|
30382
|
+
type: object
|
30383
|
+
RoutingRuleAction:
|
30384
|
+
description: Defines an action that is executed when a routing rule matches
|
30385
|
+
certain criteria.
|
30386
|
+
oneOf:
|
30387
|
+
- $ref: '#/components/schemas/SendSlackMessageAction'
|
30388
|
+
- $ref: '#/components/schemas/SendTeamsMessageAction'
|
30389
|
+
RoutingRuleAttributes:
|
30390
|
+
description: Defines the configurable attributes of a routing rule, such as
|
30391
|
+
actions, query, time restriction, and urgency.
|
30392
|
+
properties:
|
30393
|
+
actions:
|
30394
|
+
description: Specifies the list of actions to perform when the routing rule
|
30395
|
+
matches.
|
30396
|
+
items:
|
30397
|
+
$ref: '#/components/schemas/RoutingRuleAction'
|
30398
|
+
type: array
|
30399
|
+
query:
|
30400
|
+
description: Defines the query or condition that triggers this routing rule.
|
30401
|
+
type: string
|
30402
|
+
time_restriction:
|
30403
|
+
$ref: '#/components/schemas/TimeRestrictions'
|
30404
|
+
nullable: true
|
30405
|
+
urgency:
|
30406
|
+
$ref: '#/components/schemas/Urgency'
|
30407
|
+
type: object
|
30408
|
+
RoutingRuleRelationships:
|
30409
|
+
description: Specifies relationships for a routing rule, linking to associated
|
30410
|
+
policy resources.
|
30411
|
+
properties:
|
30412
|
+
policy:
|
30413
|
+
$ref: '#/components/schemas/RoutingRuleRelationshipsPolicy'
|
30414
|
+
type: object
|
30415
|
+
RoutingRuleRelationshipsPolicy:
|
30416
|
+
description: Defines the relationship that links a routing rule to a policy.
|
30417
|
+
properties:
|
30418
|
+
data:
|
30419
|
+
$ref: '#/components/schemas/RoutingRuleRelationshipsPolicyData'
|
30420
|
+
nullable: true
|
30421
|
+
type: object
|
30422
|
+
RoutingRuleRelationshipsPolicyData:
|
30423
|
+
description: Represents the policy data reference, containing the policy's ID
|
30424
|
+
and resource type.
|
30425
|
+
properties:
|
30426
|
+
id:
|
30427
|
+
description: Specifies the unique identifier of the policy.
|
30428
|
+
example: ''
|
30429
|
+
type: string
|
30430
|
+
type:
|
30431
|
+
$ref: '#/components/schemas/RoutingRuleRelationshipsPolicyDataType'
|
30432
|
+
required:
|
30433
|
+
- type
|
30434
|
+
- id
|
30435
|
+
type: object
|
30436
|
+
RoutingRuleRelationshipsPolicyDataType:
|
30437
|
+
default: policies
|
30438
|
+
description: Indicates that the resource is of type 'policies'.
|
30439
|
+
enum:
|
30440
|
+
- policies
|
30441
|
+
example: policies
|
30442
|
+
type: string
|
30443
|
+
x-enum-varnames:
|
30444
|
+
- POLICIES
|
30445
|
+
RoutingRuleType:
|
30446
|
+
default: team_routing_rules
|
30447
|
+
description: Team routing rules resource type.
|
30448
|
+
enum:
|
30449
|
+
- team_routing_rules
|
30450
|
+
example: team_routing_rules
|
30451
|
+
type: string
|
30452
|
+
x-enum-varnames:
|
30453
|
+
- TEAM_ROUTING_RULES
|
29764
30454
|
RuleAttributes:
|
29765
30455
|
description: Details of a rule.
|
29766
30456
|
properties:
|
@@ -30868,9 +31558,6 @@ components:
|
|
30868
31558
|
data:
|
30869
31559
|
attributes:
|
30870
31560
|
name: On-Call Schedule
|
30871
|
-
tags:
|
30872
|
-
- tag1
|
30873
|
-
- tag2
|
30874
31561
|
time_zone: America/New_York
|
30875
31562
|
id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
|
30876
31563
|
relationships:
|
@@ -30954,9 +31641,6 @@ components:
|
|
30954
31641
|
start_time: 09:00:00
|
30955
31642
|
rotation_start: '2025-02-01T00:00:00Z'
|
30956
31643
|
name: On-Call Schedule
|
30957
|
-
tags:
|
30958
|
-
- tag1
|
30959
|
-
- tag2
|
30960
31644
|
time_zone: America/New_York
|
30961
31645
|
relationships:
|
30962
31646
|
teams:
|
@@ -30986,10 +31670,10 @@ components:
|
|
30986
31670
|
type: object
|
30987
31671
|
ScheduleCreateRequestDataAttributes:
|
30988
31672
|
description: Describes the main attributes for creating a new schedule, including
|
30989
|
-
name, layers, time zone
|
31673
|
+
name, layers, and time zone.
|
30990
31674
|
properties:
|
30991
31675
|
layers:
|
30992
|
-
description: The layers of
|
31676
|
+
description: The layers of On-Call coverage that define rotation intervals
|
30993
31677
|
and restrictions.
|
30994
31678
|
items:
|
30995
31679
|
$ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItems'
|
@@ -30998,11 +31682,6 @@ components:
|
|
30998
31682
|
description: A human-readable name for the new schedule.
|
30999
31683
|
example: Team A On-Call
|
31000
31684
|
type: string
|
31001
|
-
tags:
|
31002
|
-
description: A list of tags for categorizing or filtering the schedule.
|
31003
|
-
items:
|
31004
|
-
type: string
|
31005
|
-
type: array
|
31006
31685
|
time_zone:
|
31007
31686
|
description: The time zone in which the schedule is defined.
|
31008
31687
|
example: America/New_York
|
@@ -31027,11 +31706,11 @@ components:
|
|
31027
31706
|
format: date-time
|
31028
31707
|
type: string
|
31029
31708
|
interval:
|
31030
|
-
$ref: '#/components/schemas/
|
31709
|
+
$ref: '#/components/schemas/LayerAttributesInterval'
|
31031
31710
|
members:
|
31032
31711
|
description: A list of members who participate in this layer's rotation.
|
31033
31712
|
items:
|
31034
|
-
$ref: '#/components/schemas/
|
31713
|
+
$ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems'
|
31035
31714
|
type: array
|
31036
31715
|
name:
|
31037
31716
|
description: The name of this layer.
|
@@ -31041,7 +31720,7 @@ components:
|
|
31041
31720
|
description: Zero or more time-based restrictions (for example, only weekdays,
|
31042
31721
|
during business hours).
|
31043
31722
|
items:
|
31044
|
-
$ref: '#/components/schemas/
|
31723
|
+
$ref: '#/components/schemas/TimeRestriction'
|
31045
31724
|
type: array
|
31046
31725
|
rotation_start:
|
31047
31726
|
description: The date/time when the rotation for this layer starts (in ISO
|
@@ -31056,137 +31735,13 @@ components:
|
|
31056
31735
|
- effective_date
|
31057
31736
|
- members
|
31058
31737
|
type: object
|
31059
|
-
ScheduleCreateRequestDataAttributesLayersItemsInterval:
|
31060
|
-
description: Defines how frequently the rotation repeats, using days and/or
|
31061
|
-
seconds (up to certain limits).
|
31062
|
-
properties:
|
31063
|
-
days:
|
31064
|
-
description: The number of full days in each rotation period.
|
31065
|
-
example: 1
|
31066
|
-
format: int32
|
31067
|
-
maximum: 400
|
31068
|
-
type: integer
|
31069
|
-
seconds:
|
31070
|
-
description: Extra seconds that may be added to extend the rotation beyond
|
31071
|
-
whole days.
|
31072
|
-
example: 300
|
31073
|
-
format: int64
|
31074
|
-
maximum: 2592000
|
31075
|
-
type: integer
|
31076
|
-
type: object
|
31077
|
-
ScheduleCreateRequestDataAttributesLayersItemsMembersItems:
|
31078
|
-
description: Defines a single member within a schedule layer, including the
|
31079
|
-
reference to the underlying user.
|
31080
|
-
properties:
|
31081
|
-
user:
|
31082
|
-
$ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsMembersItemsUser'
|
31083
|
-
type: object
|
31084
|
-
ScheduleCreateRequestDataAttributesLayersItemsMembersItemsUser:
|
31085
|
-
description: Identifies the user participating in this layer as a single object
|
31086
|
-
with an `id`.
|
31087
|
-
properties:
|
31088
|
-
id:
|
31089
|
-
description: The user's ID.
|
31090
|
-
example: 00000000-aba1-0000-0000-000000000000
|
31091
|
-
type: string
|
31092
|
-
type: object
|
31093
|
-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems:
|
31094
|
-
description: 'Defines a time restriction for a schedule layer, including which
|
31095
|
-
day of the week
|
31096
|
-
|
31097
|
-
it starts and ends, along with start/end times.'
|
31098
|
-
properties:
|
31099
|
-
end_day:
|
31100
|
-
$ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay'
|
31101
|
-
end_time:
|
31102
|
-
description: The time of day when the restriction ends (hh:mm:ss).
|
31103
|
-
type: string
|
31104
|
-
start_day:
|
31105
|
-
$ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay'
|
31106
|
-
start_time:
|
31107
|
-
description: The time of day when the restriction begins (hh:mm:ss).
|
31108
|
-
type: string
|
31109
|
-
type: object
|
31110
|
-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay:
|
31111
|
-
description: The weekday when the restriction period ends (Monday through Sunday).
|
31112
|
-
enum:
|
31113
|
-
- monday
|
31114
|
-
- tuesday
|
31115
|
-
- wednesday
|
31116
|
-
- thursday
|
31117
|
-
- friday
|
31118
|
-
- saturday
|
31119
|
-
- sunday
|
31120
|
-
type: string
|
31121
|
-
x-enum-varnames:
|
31122
|
-
- MONDAY
|
31123
|
-
- TUESDAY
|
31124
|
-
- WEDNESDAY
|
31125
|
-
- THURSDAY
|
31126
|
-
- FRIDAY
|
31127
|
-
- SATURDAY
|
31128
|
-
- SUNDAY
|
31129
|
-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay:
|
31130
|
-
description: The weekday when the restriction period starts (Monday through
|
31131
|
-
Sunday).
|
31132
|
-
enum:
|
31133
|
-
- monday
|
31134
|
-
- tuesday
|
31135
|
-
- wednesday
|
31136
|
-
- thursday
|
31137
|
-
- friday
|
31138
|
-
- saturday
|
31139
|
-
- sunday
|
31140
|
-
type: string
|
31141
|
-
x-enum-varnames:
|
31142
|
-
- MONDAY
|
31143
|
-
- TUESDAY
|
31144
|
-
- WEDNESDAY
|
31145
|
-
- THURSDAY
|
31146
|
-
- FRIDAY
|
31147
|
-
- SATURDAY
|
31148
|
-
- SUNDAY
|
31149
31738
|
ScheduleCreateRequestDataRelationships:
|
31150
31739
|
description: Gathers relationship objects for the schedule creation request,
|
31151
31740
|
including the teams to associate.
|
31152
31741
|
properties:
|
31153
31742
|
teams:
|
31154
|
-
$ref: '#/components/schemas/
|
31155
|
-
type: object
|
31156
|
-
ScheduleCreateRequestDataRelationshipsTeams:
|
31157
|
-
description: Associates the new schedule with one or more teams.
|
31158
|
-
properties:
|
31159
|
-
data:
|
31160
|
-
description: An array of team references for this schedule.
|
31161
|
-
items:
|
31162
|
-
$ref: '#/components/schemas/ScheduleCreateRequestDataRelationshipsTeamsDataItems'
|
31163
|
-
type: array
|
31164
|
-
type: object
|
31165
|
-
ScheduleCreateRequestDataRelationshipsTeamsDataItems:
|
31166
|
-
description: 'Holds the relationship data linking this schedule to a particular
|
31167
|
-
team,
|
31168
|
-
|
31169
|
-
identified by `id` and `type`.'
|
31170
|
-
properties:
|
31171
|
-
id:
|
31172
|
-
description: A unique identifier for the team.
|
31173
|
-
example: ''
|
31174
|
-
type: string
|
31175
|
-
type:
|
31176
|
-
$ref: '#/components/schemas/ScheduleCreateRequestDataRelationshipsTeamsDataItemsType'
|
31177
|
-
required:
|
31178
|
-
- type
|
31179
|
-
- id
|
31743
|
+
$ref: '#/components/schemas/DataRelationshipsTeams'
|
31180
31744
|
type: object
|
31181
|
-
ScheduleCreateRequestDataRelationshipsTeamsDataItemsType:
|
31182
|
-
default: teams
|
31183
|
-
description: Teams resource type.
|
31184
|
-
enum:
|
31185
|
-
- teams
|
31186
|
-
example: teams
|
31187
|
-
type: string
|
31188
|
-
x-enum-varnames:
|
31189
|
-
- TEAMS
|
31190
31745
|
ScheduleCreateRequestDataType:
|
31191
31746
|
default: schedules
|
31192
31747
|
description: Schedules resource type.
|
@@ -31214,18 +31769,13 @@ components:
|
|
31214
31769
|
- type
|
31215
31770
|
type: object
|
31216
31771
|
ScheduleDataAttributes:
|
31217
|
-
description: Provides core properties of a schedule object
|
31218
|
-
time zone
|
31772
|
+
description: Provides core properties of a schedule object such as its name
|
31773
|
+
and time zone.
|
31219
31774
|
properties:
|
31220
31775
|
name:
|
31221
31776
|
description: A short name for the schedule.
|
31222
31777
|
example: Primary On-Call
|
31223
31778
|
type: string
|
31224
|
-
tags:
|
31225
|
-
description: A list of tags associated with this schedule.
|
31226
|
-
items:
|
31227
|
-
type: string
|
31228
|
-
type: array
|
31229
31779
|
time_zone:
|
31230
31780
|
description: The time zone in which this schedule operates.
|
31231
31781
|
example: America/New_York
|
@@ -31246,7 +31796,7 @@ components:
|
|
31246
31796
|
layers:
|
31247
31797
|
$ref: '#/components/schemas/ScheduleDataRelationshipsLayers'
|
31248
31798
|
teams:
|
31249
|
-
$ref: '#/components/schemas/
|
31799
|
+
$ref: '#/components/schemas/DataRelationshipsTeams'
|
31250
31800
|
type: object
|
31251
31801
|
ScheduleDataRelationshipsLayers:
|
31252
31802
|
description: Associates layers with this schedule in a data structure.
|
@@ -31280,38 +31830,6 @@ components:
|
|
31280
31830
|
type: string
|
31281
31831
|
x-enum-varnames:
|
31282
31832
|
- LAYERS
|
31283
|
-
ScheduleDataRelationshipsTeams:
|
31284
|
-
description: Associates teams with this schedule in a data structure.
|
31285
|
-
properties:
|
31286
|
-
data:
|
31287
|
-
description: An array of team references for this schedule.
|
31288
|
-
items:
|
31289
|
-
$ref: '#/components/schemas/ScheduleDataRelationshipsTeamsDataItems'
|
31290
|
-
type: array
|
31291
|
-
type: object
|
31292
|
-
ScheduleDataRelationshipsTeamsDataItems:
|
31293
|
-
description: Relates a team to this schedule, identified by `id` and `type`
|
31294
|
-
(must be `teams`).
|
31295
|
-
properties:
|
31296
|
-
id:
|
31297
|
-
description: The unique identifier of the team in this relationship.
|
31298
|
-
example: 00000000-da3a-0000-0000-000000000000
|
31299
|
-
type: string
|
31300
|
-
type:
|
31301
|
-
$ref: '#/components/schemas/ScheduleDataRelationshipsTeamsDataItemsType'
|
31302
|
-
required:
|
31303
|
-
- type
|
31304
|
-
- id
|
31305
|
-
type: object
|
31306
|
-
ScheduleDataRelationshipsTeamsDataItemsType:
|
31307
|
-
default: teams
|
31308
|
-
description: Teams resource type.
|
31309
|
-
enum:
|
31310
|
-
- teams
|
31311
|
-
example: teams
|
31312
|
-
type: string
|
31313
|
-
x-enum-varnames:
|
31314
|
-
- TEAMS
|
31315
31833
|
ScheduleDataType:
|
31316
31834
|
default: schedules
|
31317
31835
|
description: Schedules resource type.
|
@@ -31382,6 +31900,22 @@ components:
|
|
31382
31900
|
type: string
|
31383
31901
|
x-enum-varnames:
|
31384
31902
|
- MEMBERS
|
31903
|
+
ScheduleRequestDataAttributesLayersItemsMembersItems:
|
31904
|
+
description: Defines a single member within a schedule layer, including the
|
31905
|
+
reference to the underlying user.
|
31906
|
+
properties:
|
31907
|
+
user:
|
31908
|
+
$ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItemsUser'
|
31909
|
+
type: object
|
31910
|
+
ScheduleRequestDataAttributesLayersItemsMembersItemsUser:
|
31911
|
+
description: Identifies the user participating in this layer as a single object
|
31912
|
+
with an `id`.
|
31913
|
+
properties:
|
31914
|
+
id:
|
31915
|
+
description: The user's ID.
|
31916
|
+
example: 00000000-aba1-0000-0000-000000000000
|
31917
|
+
type: string
|
31918
|
+
type: object
|
31385
31919
|
ScheduleTarget:
|
31386
31920
|
description: Represents a schedule target for an escalation policy step, including
|
31387
31921
|
its ID and resource type.
|
@@ -31447,10 +31981,6 @@ components:
|
|
31447
31981
|
start_time: 09:00:00
|
31448
31982
|
rotation_start: '2025-02-01T00:00:00Z'
|
31449
31983
|
name: On-Call Schedule Updated
|
31450
|
-
tags:
|
31451
|
-
- tag1
|
31452
|
-
- tag2
|
31453
|
-
- tag3
|
31454
31984
|
time_zone: America/New_York
|
31455
31985
|
id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
|
31456
31986
|
relationships:
|
@@ -31467,7 +31997,7 @@ components:
|
|
31467
31997
|
type: object
|
31468
31998
|
ScheduleUpdateRequestData:
|
31469
31999
|
description: Contains all data needed to update an existing schedule, including
|
31470
|
-
its attributes (such as name
|
32000
|
+
its attributes (such as name and time zone) and any relationships to teams.
|
31471
32001
|
properties:
|
31472
32002
|
attributes:
|
31473
32003
|
$ref: '#/components/schemas/ScheduleUpdateRequestDataAttributes'
|
@@ -31486,7 +32016,7 @@ components:
|
|
31486
32016
|
type: object
|
31487
32017
|
ScheduleUpdateRequestDataAttributes:
|
31488
32018
|
description: Defines the updatable attributes for a schedule, such as name,
|
31489
|
-
time zone,
|
32019
|
+
time zone, and layers.
|
31490
32020
|
properties:
|
31491
32021
|
layers:
|
31492
32022
|
description: The updated list of layers (rotations) for this schedule.
|
@@ -31497,14 +32027,6 @@ components:
|
|
31497
32027
|
description: A short name for the schedule.
|
31498
32028
|
example: Primary On-Call
|
31499
32029
|
type: string
|
31500
|
-
tags:
|
31501
|
-
description: A list of tags that you can associate with this schedule.
|
31502
|
-
example:
|
31503
|
-
- front-end
|
31504
|
-
- team-a
|
31505
|
-
items:
|
31506
|
-
type: string
|
31507
|
-
type: array
|
31508
32030
|
time_zone:
|
31509
32031
|
description: The time zone used when interpreting rotation times.
|
31510
32032
|
example: America/New_York
|
@@ -31536,11 +32058,11 @@ components:
|
|
31536
32058
|
example: 00000000-0000-0000-0000-000000000001
|
31537
32059
|
type: string
|
31538
32060
|
interval:
|
31539
|
-
$ref: '#/components/schemas/
|
32061
|
+
$ref: '#/components/schemas/LayerAttributesInterval'
|
31540
32062
|
members:
|
31541
32063
|
description: The members assigned to this layer.
|
31542
32064
|
items:
|
31543
|
-
$ref: '#/components/schemas/
|
32065
|
+
$ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems'
|
31544
32066
|
type: array
|
31545
32067
|
name:
|
31546
32068
|
description: The name for this layer (for example, "Secondary Coverage").
|
@@ -31549,7 +32071,7 @@ components:
|
|
31549
32071
|
restrictions:
|
31550
32072
|
description: Any time restrictions that define when this layer is active.
|
31551
32073
|
items:
|
31552
|
-
$ref: '#/components/schemas/
|
32074
|
+
$ref: '#/components/schemas/TimeRestriction'
|
31553
32075
|
type: array
|
31554
32076
|
rotation_start:
|
31555
32077
|
description: The date/time at which the rotation begins (ISO 8601 format).
|
@@ -31563,138 +32085,13 @@ components:
|
|
31563
32085
|
- name
|
31564
32086
|
- rotation_start
|
31565
32087
|
type: object
|
31566
|
-
ScheduleUpdateRequestDataAttributesLayersItemsInterval:
|
31567
|
-
description: 'Specifies how the rotation repeats: number of days, plus optional
|
31568
|
-
seconds, up to the given maximums.'
|
31569
|
-
properties:
|
31570
|
-
days:
|
31571
|
-
description: How many days each rotation cycle should span.
|
31572
|
-
example: 1
|
31573
|
-
format: int32
|
31574
|
-
maximum: 400
|
31575
|
-
type: integer
|
31576
|
-
seconds:
|
31577
|
-
description: Additional seconds to add to the rotation cycle (for example,
|
31578
|
-
partial days).
|
31579
|
-
example: 300
|
31580
|
-
format: int64
|
31581
|
-
maximum: 2592000
|
31582
|
-
type: integer
|
31583
|
-
type: object
|
31584
|
-
ScheduleUpdateRequestDataAttributesLayersItemsMembersItems:
|
31585
|
-
description: 'Defines a single member within a layer during an update request,
|
31586
|
-
referring
|
31587
|
-
|
31588
|
-
to a specific user.'
|
31589
|
-
properties:
|
31590
|
-
user:
|
31591
|
-
$ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsMembersItemsUser'
|
31592
|
-
type: object
|
31593
|
-
ScheduleUpdateRequestDataAttributesLayersItemsMembersItemsUser:
|
31594
|
-
description: Identifies the user who is assigned to this member object. Only
|
31595
|
-
`id` is required.
|
31596
|
-
properties:
|
31597
|
-
id:
|
31598
|
-
description: The user's ID.
|
31599
|
-
example: 00000000-aba1-0000-0000-000000000000
|
31600
|
-
type: string
|
31601
|
-
type: object
|
31602
|
-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems:
|
31603
|
-
description: 'Defines a time restriction object for a layer within a schedule
|
31604
|
-
update, including
|
31605
|
-
|
31606
|
-
start and end days, as well as times.'
|
31607
|
-
properties:
|
31608
|
-
end_day:
|
31609
|
-
$ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay'
|
31610
|
-
end_time:
|
31611
|
-
description: The time at which this restriction ends (hh:mm:ss).
|
31612
|
-
example: '17:00:00'
|
31613
|
-
type: string
|
31614
|
-
start_day:
|
31615
|
-
$ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay'
|
31616
|
-
start_time:
|
31617
|
-
description: The time at which this restriction starts (hh:mm:ss).
|
31618
|
-
example: 09:00:00
|
31619
|
-
type: string
|
31620
|
-
type: object
|
31621
|
-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay:
|
31622
|
-
description: Defines the day of the week on which the time restriction ends.
|
31623
|
-
enum:
|
31624
|
-
- monday
|
31625
|
-
- tuesday
|
31626
|
-
- wednesday
|
31627
|
-
- thursday
|
31628
|
-
- friday
|
31629
|
-
- saturday
|
31630
|
-
- sunday
|
31631
|
-
type: string
|
31632
|
-
x-enum-varnames:
|
31633
|
-
- MONDAY
|
31634
|
-
- TUESDAY
|
31635
|
-
- WEDNESDAY
|
31636
|
-
- THURSDAY
|
31637
|
-
- FRIDAY
|
31638
|
-
- SATURDAY
|
31639
|
-
- SUNDAY
|
31640
|
-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay:
|
31641
|
-
description: Defines the day of the week on which the time restriction starts.
|
31642
|
-
enum:
|
31643
|
-
- monday
|
31644
|
-
- tuesday
|
31645
|
-
- wednesday
|
31646
|
-
- thursday
|
31647
|
-
- friday
|
31648
|
-
- saturday
|
31649
|
-
- sunday
|
31650
|
-
type: string
|
31651
|
-
x-enum-varnames:
|
31652
|
-
- MONDAY
|
31653
|
-
- TUESDAY
|
31654
|
-
- WEDNESDAY
|
31655
|
-
- THURSDAY
|
31656
|
-
- FRIDAY
|
31657
|
-
- SATURDAY
|
31658
|
-
- SUNDAY
|
31659
32088
|
ScheduleUpdateRequestDataRelationships:
|
31660
32089
|
description: Houses relationships for the schedule update, typically referencing
|
31661
32090
|
teams.
|
31662
32091
|
properties:
|
31663
32092
|
teams:
|
31664
|
-
$ref: '#/components/schemas/
|
31665
|
-
type: object
|
31666
|
-
ScheduleUpdateRequestDataRelationshipsTeams:
|
31667
|
-
description: Defines the teams that this schedule update is associated with.
|
31668
|
-
properties:
|
31669
|
-
data:
|
31670
|
-
description: An array of team references.
|
31671
|
-
items:
|
31672
|
-
$ref: '#/components/schemas/ScheduleUpdateRequestDataRelationshipsTeamsDataItems'
|
31673
|
-
type: array
|
31674
|
-
type: object
|
31675
|
-
ScheduleUpdateRequestDataRelationshipsTeamsDataItems:
|
31676
|
-
description: Links the schedule to a team within an update request, identified
|
31677
|
-
by `id` and `type`.
|
31678
|
-
properties:
|
31679
|
-
id:
|
31680
|
-
description: The unique team identifier.
|
31681
|
-
example: 00000000-aba1-0000-0000-000000000000
|
31682
|
-
type: string
|
31683
|
-
type:
|
31684
|
-
$ref: '#/components/schemas/ScheduleUpdateRequestDataRelationshipsTeamsDataItemsType'
|
31685
|
-
required:
|
31686
|
-
- type
|
31687
|
-
- id
|
32093
|
+
$ref: '#/components/schemas/DataRelationshipsTeams'
|
31688
32094
|
type: object
|
31689
|
-
ScheduleUpdateRequestDataRelationshipsTeamsDataItemsType:
|
31690
|
-
default: teams
|
31691
|
-
description: Teams resource type.
|
31692
|
-
enum:
|
31693
|
-
- teams
|
31694
|
-
example: teams
|
31695
|
-
type: string
|
31696
|
-
x-enum-varnames:
|
31697
|
-
- TEAMS
|
31698
32095
|
ScheduleUpdateRequestDataType:
|
31699
32096
|
default: schedules
|
31700
32097
|
description: Schedules resource type.
|
@@ -31730,6 +32127,8 @@ components:
|
|
31730
32127
|
description: The user's name.
|
31731
32128
|
example: Jane Doe
|
31732
32129
|
type: string
|
32130
|
+
status:
|
32131
|
+
$ref: '#/components/schemas/UserAttributesStatus'
|
31733
32132
|
type: object
|
31734
32133
|
ScheduleUserType:
|
31735
32134
|
default: users
|
@@ -32217,9 +32616,11 @@ components:
|
|
32217
32616
|
example: true
|
32218
32617
|
type: boolean
|
32219
32618
|
SecurityMonitoringRuleKeepAlive:
|
32220
|
-
description:
|
32221
|
-
|
32222
|
-
|
32619
|
+
description: 'Once a signal is generated, the signal will remain "open" if a
|
32620
|
+
case is matched at least once within
|
32621
|
+
|
32622
|
+
this keep alive window. For third party detection method, this field is not
|
32623
|
+
used.'
|
32223
32624
|
enum:
|
32224
32625
|
- 0
|
32225
32626
|
- 60
|
@@ -32249,9 +32650,10 @@ components:
|
|
32249
32650
|
- TWELVE_HOURS
|
32250
32651
|
- ONE_DAY
|
32251
32652
|
SecurityMonitoringRuleMaxSignalDuration:
|
32252
|
-
description:
|
32253
|
-
|
32254
|
-
|
32653
|
+
description: 'A signal will "close" regardless of the query being matched once
|
32654
|
+
the time exceeds the maximum duration.
|
32655
|
+
|
32656
|
+
This time is calculated from the first seen timestamp.'
|
32255
32657
|
enum:
|
32256
32658
|
- 0
|
32257
32659
|
- 60
|
@@ -33267,7 +33669,7 @@ components:
|
|
33267
33669
|
- TIMESTAMP_DESCENDING
|
33268
33670
|
SecurityMonitoringStandardDataSource:
|
33269
33671
|
default: logs
|
33270
|
-
description: Source of events, either logs or
|
33672
|
+
description: Source of events, either logs, audit trail, or Datadog events.
|
33271
33673
|
enum:
|
33272
33674
|
- logs
|
33273
33675
|
- audit
|
@@ -33275,6 +33677,7 @@ components:
|
|
33275
33677
|
- spans
|
33276
33678
|
- security_runtime
|
33277
33679
|
- network
|
33680
|
+
- events
|
33278
33681
|
example: logs
|
33279
33682
|
type: string
|
33280
33683
|
x-enum-varnames:
|
@@ -33284,6 +33687,7 @@ components:
|
|
33284
33687
|
- SPANS
|
33285
33688
|
- SECURITY_RUNTIME
|
33286
33689
|
- NETWORK
|
33690
|
+
- EVENTS
|
33287
33691
|
SecurityMonitoringStandardRuleCreatePayload:
|
33288
33692
|
description: Create a new rule.
|
33289
33693
|
properties:
|
@@ -34085,6 +34489,65 @@ components:
|
|
34085
34489
|
required:
|
34086
34490
|
- selfServiceTrigger
|
34087
34491
|
type: object
|
34492
|
+
SendSlackMessageAction:
|
34493
|
+
description: Sends a message to a Slack channel.
|
34494
|
+
properties:
|
34495
|
+
channel:
|
34496
|
+
description: The channel ID.
|
34497
|
+
example: CHANNEL
|
34498
|
+
type: string
|
34499
|
+
type:
|
34500
|
+
$ref: '#/components/schemas/SendSlackMessageActionType'
|
34501
|
+
workspace:
|
34502
|
+
description: The workspace ID.
|
34503
|
+
example: WORKSPACE
|
34504
|
+
type: string
|
34505
|
+
required:
|
34506
|
+
- type
|
34507
|
+
- channel
|
34508
|
+
- workspace
|
34509
|
+
type: object
|
34510
|
+
SendSlackMessageActionType:
|
34511
|
+
default: send_slack_message
|
34512
|
+
description: Indicates that the action is a send Slack message action.
|
34513
|
+
enum:
|
34514
|
+
- send_slack_message
|
34515
|
+
example: send_slack_message
|
34516
|
+
type: string
|
34517
|
+
x-enum-varnames:
|
34518
|
+
- SEND_SLACK_MESSAGE
|
34519
|
+
SendTeamsMessageAction:
|
34520
|
+
description: Sends a message to a Microsoft Teams channel.
|
34521
|
+
properties:
|
34522
|
+
channel:
|
34523
|
+
description: The channel ID.
|
34524
|
+
example: CHANNEL
|
34525
|
+
type: string
|
34526
|
+
team:
|
34527
|
+
description: The team ID.
|
34528
|
+
example: TEAM
|
34529
|
+
type: string
|
34530
|
+
tenant:
|
34531
|
+
description: The tenant ID.
|
34532
|
+
example: TENANT
|
34533
|
+
type: string
|
34534
|
+
type:
|
34535
|
+
$ref: '#/components/schemas/SendTeamsMessageActionType'
|
34536
|
+
required:
|
34537
|
+
- type
|
34538
|
+
- channel
|
34539
|
+
- tenant
|
34540
|
+
- team
|
34541
|
+
type: object
|
34542
|
+
SendTeamsMessageActionType:
|
34543
|
+
default: send_teams_message
|
34544
|
+
description: Indicates that the action is a send Microsoft Teams message action.
|
34545
|
+
enum:
|
34546
|
+
- send_teams_message
|
34547
|
+
example: send_teams_message
|
34548
|
+
type: string
|
34549
|
+
x-enum-varnames:
|
34550
|
+
- SEND_TEAMS_MESSAGE
|
34088
34551
|
SensitiveDataScannerConfigRequest:
|
34089
34552
|
description: Group reorder request.
|
34090
34553
|
properties:
|
@@ -35765,6 +36228,115 @@ components:
|
|
35765
36228
|
description: Link to the Incident created on ServiceNow
|
35766
36229
|
type: string
|
35767
36230
|
type: object
|
36231
|
+
Shift:
|
36232
|
+
description: The definition of `Shift` object.
|
36233
|
+
example:
|
36234
|
+
data:
|
36235
|
+
attributes:
|
36236
|
+
end: '2025-05-07T03:53:01.206662873Z'
|
36237
|
+
start: '2025-05-07T02:53:01.206662814Z'
|
36238
|
+
id: 00000000-0000-0000-0000-000000000000
|
36239
|
+
relationships:
|
36240
|
+
user:
|
36241
|
+
data:
|
36242
|
+
id: 00000000-aba1-0000-0000-000000000000
|
36243
|
+
type: users
|
36244
|
+
type: shifts
|
36245
|
+
included:
|
36246
|
+
- attributes:
|
36247
|
+
email: foo@bar.com
|
36248
|
+
name: User 1
|
36249
|
+
status: ''
|
36250
|
+
id: 00000000-aba1-0000-0000-000000000000
|
36251
|
+
type: users
|
36252
|
+
properties:
|
36253
|
+
data:
|
36254
|
+
$ref: '#/components/schemas/ShiftData'
|
36255
|
+
nullable: true
|
36256
|
+
included:
|
36257
|
+
description: The `Shift` `included`.
|
36258
|
+
items:
|
36259
|
+
$ref: '#/components/schemas/ShiftIncluded'
|
36260
|
+
type: array
|
36261
|
+
type: object
|
36262
|
+
ShiftData:
|
36263
|
+
description: The definition of `ShiftData` object.
|
36264
|
+
properties:
|
36265
|
+
attributes:
|
36266
|
+
$ref: '#/components/schemas/ShiftDataAttributes'
|
36267
|
+
id:
|
36268
|
+
description: The `ShiftData` `id`.
|
36269
|
+
type: string
|
36270
|
+
relationships:
|
36271
|
+
$ref: '#/components/schemas/ShiftDataRelationships'
|
36272
|
+
type:
|
36273
|
+
$ref: '#/components/schemas/ShiftDataType'
|
36274
|
+
required:
|
36275
|
+
- type
|
36276
|
+
type: object
|
36277
|
+
ShiftDataAttributes:
|
36278
|
+
description: The definition of `ShiftDataAttributes` object.
|
36279
|
+
properties:
|
36280
|
+
end:
|
36281
|
+
description: The end time of the shift.
|
36282
|
+
format: date-time
|
36283
|
+
type: string
|
36284
|
+
start:
|
36285
|
+
description: The start time of the shift.
|
36286
|
+
format: date-time
|
36287
|
+
type: string
|
36288
|
+
type: object
|
36289
|
+
ShiftDataRelationships:
|
36290
|
+
description: The definition of `ShiftDataRelationships` object.
|
36291
|
+
properties:
|
36292
|
+
user:
|
36293
|
+
$ref: '#/components/schemas/ShiftDataRelationshipsUser'
|
36294
|
+
type: object
|
36295
|
+
ShiftDataRelationshipsUser:
|
36296
|
+
description: Defines the relationship between a shift and the user who is working
|
36297
|
+
that shift.
|
36298
|
+
properties:
|
36299
|
+
data:
|
36300
|
+
$ref: '#/components/schemas/ShiftDataRelationshipsUserData'
|
36301
|
+
required:
|
36302
|
+
- data
|
36303
|
+
type: object
|
36304
|
+
ShiftDataRelationshipsUserData:
|
36305
|
+
description: Represents a reference to the user assigned to this shift, containing
|
36306
|
+
the user's ID and resource type.
|
36307
|
+
properties:
|
36308
|
+
id:
|
36309
|
+
description: Specifies the unique identifier of the user.
|
36310
|
+
example: 00000000-0000-0000-0000-000000000000
|
36311
|
+
type: string
|
36312
|
+
type:
|
36313
|
+
$ref: '#/components/schemas/ShiftDataRelationshipsUserDataType'
|
36314
|
+
required:
|
36315
|
+
- type
|
36316
|
+
- id
|
36317
|
+
type: object
|
36318
|
+
ShiftDataRelationshipsUserDataType:
|
36319
|
+
default: users
|
36320
|
+
description: Indicates that the related resource is of type 'users'.
|
36321
|
+
enum:
|
36322
|
+
- users
|
36323
|
+
example: users
|
36324
|
+
type: string
|
36325
|
+
x-enum-varnames:
|
36326
|
+
- USERS
|
36327
|
+
ShiftDataType:
|
36328
|
+
default: shifts
|
36329
|
+
description: Indicates that the resource is of type 'shifts'.
|
36330
|
+
enum:
|
36331
|
+
- shifts
|
36332
|
+
example: shifts
|
36333
|
+
type: string
|
36334
|
+
x-enum-varnames:
|
36335
|
+
- SHIFTS
|
36336
|
+
ShiftIncluded:
|
36337
|
+
description: The definition of `ShiftIncluded` object.
|
36338
|
+
oneOf:
|
36339
|
+
- $ref: '#/components/schemas/ScheduleUser'
|
35768
36340
|
SingleAggregatedConnectionResponseArray:
|
35769
36341
|
description: List of aggregated connections.
|
35770
36342
|
example:
|
@@ -37436,8 +38008,6 @@ components:
|
|
37436
38008
|
id:
|
37437
38009
|
description: The team's unique identifier.
|
37438
38010
|
type: string
|
37439
|
-
relationships:
|
37440
|
-
$ref: '#/components/schemas/TeamReferenceRelationships'
|
37441
38011
|
type:
|
37442
38012
|
$ref: '#/components/schemas/TeamReferenceType'
|
37443
38013
|
required:
|
@@ -37460,46 +38030,6 @@ components:
|
|
37460
38030
|
description: The full, human-readable name of the team.
|
37461
38031
|
type: string
|
37462
38032
|
type: object
|
37463
|
-
TeamReferenceRelationships:
|
37464
|
-
description: Collects the key relationship fields for a team reference, specifically
|
37465
|
-
on-call users.
|
37466
|
-
properties:
|
37467
|
-
oncall_users:
|
37468
|
-
$ref: '#/components/schemas/TeamReferenceRelationshipsOncallUsers'
|
37469
|
-
type: object
|
37470
|
-
TeamReferenceRelationshipsOncallUsers:
|
37471
|
-
description: Defines which users are on-call within a team, stored as an array
|
37472
|
-
of references.
|
37473
|
-
properties:
|
37474
|
-
data:
|
37475
|
-
description: The list of user references who are on-call for this team.
|
37476
|
-
items:
|
37477
|
-
$ref: '#/components/schemas/TeamReferenceRelationshipsOncallUsersDataItems'
|
37478
|
-
type: array
|
37479
|
-
type: object
|
37480
|
-
TeamReferenceRelationshipsOncallUsersDataItems:
|
37481
|
-
description: References a user who is on-call within this team, identified by
|
37482
|
-
`id` and `type`.
|
37483
|
-
properties:
|
37484
|
-
id:
|
37485
|
-
description: The unique identifier of the user.
|
37486
|
-
example: 00000000-aba1-0000-0000-000000000000
|
37487
|
-
type: string
|
37488
|
-
type:
|
37489
|
-
$ref: '#/components/schemas/TeamReferenceRelationshipsOncallUsersDataItemsType'
|
37490
|
-
required:
|
37491
|
-
- type
|
37492
|
-
- id
|
37493
|
-
type: object
|
37494
|
-
TeamReferenceRelationshipsOncallUsersDataItemsType:
|
37495
|
-
default: users
|
37496
|
-
description: Users resource type.
|
37497
|
-
enum:
|
37498
|
-
- users
|
37499
|
-
example: users
|
37500
|
-
type: string
|
37501
|
-
x-enum-varnames:
|
37502
|
-
- USERS
|
37503
38033
|
TeamReferenceType:
|
37504
38034
|
default: teams
|
37505
38035
|
description: Teams resource type.
|
@@ -37531,6 +38061,212 @@ components:
|
|
37531
38061
|
data:
|
37532
38062
|
$ref: '#/components/schemas/Team'
|
37533
38063
|
type: object
|
38064
|
+
TeamRoutingRules:
|
38065
|
+
description: Represents a complete set of team routing rules, including data
|
38066
|
+
and optionally included related resources.
|
38067
|
+
example:
|
38068
|
+
data:
|
38069
|
+
id: 27590dae-47be-4a7d-9abf-8f4e45124020
|
38070
|
+
relationships:
|
38071
|
+
rules:
|
38072
|
+
data:
|
38073
|
+
- id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a
|
38074
|
+
type: team_routing_rules
|
38075
|
+
- id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a
|
38076
|
+
type: team_routing_rules
|
38077
|
+
type: team_routing_rules
|
38078
|
+
included:
|
38079
|
+
- attributes:
|
38080
|
+
actions: null
|
38081
|
+
query: tags.service:test
|
38082
|
+
time_restriction:
|
38083
|
+
restrictions:
|
38084
|
+
- end_day: monday
|
38085
|
+
end_time: '17:00:00'
|
38086
|
+
start_day: monday
|
38087
|
+
start_time: 09:00:00
|
38088
|
+
- end_day: tuesday
|
38089
|
+
end_time: '17:00:00'
|
38090
|
+
start_day: tuesday
|
38091
|
+
start_time: 09:00:00
|
38092
|
+
time_zone: ''
|
38093
|
+
urgency: high
|
38094
|
+
id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a
|
38095
|
+
relationships:
|
38096
|
+
policy:
|
38097
|
+
data: null
|
38098
|
+
type: team_routing_rules
|
38099
|
+
properties:
|
38100
|
+
data:
|
38101
|
+
$ref: '#/components/schemas/TeamRoutingRulesData'
|
38102
|
+
included:
|
38103
|
+
description: Provides related routing rules or other included resources.
|
38104
|
+
items:
|
38105
|
+
$ref: '#/components/schemas/TeamRoutingRulesIncluded'
|
38106
|
+
type: array
|
38107
|
+
type: object
|
38108
|
+
TeamRoutingRulesData:
|
38109
|
+
description: Represents the top-level data object for team routing rules, containing
|
38110
|
+
the ID, relationships, and resource type.
|
38111
|
+
properties:
|
38112
|
+
id:
|
38113
|
+
description: Specifies the unique identifier of this team routing rules
|
38114
|
+
record.
|
38115
|
+
type: string
|
38116
|
+
relationships:
|
38117
|
+
$ref: '#/components/schemas/TeamRoutingRulesDataRelationships'
|
38118
|
+
type:
|
38119
|
+
$ref: '#/components/schemas/TeamRoutingRulesDataType'
|
38120
|
+
required:
|
38121
|
+
- type
|
38122
|
+
type: object
|
38123
|
+
TeamRoutingRulesDataRelationships:
|
38124
|
+
description: Specifies relationships for team routing rules, including rule
|
38125
|
+
references.
|
38126
|
+
properties:
|
38127
|
+
rules:
|
38128
|
+
$ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRules'
|
38129
|
+
type: object
|
38130
|
+
TeamRoutingRulesDataRelationshipsRules:
|
38131
|
+
description: Holds references to a set of routing rules in a relationship.
|
38132
|
+
properties:
|
38133
|
+
data:
|
38134
|
+
description: An array of references to the routing rules associated with
|
38135
|
+
this team.
|
38136
|
+
items:
|
38137
|
+
$ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItems'
|
38138
|
+
type: array
|
38139
|
+
type: object
|
38140
|
+
TeamRoutingRulesDataRelationshipsRulesDataItems:
|
38141
|
+
description: Defines a relationship item to link a routing rule by its ID and
|
38142
|
+
type.
|
38143
|
+
properties:
|
38144
|
+
id:
|
38145
|
+
description: Specifies the unique identifier for the related routing rule.
|
38146
|
+
example: ''
|
38147
|
+
type: string
|
38148
|
+
type:
|
38149
|
+
$ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItemsType'
|
38150
|
+
required:
|
38151
|
+
- type
|
38152
|
+
- id
|
38153
|
+
type: object
|
38154
|
+
TeamRoutingRulesDataRelationshipsRulesDataItemsType:
|
38155
|
+
default: team_routing_rules
|
38156
|
+
description: Indicates that the resource is of type 'team_routing_rules'.
|
38157
|
+
enum:
|
38158
|
+
- team_routing_rules
|
38159
|
+
example: team_routing_rules
|
38160
|
+
type: string
|
38161
|
+
x-enum-varnames:
|
38162
|
+
- TEAM_ROUTING_RULES
|
38163
|
+
TeamRoutingRulesDataType:
|
38164
|
+
default: team_routing_rules
|
38165
|
+
description: Team routing rules resource type.
|
38166
|
+
enum:
|
38167
|
+
- team_routing_rules
|
38168
|
+
example: team_routing_rules
|
38169
|
+
type: string
|
38170
|
+
x-enum-varnames:
|
38171
|
+
- TEAM_ROUTING_RULES
|
38172
|
+
TeamRoutingRulesIncluded:
|
38173
|
+
description: Represents additional included resources for team routing rules,
|
38174
|
+
such as associated routing rules.
|
38175
|
+
oneOf:
|
38176
|
+
- $ref: '#/components/schemas/RoutingRule'
|
38177
|
+
TeamRoutingRulesRequest:
|
38178
|
+
description: Represents a request to create or update team routing rules, including
|
38179
|
+
the data payload.
|
38180
|
+
example:
|
38181
|
+
data:
|
38182
|
+
attributes:
|
38183
|
+
rules:
|
38184
|
+
- actions: null
|
38185
|
+
policy_id: ''
|
38186
|
+
query: tags.service:test
|
38187
|
+
time_restriction:
|
38188
|
+
restrictions:
|
38189
|
+
- end_day: monday
|
38190
|
+
end_time: '17:00:00'
|
38191
|
+
start_day: monday
|
38192
|
+
start_time: 09:00:00
|
38193
|
+
- end_day: tuesday
|
38194
|
+
end_time: '17:00:00'
|
38195
|
+
start_day: tuesday
|
38196
|
+
start_time: 09:00:00
|
38197
|
+
time_zone: ''
|
38198
|
+
urgency: high
|
38199
|
+
- actions:
|
38200
|
+
- channel: channel
|
38201
|
+
type: send_slack_message
|
38202
|
+
workspace: workspace
|
38203
|
+
policy_id: fad4eee1-13f5-40d8-886b-4e56d8d5d1c6
|
38204
|
+
query: ''
|
38205
|
+
time_restriction: null
|
38206
|
+
urgency: low
|
38207
|
+
id: 27590dae-47be-4a7d-9abf-8f4e45124020
|
38208
|
+
type: team_routing_rules
|
38209
|
+
properties:
|
38210
|
+
data:
|
38211
|
+
$ref: '#/components/schemas/TeamRoutingRulesRequestData'
|
38212
|
+
type: object
|
38213
|
+
TeamRoutingRulesRequestData:
|
38214
|
+
description: Holds the data necessary to create or update team routing rules,
|
38215
|
+
including attributes, ID, and resource type.
|
38216
|
+
properties:
|
38217
|
+
attributes:
|
38218
|
+
$ref: '#/components/schemas/TeamRoutingRulesRequestDataAttributes'
|
38219
|
+
id:
|
38220
|
+
description: Specifies the unique identifier for this set of team routing
|
38221
|
+
rules.
|
38222
|
+
type: string
|
38223
|
+
type:
|
38224
|
+
$ref: '#/components/schemas/TeamRoutingRulesRequestDataType'
|
38225
|
+
required:
|
38226
|
+
- type
|
38227
|
+
type: object
|
38228
|
+
TeamRoutingRulesRequestDataAttributes:
|
38229
|
+
description: Represents the attributes of a request to update or create team
|
38230
|
+
routing rules.
|
38231
|
+
properties:
|
38232
|
+
rules:
|
38233
|
+
description: A list of routing rule items that define how incoming pages
|
38234
|
+
should be handled.
|
38235
|
+
items:
|
38236
|
+
$ref: '#/components/schemas/TeamRoutingRulesRequestRule'
|
38237
|
+
type: array
|
38238
|
+
type: object
|
38239
|
+
TeamRoutingRulesRequestDataType:
|
38240
|
+
default: team_routing_rules
|
38241
|
+
description: Team routing rules resource type.
|
38242
|
+
enum:
|
38243
|
+
- team_routing_rules
|
38244
|
+
example: team_routing_rules
|
38245
|
+
type: string
|
38246
|
+
x-enum-varnames:
|
38247
|
+
- TEAM_ROUTING_RULES
|
38248
|
+
TeamRoutingRulesRequestRule:
|
38249
|
+
description: Defines an individual routing rule item that contains the rule
|
38250
|
+
data for the request.
|
38251
|
+
properties:
|
38252
|
+
actions:
|
38253
|
+
description: Specifies the list of actions to perform when the routing rule
|
38254
|
+
is matched.
|
38255
|
+
items:
|
38256
|
+
$ref: '#/components/schemas/RoutingRuleAction'
|
38257
|
+
type: array
|
38258
|
+
policy_id:
|
38259
|
+
description: Identifies the policy to be applied when this routing rule
|
38260
|
+
matches.
|
38261
|
+
type: string
|
38262
|
+
query:
|
38263
|
+
description: Defines the query or condition that triggers this routing rule.
|
38264
|
+
type: string
|
38265
|
+
time_restriction:
|
38266
|
+
$ref: '#/components/schemas/TimeRestrictions'
|
38267
|
+
urgency:
|
38268
|
+
$ref: '#/components/schemas/Urgency'
|
38269
|
+
type: object
|
37534
38270
|
TeamTarget:
|
37535
38271
|
description: Represents a team target for an escalation policy step, including
|
37536
38272
|
the team's ID and resource type.
|
@@ -37764,6 +38500,38 @@ components:
|
|
37764
38500
|
example: 86400
|
37765
38501
|
format: int64
|
37766
38502
|
type: integer
|
38503
|
+
TimeRestriction:
|
38504
|
+
description: Defines a single time restriction rule with start and end times
|
38505
|
+
and the applicable weekdays.
|
38506
|
+
properties:
|
38507
|
+
end_day:
|
38508
|
+
$ref: '#/components/schemas/Weekday'
|
38509
|
+
end_time:
|
38510
|
+
description: Specifies the ending time for this restriction.
|
38511
|
+
type: string
|
38512
|
+
start_day:
|
38513
|
+
$ref: '#/components/schemas/Weekday'
|
38514
|
+
start_time:
|
38515
|
+
description: Specifies the starting time for this restriction.
|
38516
|
+
type: string
|
38517
|
+
type: object
|
38518
|
+
TimeRestrictions:
|
38519
|
+
description: Holds time zone information and a list of time restrictions for
|
38520
|
+
a routing rule.
|
38521
|
+
properties:
|
38522
|
+
restrictions:
|
38523
|
+
description: Defines the list of time-based restrictions.
|
38524
|
+
items:
|
38525
|
+
$ref: '#/components/schemas/TimeRestriction'
|
38526
|
+
type: array
|
38527
|
+
time_zone:
|
38528
|
+
description: Specifies the time zone applicable to the restrictions.
|
38529
|
+
example: ''
|
38530
|
+
type: string
|
38531
|
+
required:
|
38532
|
+
- time_zone
|
38533
|
+
- restrictions
|
38534
|
+
type: object
|
37767
38535
|
TimeseriesFormulaQueryRequest:
|
37768
38536
|
description: A request wrapper around a single timeseries query to be executed.
|
37769
38537
|
properties:
|
@@ -38260,6 +39028,52 @@ components:
|
|
38260
39028
|
id:
|
38261
39029
|
$ref: '#/components/schemas/ApiID'
|
38262
39030
|
type: object
|
39031
|
+
UpdateResourceEvaluationFiltersRequest:
|
39032
|
+
description: Request object to update a resource filter.
|
39033
|
+
properties:
|
39034
|
+
data:
|
39035
|
+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequestData'
|
39036
|
+
required:
|
39037
|
+
- data
|
39038
|
+
type: object
|
39039
|
+
UpdateResourceEvaluationFiltersRequestData:
|
39040
|
+
description: The definition of `UpdateResourceFilterRequestData` object.
|
39041
|
+
properties:
|
39042
|
+
attributes:
|
39043
|
+
$ref: '#/components/schemas/ResourceFilterAttributes'
|
39044
|
+
id:
|
39045
|
+
description: The `UpdateResourceEvaluationFiltersRequestData` `id`.
|
39046
|
+
example: csm_resource_filter
|
39047
|
+
type: string
|
39048
|
+
type:
|
39049
|
+
$ref: '#/components/schemas/ResourceFilterRequestType'
|
39050
|
+
required:
|
39051
|
+
- attributes
|
39052
|
+
- type
|
39053
|
+
type: object
|
39054
|
+
UpdateResourceEvaluationFiltersResponse:
|
39055
|
+
description: The definition of `UpdateResourceEvaluationFiltersResponse` object.
|
39056
|
+
properties:
|
39057
|
+
data:
|
39058
|
+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponseData'
|
39059
|
+
required:
|
39060
|
+
- data
|
39061
|
+
type: object
|
39062
|
+
UpdateResourceEvaluationFiltersResponseData:
|
39063
|
+
description: The definition of `UpdateResourceFilterResponseData` object.
|
39064
|
+
properties:
|
39065
|
+
attributes:
|
39066
|
+
$ref: '#/components/schemas/ResourceFilterAttributes'
|
39067
|
+
id:
|
39068
|
+
description: The `data` `id`.
|
39069
|
+
example: csm_resource_filter
|
39070
|
+
type: string
|
39071
|
+
type:
|
39072
|
+
$ref: '#/components/schemas/ResourceFilterRequestType'
|
39073
|
+
required:
|
39074
|
+
- attributes
|
39075
|
+
- type
|
39076
|
+
type: object
|
38263
39077
|
UpdateRuleRequest:
|
38264
39078
|
description: Request to update a scorecard rule.
|
38265
39079
|
properties:
|
@@ -38391,6 +39205,19 @@ components:
|
|
38391
39205
|
description: Upsert entity response included item.
|
38392
39206
|
oneOf:
|
38393
39207
|
- $ref: '#/components/schemas/EntityResponseIncludedSchema'
|
39208
|
+
Urgency:
|
39209
|
+
description: Specifies the level of urgency for a routing rule (low, high, or
|
39210
|
+
dynamic).
|
39211
|
+
enum:
|
39212
|
+
- low
|
39213
|
+
- high
|
39214
|
+
- dynamic
|
39215
|
+
example: low
|
39216
|
+
type: string
|
39217
|
+
x-enum-varnames:
|
39218
|
+
- LOW
|
39219
|
+
- HIGH
|
39220
|
+
- DYNAMIC
|
38394
39221
|
UrlParam:
|
38395
39222
|
description: The definition of `UrlParam` object.
|
38396
39223
|
properties:
|
@@ -38564,6 +39391,17 @@ components:
|
|
38564
39391
|
description: Whether the user is verified.
|
38565
39392
|
type: boolean
|
38566
39393
|
type: object
|
39394
|
+
UserAttributesStatus:
|
39395
|
+
description: The user's status.
|
39396
|
+
enum:
|
39397
|
+
- active
|
39398
|
+
- deactivated
|
39399
|
+
- pending
|
39400
|
+
type: string
|
39401
|
+
x-enum-varnames:
|
39402
|
+
- ACTIVE
|
39403
|
+
- DEACTIVATED
|
39404
|
+
- PENDING
|
38567
39405
|
UserCreateAttributes:
|
38568
39406
|
description: Attributes of the created user.
|
38569
39407
|
properties:
|
@@ -39454,6 +40292,25 @@ components:
|
|
39454
40292
|
- X_CONTENT_TYPE_HEADER_MISSING
|
39455
40293
|
- X_PATH_INJECTION
|
39456
40294
|
- XSS
|
40295
|
+
Weekday:
|
40296
|
+
description: A day of the week.
|
40297
|
+
enum:
|
40298
|
+
- monday
|
40299
|
+
- tuesday
|
40300
|
+
- wednesday
|
40301
|
+
- thursday
|
40302
|
+
- friday
|
40303
|
+
- saturday
|
40304
|
+
- sunday
|
40305
|
+
type: string
|
40306
|
+
x-enum-varnames:
|
40307
|
+
- MONDAY
|
40308
|
+
- TUESDAY
|
40309
|
+
- WEDNESDAY
|
40310
|
+
- THURSDAY
|
40311
|
+
- FRIDAY
|
40312
|
+
- SATURDAY
|
40313
|
+
- SUNDAY
|
39457
40314
|
WidgetLiveSpan:
|
39458
40315
|
description: The available timeframes depend on the widget you are using.
|
39459
40316
|
enum:
|
@@ -39809,10 +40666,11 @@ components:
|
|
39809
40666
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
39810
40667
|
the API.
|
39811
40668
|
ci_visibility_read: View CI Visibility.
|
39812
|
-
cloud_cost_management_read: View Cloud Cost pages
|
39813
|
-
|
40669
|
+
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data
|
40670
|
+
source in dashboards and notebooks. For more details, see the Cloud
|
40671
|
+
Cost Management docs.
|
39814
40672
|
cloud_cost_management_write: Configure cloud cost accounts and global
|
39815
|
-
customizations.
|
40673
|
+
customizations. For more details, see the Cloud Cost Management docs.
|
39816
40674
|
code_analysis_read: View Code Analysis.
|
39817
40675
|
continuous_profiler_pgo_read: Read and query Continuous Profiler data
|
39818
40676
|
for Profile-Guided Optimization (PGO).
|
@@ -42584,6 +43442,48 @@ paths:
|
|
42584
43442
|
summary: Delete a single entity
|
42585
43443
|
tags:
|
42586
43444
|
- Software Catalog
|
43445
|
+
/api/v2/catalog/relation:
|
43446
|
+
get:
|
43447
|
+
description: Get a list of entity relations from Software Catalog.
|
43448
|
+
operationId: ListCatalogRelation
|
43449
|
+
parameters:
|
43450
|
+
- $ref: '#/components/parameters/PageOffset'
|
43451
|
+
- description: Maximum number of relations in the response.
|
43452
|
+
example: 100
|
43453
|
+
in: query
|
43454
|
+
name: page[limit]
|
43455
|
+
required: false
|
43456
|
+
schema:
|
43457
|
+
default: 100
|
43458
|
+
format: int64
|
43459
|
+
type: integer
|
43460
|
+
- $ref: '#/components/parameters/FilterRelationByType'
|
43461
|
+
- $ref: '#/components/parameters/FilterRelationByFromRef'
|
43462
|
+
- $ref: '#/components/parameters/FilterRelationByToRef'
|
43463
|
+
- $ref: '#/components/parameters/RelationInclude'
|
43464
|
+
responses:
|
43465
|
+
'200':
|
43466
|
+
content:
|
43467
|
+
application/json:
|
43468
|
+
schema:
|
43469
|
+
$ref: '#/components/schemas/ListRelationCatalogResponse'
|
43470
|
+
description: OK
|
43471
|
+
'403':
|
43472
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
43473
|
+
'429':
|
43474
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
43475
|
+
security:
|
43476
|
+
- apiKeyAuth: []
|
43477
|
+
appKeyAuth: []
|
43478
|
+
- AuthZ:
|
43479
|
+
- apm_service_catalog_read
|
43480
|
+
summary: Get a list of entity relations
|
43481
|
+
tags:
|
43482
|
+
- Software Catalog
|
43483
|
+
x-pagination:
|
43484
|
+
limitParam: page[limit]
|
43485
|
+
pageOffsetParam: page[offset]
|
43486
|
+
resultsPath: data
|
42587
43487
|
/api/v2/ci/pipeline:
|
42588
43488
|
post:
|
42589
43489
|
description: 'Send your pipeline event to your Datadog platform over HTTP. For
|
@@ -43152,107 +44052,175 @@ paths:
|
|
43152
44052
|
permissions:
|
43153
44053
|
- security_monitoring_rules_read
|
43154
44054
|
- security_monitoring_rules_write
|
43155
|
-
/api/v2/
|
44055
|
+
/api/v2/cloud_security_management/resource_filters:
|
43156
44056
|
get:
|
43157
|
-
description:
|
43158
|
-
operationId:
|
44057
|
+
description: List resource filters.
|
44058
|
+
operationId: GetResourceEvaluationFilters
|
43159
44059
|
parameters:
|
43160
|
-
-
|
43161
|
-
|
43162
|
-
|
43163
|
-
name: filter[tags]
|
43164
|
-
required: false
|
43165
|
-
schema:
|
43166
|
-
type: string
|
43167
|
-
- description: Comma-separated list of tags to group Container Images by.
|
43168
|
-
example: registry,image_tags
|
43169
|
-
in: query
|
43170
|
-
name: group_by
|
43171
|
-
required: false
|
43172
|
-
schema:
|
43173
|
-
type: string
|
43174
|
-
- description: Attribute to sort Container Images by.
|
43175
|
-
example: container_count
|
43176
|
-
in: query
|
43177
|
-
name: sort
|
43178
|
-
required: false
|
43179
|
-
schema:
|
43180
|
-
type: string
|
43181
|
-
- description: Maximum number of results returned.
|
43182
|
-
in: query
|
43183
|
-
name: page[size]
|
43184
|
-
required: false
|
43185
|
-
schema:
|
43186
|
-
default: 1000
|
43187
|
-
format: int32
|
43188
|
-
maximum: 10000
|
43189
|
-
minimum: 1
|
43190
|
-
type: integer
|
43191
|
-
- description: 'String to query the next page of results.
|
43192
|
-
|
43193
|
-
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
43194
|
-
in: query
|
43195
|
-
name: page[cursor]
|
43196
|
-
required: false
|
43197
|
-
schema:
|
43198
|
-
type: string
|
44060
|
+
- $ref: '#/components/parameters/ResourceFilterProvider'
|
44061
|
+
- $ref: '#/components/parameters/ResourceFilterAccountID'
|
44062
|
+
- $ref: '#/components/parameters/SkipCache'
|
43199
44063
|
responses:
|
43200
44064
|
'200':
|
43201
44065
|
content:
|
43202
44066
|
application/json:
|
43203
44067
|
schema:
|
43204
|
-
$ref: '#/components/schemas/
|
44068
|
+
$ref: '#/components/schemas/GetResourceEvaluationFiltersResponse'
|
43205
44069
|
description: OK
|
43206
44070
|
'400':
|
43207
|
-
|
43208
|
-
application/json:
|
43209
|
-
schema:
|
43210
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
43211
|
-
description: Bad Request
|
44071
|
+
$ref: '#/components/responses/BadRequestResponse'
|
43212
44072
|
'403':
|
44073
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
44074
|
+
'429':
|
44075
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
44076
|
+
security:
|
44077
|
+
- apiKeyAuth: []
|
44078
|
+
appKeyAuth: []
|
44079
|
+
- AuthZ:
|
44080
|
+
- security_monitoring_filters_read
|
44081
|
+
summary: List resource filters
|
44082
|
+
tags:
|
44083
|
+
- Security Monitoring
|
44084
|
+
x-permission:
|
44085
|
+
operator: OR
|
44086
|
+
permissions:
|
44087
|
+
- security_monitoring_filters_read
|
44088
|
+
put:
|
44089
|
+
description: Update resource filters.
|
44090
|
+
operationId: UpdateResourceEvaluationFilters
|
44091
|
+
requestBody:
|
44092
|
+
content:
|
44093
|
+
application/json:
|
44094
|
+
schema:
|
44095
|
+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequest'
|
44096
|
+
required: true
|
44097
|
+
responses:
|
44098
|
+
'201':
|
43213
44099
|
content:
|
43214
44100
|
application/json:
|
43215
44101
|
schema:
|
43216
|
-
$ref: '#/components/schemas/
|
43217
|
-
description:
|
44102
|
+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponse'
|
44103
|
+
description: OK
|
44104
|
+
'400':
|
44105
|
+
$ref: '#/components/responses/BadRequestResponse'
|
44106
|
+
'403':
|
44107
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
43218
44108
|
'429':
|
43219
44109
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
43220
44110
|
security:
|
43221
44111
|
- apiKeyAuth: []
|
43222
44112
|
appKeyAuth: []
|
43223
|
-
- AuthZ:
|
43224
|
-
|
44113
|
+
- AuthZ:
|
44114
|
+
- security_monitoring_filters_write
|
44115
|
+
summary: Update resource filters
|
43225
44116
|
tags:
|
43226
|
-
-
|
43227
|
-
x-
|
43228
|
-
cursorParam: page[cursor]
|
43229
|
-
cursorPath: meta.pagination.next_cursor
|
43230
|
-
limitParam: page[size]
|
43231
|
-
resultsPath: data
|
44117
|
+
- Security Monitoring
|
44118
|
+
x-codegen-request-body-name: body
|
43232
44119
|
x-permission:
|
43233
|
-
operator:
|
43234
|
-
permissions:
|
43235
|
-
|
44120
|
+
operator: OR
|
44121
|
+
permissions:
|
44122
|
+
- security_monitoring_filters_write
|
44123
|
+
/api/v2/container_images:
|
43236
44124
|
get:
|
43237
|
-
description: Get all
|
43238
|
-
operationId:
|
44125
|
+
description: Get all Container Images for your organization.
|
44126
|
+
operationId: ListContainerImages
|
43239
44127
|
parameters:
|
43240
|
-
- description: Comma-separated list of tags to filter
|
43241
|
-
example:
|
44128
|
+
- description: Comma-separated list of tags to filter Container Images by.
|
44129
|
+
example: short_image:redis,status:running
|
43242
44130
|
in: query
|
43243
44131
|
name: filter[tags]
|
43244
44132
|
required: false
|
43245
44133
|
schema:
|
43246
44134
|
type: string
|
43247
|
-
- description: Comma-separated list of tags to group
|
43248
|
-
example:
|
44135
|
+
- description: Comma-separated list of tags to group Container Images by.
|
44136
|
+
example: registry,image_tags
|
43249
44137
|
in: query
|
43250
44138
|
name: group_by
|
43251
44139
|
required: false
|
43252
44140
|
schema:
|
43253
44141
|
type: string
|
43254
|
-
- description: Attribute to sort
|
43255
|
-
example:
|
44142
|
+
- description: Attribute to sort Container Images by.
|
44143
|
+
example: container_count
|
44144
|
+
in: query
|
44145
|
+
name: sort
|
44146
|
+
required: false
|
44147
|
+
schema:
|
44148
|
+
type: string
|
44149
|
+
- description: Maximum number of results returned.
|
44150
|
+
in: query
|
44151
|
+
name: page[size]
|
44152
|
+
required: false
|
44153
|
+
schema:
|
44154
|
+
default: 1000
|
44155
|
+
format: int32
|
44156
|
+
maximum: 10000
|
44157
|
+
minimum: 1
|
44158
|
+
type: integer
|
44159
|
+
- description: 'String to query the next page of results.
|
44160
|
+
|
44161
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
44162
|
+
in: query
|
44163
|
+
name: page[cursor]
|
44164
|
+
required: false
|
44165
|
+
schema:
|
44166
|
+
type: string
|
44167
|
+
responses:
|
44168
|
+
'200':
|
44169
|
+
content:
|
44170
|
+
application/json:
|
44171
|
+
schema:
|
44172
|
+
$ref: '#/components/schemas/ContainerImagesResponse'
|
44173
|
+
description: OK
|
44174
|
+
'400':
|
44175
|
+
content:
|
44176
|
+
application/json:
|
44177
|
+
schema:
|
44178
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
44179
|
+
description: Bad Request
|
44180
|
+
'403':
|
44181
|
+
content:
|
44182
|
+
application/json:
|
44183
|
+
schema:
|
44184
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
44185
|
+
description: Authentication Error
|
44186
|
+
'429':
|
44187
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
44188
|
+
security:
|
44189
|
+
- apiKeyAuth: []
|
44190
|
+
appKeyAuth: []
|
44191
|
+
- AuthZ: []
|
44192
|
+
summary: Get all Container Images
|
44193
|
+
tags:
|
44194
|
+
- Container Images
|
44195
|
+
x-pagination:
|
44196
|
+
cursorParam: page[cursor]
|
44197
|
+
cursorPath: meta.pagination.next_cursor
|
44198
|
+
limitParam: page[size]
|
44199
|
+
resultsPath: data
|
44200
|
+
x-permission:
|
44201
|
+
operator: OPEN
|
44202
|
+
permissions: []
|
44203
|
+
/api/v2/containers:
|
44204
|
+
get:
|
44205
|
+
description: Get all containers for your organization.
|
44206
|
+
operationId: ListContainers
|
44207
|
+
parameters:
|
44208
|
+
- description: Comma-separated list of tags to filter containers by.
|
44209
|
+
example: env:prod,short_image:cassandra
|
44210
|
+
in: query
|
44211
|
+
name: filter[tags]
|
44212
|
+
required: false
|
44213
|
+
schema:
|
44214
|
+
type: string
|
44215
|
+
- description: Comma-separated list of tags to group containers by.
|
44216
|
+
example: datacenter,cluster
|
44217
|
+
in: query
|
44218
|
+
name: group_by
|
44219
|
+
required: false
|
44220
|
+
schema:
|
44221
|
+
type: string
|
44222
|
+
- description: Attribute to sort containers by.
|
44223
|
+
example: started_at
|
43256
44224
|
in: query
|
43257
44225
|
name: sort
|
43258
44226
|
required: false
|
@@ -44829,10 +45797,163 @@ paths:
|
|
44829
45797
|
x-unstable: '**Note**: This endpoint is in public beta.
|
44830
45798
|
|
44831
45799
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
45800
|
+
/api/v2/dora/deployments:
|
45801
|
+
post:
|
45802
|
+
description: Use this API endpoint to get a list of deployment events.
|
45803
|
+
operationId: ListDORADeployments
|
45804
|
+
requestBody:
|
45805
|
+
content:
|
45806
|
+
application/json:
|
45807
|
+
schema:
|
45808
|
+
$ref: '#/components/schemas/DORAListDeploymentsRequest'
|
45809
|
+
required: true
|
45810
|
+
responses:
|
45811
|
+
'200':
|
45812
|
+
content:
|
45813
|
+
application/json:
|
45814
|
+
schema:
|
45815
|
+
$ref: '#/components/schemas/DORAListResponse'
|
45816
|
+
description: OK
|
45817
|
+
'400':
|
45818
|
+
content:
|
45819
|
+
application/json:
|
45820
|
+
schema:
|
45821
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
45822
|
+
description: Bad Request
|
45823
|
+
'403':
|
45824
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45825
|
+
'429':
|
45826
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45827
|
+
security:
|
45828
|
+
- apiKeyAuth: []
|
45829
|
+
appKeyAuth: []
|
45830
|
+
summary: Get a list of deployment events
|
45831
|
+
tags:
|
45832
|
+
- DORA Metrics
|
45833
|
+
x-codegen-request-body-name: body
|
45834
|
+
x-permission:
|
45835
|
+
operator: OR
|
45836
|
+
permissions:
|
45837
|
+
- dora_metrics_read
|
45838
|
+
/api/v2/dora/deployments/{deployment_id}:
|
45839
|
+
get:
|
45840
|
+
description: Use this API endpoint to get a deployment event.
|
45841
|
+
operationId: GetDORADeployment
|
45842
|
+
parameters:
|
45843
|
+
- description: The ID of the deployment event.
|
45844
|
+
in: path
|
45845
|
+
name: deployment_id
|
45846
|
+
required: true
|
45847
|
+
schema:
|
45848
|
+
type: string
|
45849
|
+
responses:
|
45850
|
+
'200':
|
45851
|
+
content:
|
45852
|
+
application/json:
|
45853
|
+
schema:
|
45854
|
+
$ref: '#/components/schemas/DORAFetchResponse'
|
45855
|
+
description: OK
|
45856
|
+
'400':
|
45857
|
+
content:
|
45858
|
+
application/json:
|
45859
|
+
schema:
|
45860
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
45861
|
+
description: Bad Request
|
45862
|
+
'403':
|
45863
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45864
|
+
'429':
|
45865
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45866
|
+
security:
|
45867
|
+
- apiKeyAuth: []
|
45868
|
+
- appKeyAuth: []
|
45869
|
+
summary: Get a deployment event
|
45870
|
+
tags:
|
45871
|
+
- DORA Metrics
|
45872
|
+
x-codegen-request-body-name: body
|
45873
|
+
x-permission:
|
45874
|
+
operator: OR
|
45875
|
+
permissions:
|
45876
|
+
- dora_metrics_read
|
45877
|
+
/api/v2/dora/failures:
|
45878
|
+
post:
|
45879
|
+
description: Use this API endpoint to get a list of failure events.
|
45880
|
+
operationId: ListDORAFailures
|
45881
|
+
requestBody:
|
45882
|
+
content:
|
45883
|
+
application/json:
|
45884
|
+
schema:
|
45885
|
+
$ref: '#/components/schemas/DORAListFailuresRequest'
|
45886
|
+
required: true
|
45887
|
+
responses:
|
45888
|
+
'200':
|
45889
|
+
content:
|
45890
|
+
application/json:
|
45891
|
+
schema:
|
45892
|
+
$ref: '#/components/schemas/DORAListResponse'
|
45893
|
+
description: OK
|
45894
|
+
'400':
|
45895
|
+
content:
|
45896
|
+
application/json:
|
45897
|
+
schema:
|
45898
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
45899
|
+
description: Bad Request
|
45900
|
+
'403':
|
45901
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45902
|
+
'429':
|
45903
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45904
|
+
security:
|
45905
|
+
- apiKeyAuth: []
|
45906
|
+
appKeyAuth: []
|
45907
|
+
summary: Get a list of failure events
|
45908
|
+
tags:
|
45909
|
+
- DORA Metrics
|
45910
|
+
x-codegen-request-body-name: body
|
45911
|
+
x-permission:
|
45912
|
+
operator: OR
|
45913
|
+
permissions:
|
45914
|
+
- dora_metrics_read
|
45915
|
+
/api/v2/dora/failures/{failure_id}:
|
45916
|
+
get:
|
45917
|
+
description: Use this API endpoint to get a failure event.
|
45918
|
+
operationId: GetDORAFailure
|
45919
|
+
parameters:
|
45920
|
+
- description: The ID of the failure event.
|
45921
|
+
in: path
|
45922
|
+
name: failure_id
|
45923
|
+
required: true
|
45924
|
+
schema:
|
45925
|
+
type: string
|
45926
|
+
responses:
|
45927
|
+
'200':
|
45928
|
+
content:
|
45929
|
+
application/json:
|
45930
|
+
schema:
|
45931
|
+
$ref: '#/components/schemas/DORAFetchResponse'
|
45932
|
+
description: OK
|
45933
|
+
'400':
|
45934
|
+
content:
|
45935
|
+
application/json:
|
45936
|
+
schema:
|
45937
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
45938
|
+
description: Bad Request
|
45939
|
+
'403':
|
45940
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
45941
|
+
'429':
|
45942
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
45943
|
+
security:
|
45944
|
+
- apiKeyAuth: []
|
45945
|
+
- appKeyAuth: []
|
45946
|
+
summary: Get a failure event
|
45947
|
+
tags:
|
45948
|
+
- DORA Metrics
|
45949
|
+
x-codegen-request-body-name: body
|
45950
|
+
x-permission:
|
45951
|
+
operator: OR
|
45952
|
+
permissions:
|
45953
|
+
- dora_metrics_read
|
44832
45954
|
/api/v2/dora/incident:
|
44833
45955
|
post:
|
44834
|
-
description: 'Use this API endpoint to provide data
|
44835
|
-
metrics.
|
45956
|
+
description: 'Use this API endpoint to provide failure data for DORA metrics.
|
44836
45957
|
|
44837
45958
|
|
44838
45959
|
This is necessary for:
|
@@ -49684,8 +50805,7 @@ paths:
|
|
49684
50805
|
maximum: 2147483647
|
49685
50806
|
minimum: 49
|
49686
50807
|
type: integer
|
49687
|
-
- description:
|
49688
|
-
metric is configured to use. Max number of aggregation combos is 9.
|
50808
|
+
- description: Deprecated. Number of aggregations has no impact on volume.
|
49689
50809
|
example: 1
|
49690
50810
|
in: query
|
49691
50811
|
name: filter[num_aggregations]
|
@@ -49893,17 +51013,16 @@ paths:
|
|
49893
51013
|
description: 'Create and define a list of queryable tag keys for an existing
|
49894
51014
|
count/gauge/rate/distribution metric.
|
49895
51015
|
|
49896
|
-
Optionally, include percentile aggregations on any distribution metric
|
49897
|
-
|
51016
|
+
Optionally, include percentile aggregations on any distribution metric. By
|
51017
|
+
setting `exclude_tags_mode`
|
49898
51018
|
|
49899
|
-
|
49900
|
-
the
|
51019
|
+
to true, the behavior is changed from an allow-list to a deny-list, and tags
|
51020
|
+
in the defined list are
|
49901
51021
|
|
49902
|
-
|
49903
|
-
|
51022
|
+
not queryable. Can only be used with application keys of users with the `Manage
|
51023
|
+
Tags for Metrics`
|
49904
51024
|
|
49905
|
-
|
49906
|
-
Metrics` permission.'
|
51025
|
+
permission.'
|
49907
51026
|
operationId: CreateTagConfiguration
|
49908
51027
|
parameters:
|
49909
51028
|
- $ref: '#/components/parameters/MetricName'
|
@@ -50517,22 +51636,8 @@ paths:
|
|
50517
51636
|
description: Get the list of devices.
|
50518
51637
|
operationId: ListDevices
|
50519
51638
|
parameters:
|
50520
|
-
-
|
50521
|
-
|
50522
|
-
in: query
|
50523
|
-
name: page[number]
|
50524
|
-
required: false
|
50525
|
-
schema:
|
50526
|
-
format: int64
|
50527
|
-
type: integer
|
50528
|
-
- description: The number of devices to return per page.
|
50529
|
-
example: 10
|
50530
|
-
in: query
|
50531
|
-
name: page[size]
|
50532
|
-
required: false
|
50533
|
-
schema:
|
50534
|
-
format: int64
|
50535
|
-
type: integer
|
51639
|
+
- $ref: '#/components/parameters/PageSize'
|
51640
|
+
- $ref: '#/components/parameters/PageNumber'
|
50536
51641
|
- description: The field to sort the devices by.
|
50537
51642
|
example: status
|
50538
51643
|
in: query
|
@@ -50563,6 +51668,10 @@ paths:
|
|
50563
51668
|
summary: Get the list of devices
|
50564
51669
|
tags:
|
50565
51670
|
- Network Device Monitoring
|
51671
|
+
x-pagination:
|
51672
|
+
limitParam: page[size]
|
51673
|
+
pageParam: page[number]
|
51674
|
+
resultsPath: data
|
50566
51675
|
/api/v2/ndm/devices/{device_id}:
|
50567
51676
|
get:
|
50568
51677
|
description: Get the device details.
|
@@ -50747,7 +51856,7 @@ paths:
|
|
50747
51856
|
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
50748
51857
|
/api/v2/on-call/escalation-policies:
|
50749
51858
|
post:
|
50750
|
-
description: Create a new
|
51859
|
+
description: Create a new On-Call escalation policy
|
50751
51860
|
operationId: CreateOnCallEscalationPolicy
|
50752
51861
|
parameters:
|
50753
51862
|
- description: 'Comma-separated list of included relationships to be returned.
|
@@ -50781,12 +51890,16 @@ paths:
|
|
50781
51890
|
- apiKeyAuth: []
|
50782
51891
|
appKeyAuth: []
|
50783
51892
|
- AuthZ: []
|
50784
|
-
summary: Create
|
51893
|
+
summary: Create On-Call escalation policy
|
50785
51894
|
tags:
|
50786
51895
|
- On-Call
|
51896
|
+
x-permission:
|
51897
|
+
operator: AND
|
51898
|
+
permissions:
|
51899
|
+
- on_call_write
|
50787
51900
|
/api/v2/on-call/escalation-policies/{policy_id}:
|
50788
51901
|
delete:
|
50789
|
-
description: Delete an
|
51902
|
+
description: Delete an On-Call escalation policy
|
50790
51903
|
operationId: DeleteOnCallEscalationPolicy
|
50791
51904
|
parameters:
|
50792
51905
|
- description: The ID of the escalation policy
|
@@ -50811,11 +51924,15 @@ paths:
|
|
50811
51924
|
- apiKeyAuth: []
|
50812
51925
|
appKeyAuth: []
|
50813
51926
|
- AuthZ: []
|
50814
|
-
summary: Delete
|
51927
|
+
summary: Delete On-Call escalation policy
|
50815
51928
|
tags:
|
50816
51929
|
- On-Call
|
51930
|
+
x-permission:
|
51931
|
+
operator: AND
|
51932
|
+
permissions:
|
51933
|
+
- on_call_write
|
50817
51934
|
get:
|
50818
|
-
description: Get an
|
51935
|
+
description: Get an On-Call escalation policy
|
50819
51936
|
operationId: GetOnCallEscalationPolicy
|
50820
51937
|
parameters:
|
50821
51938
|
- description: The ID of the escalation policy
|
@@ -50852,11 +51969,15 @@ paths:
|
|
50852
51969
|
- apiKeyAuth: []
|
50853
51970
|
appKeyAuth: []
|
50854
51971
|
- AuthZ: []
|
50855
|
-
summary: Get
|
51972
|
+
summary: Get On-Call escalation policy
|
50856
51973
|
tags:
|
50857
51974
|
- On-Call
|
51975
|
+
x-permission:
|
51976
|
+
operator: AND
|
51977
|
+
permissions:
|
51978
|
+
- on_call_read
|
50858
51979
|
put:
|
50859
|
-
description: Update an
|
51980
|
+
description: Update an On-Call escalation policy
|
50860
51981
|
operationId: UpdateOnCallEscalationPolicy
|
50861
51982
|
parameters:
|
50862
51983
|
- description: The ID of the escalation policy
|
@@ -50899,12 +52020,237 @@ paths:
|
|
50899
52020
|
- apiKeyAuth: []
|
50900
52021
|
appKeyAuth: []
|
50901
52022
|
- AuthZ: []
|
50902
|
-
summary: Update
|
52023
|
+
summary: Update On-Call escalation policy
|
50903
52024
|
tags:
|
50904
52025
|
- On-Call
|
52026
|
+
x-permission:
|
52027
|
+
operator: AND
|
52028
|
+
permissions:
|
52029
|
+
- on_call_write
|
52030
|
+
/api/v2/on-call/pages:
|
52031
|
+
post:
|
52032
|
+
description: 'Trigger a new On-Call Page.
|
52033
|
+
|
52034
|
+
'
|
52035
|
+
operationId: CreateOnCallPage
|
52036
|
+
requestBody:
|
52037
|
+
content:
|
52038
|
+
application/json:
|
52039
|
+
schema:
|
52040
|
+
$ref: '#/components/schemas/CreatePageRequest'
|
52041
|
+
required: true
|
52042
|
+
responses:
|
52043
|
+
'200':
|
52044
|
+
content:
|
52045
|
+
application/json:
|
52046
|
+
schema:
|
52047
|
+
$ref: '#/components/schemas/CreatePageResponse'
|
52048
|
+
description: OK.
|
52049
|
+
'429':
|
52050
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
52051
|
+
security:
|
52052
|
+
- apiKeyAuth: []
|
52053
|
+
appKeyAuth: []
|
52054
|
+
- AuthZ: []
|
52055
|
+
servers:
|
52056
|
+
- url: https://{site}
|
52057
|
+
variables:
|
52058
|
+
site:
|
52059
|
+
default: navy.oncall.datadoghq.com
|
52060
|
+
description: The globally available endpoint for On-Call.
|
52061
|
+
enum:
|
52062
|
+
- saffron.oncall.datadoghq.com
|
52063
|
+
- navy.oncall.datadoghq.com
|
52064
|
+
- coral.oncall.datadoghq.com
|
52065
|
+
- teal.oncall.datadoghq.com
|
52066
|
+
- beige.oncall.datadoghq.eu
|
52067
|
+
- url: '{protocol}://{name}'
|
52068
|
+
variables:
|
52069
|
+
name:
|
52070
|
+
default: api.datadoghq.com
|
52071
|
+
description: Full site DNS name.
|
52072
|
+
protocol:
|
52073
|
+
default: https
|
52074
|
+
description: The protocol for accessing the API.
|
52075
|
+
- url: https://{subdomain}.{site}
|
52076
|
+
variables:
|
52077
|
+
site:
|
52078
|
+
default: datadoghq.com
|
52079
|
+
description: Any Datadog deployment.
|
52080
|
+
subdomain:
|
52081
|
+
default: api
|
52082
|
+
description: The subdomain where the API is deployed.
|
52083
|
+
summary: Create On-Call Page
|
52084
|
+
tags:
|
52085
|
+
- On-Call Paging
|
52086
|
+
/api/v2/on-call/pages/{page_id}/acknowledge:
|
52087
|
+
post:
|
52088
|
+
description: 'Acknowledges an On-Call Page.
|
52089
|
+
|
52090
|
+
'
|
52091
|
+
operationId: AcknowledgeOnCallPage
|
52092
|
+
parameters:
|
52093
|
+
- description: The page ID.
|
52094
|
+
in: path
|
52095
|
+
name: page_id
|
52096
|
+
required: true
|
52097
|
+
schema:
|
52098
|
+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
|
52099
|
+
format: uuid
|
52100
|
+
type: string
|
52101
|
+
responses:
|
52102
|
+
'202':
|
52103
|
+
description: Accepted.
|
52104
|
+
'429':
|
52105
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
52106
|
+
security:
|
52107
|
+
- apiKeyAuth: []
|
52108
|
+
appKeyAuth: []
|
52109
|
+
- AuthZ: []
|
52110
|
+
servers:
|
52111
|
+
- url: https://{site}
|
52112
|
+
variables:
|
52113
|
+
site:
|
52114
|
+
default: navy.oncall.datadoghq.com
|
52115
|
+
description: The globally available endpoint for On-Call.
|
52116
|
+
enum:
|
52117
|
+
- saffron.oncall.datadoghq.com
|
52118
|
+
- navy.oncall.datadoghq.com
|
52119
|
+
- coral.oncall.datadoghq.com
|
52120
|
+
- teal.oncall.datadoghq.com
|
52121
|
+
- beige.oncall.datadoghq.eu
|
52122
|
+
- url: '{protocol}://{name}'
|
52123
|
+
variables:
|
52124
|
+
name:
|
52125
|
+
default: api.datadoghq.com
|
52126
|
+
description: Full site DNS name.
|
52127
|
+
protocol:
|
52128
|
+
default: https
|
52129
|
+
description: The protocol for accessing the API.
|
52130
|
+
- url: https://{subdomain}.{site}
|
52131
|
+
variables:
|
52132
|
+
site:
|
52133
|
+
default: datadoghq.com
|
52134
|
+
description: Any Datadog deployment.
|
52135
|
+
subdomain:
|
52136
|
+
default: api
|
52137
|
+
description: The subdomain where the API is deployed.
|
52138
|
+
summary: Acknowledge On-Call Page
|
52139
|
+
tags:
|
52140
|
+
- On-Call Paging
|
52141
|
+
/api/v2/on-call/pages/{page_id}/escalate:
|
52142
|
+
post:
|
52143
|
+
description: 'Escalates an On-Call Page.
|
52144
|
+
|
52145
|
+
'
|
52146
|
+
operationId: EscalateOnCallPage
|
52147
|
+
parameters:
|
52148
|
+
- description: The page ID.
|
52149
|
+
in: path
|
52150
|
+
name: page_id
|
52151
|
+
required: true
|
52152
|
+
schema:
|
52153
|
+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
|
52154
|
+
format: uuid
|
52155
|
+
type: string
|
52156
|
+
responses:
|
52157
|
+
'202':
|
52158
|
+
description: Accepted.
|
52159
|
+
'429':
|
52160
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
52161
|
+
security:
|
52162
|
+
- apiKeyAuth: []
|
52163
|
+
appKeyAuth: []
|
52164
|
+
- AuthZ: []
|
52165
|
+
servers:
|
52166
|
+
- url: https://{site}
|
52167
|
+
variables:
|
52168
|
+
site:
|
52169
|
+
default: navy.oncall.datadoghq.com
|
52170
|
+
description: The globally available endpoint for On-Call.
|
52171
|
+
enum:
|
52172
|
+
- saffron.oncall.datadoghq.com
|
52173
|
+
- navy.oncall.datadoghq.com
|
52174
|
+
- coral.oncall.datadoghq.com
|
52175
|
+
- teal.oncall.datadoghq.com
|
52176
|
+
- beige.oncall.datadoghq.eu
|
52177
|
+
- url: '{protocol}://{name}'
|
52178
|
+
variables:
|
52179
|
+
name:
|
52180
|
+
default: api.datadoghq.com
|
52181
|
+
description: Full site DNS name.
|
52182
|
+
protocol:
|
52183
|
+
default: https
|
52184
|
+
description: The protocol for accessing the API.
|
52185
|
+
- url: https://{subdomain}.{site}
|
52186
|
+
variables:
|
52187
|
+
site:
|
52188
|
+
default: datadoghq.com
|
52189
|
+
description: Any Datadog deployment.
|
52190
|
+
subdomain:
|
52191
|
+
default: api
|
52192
|
+
description: The subdomain where the API is deployed.
|
52193
|
+
summary: Escalate On-Call Page
|
52194
|
+
tags:
|
52195
|
+
- On-Call Paging
|
52196
|
+
/api/v2/on-call/pages/{page_id}/resolve:
|
52197
|
+
post:
|
52198
|
+
description: 'Resolves an On-Call Page.
|
52199
|
+
|
52200
|
+
'
|
52201
|
+
operationId: ResolveOnCallPage
|
52202
|
+
parameters:
|
52203
|
+
- description: The page ID.
|
52204
|
+
in: path
|
52205
|
+
name: page_id
|
52206
|
+
required: true
|
52207
|
+
schema:
|
52208
|
+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
|
52209
|
+
format: uuid
|
52210
|
+
type: string
|
52211
|
+
responses:
|
52212
|
+
'202':
|
52213
|
+
description: Accepted.
|
52214
|
+
'429':
|
52215
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
52216
|
+
security:
|
52217
|
+
- apiKeyAuth: []
|
52218
|
+
appKeyAuth: []
|
52219
|
+
- AuthZ: []
|
52220
|
+
servers:
|
52221
|
+
- url: https://{site}
|
52222
|
+
variables:
|
52223
|
+
site:
|
52224
|
+
default: navy.oncall.datadoghq.com
|
52225
|
+
description: The globally available endpoint for On-Call.
|
52226
|
+
enum:
|
52227
|
+
- saffron.oncall.datadoghq.com
|
52228
|
+
- navy.oncall.datadoghq.com
|
52229
|
+
- coral.oncall.datadoghq.com
|
52230
|
+
- teal.oncall.datadoghq.com
|
52231
|
+
- beige.oncall.datadoghq.eu
|
52232
|
+
- url: '{protocol}://{name}'
|
52233
|
+
variables:
|
52234
|
+
name:
|
52235
|
+
default: api.datadoghq.com
|
52236
|
+
description: Full site DNS name.
|
52237
|
+
protocol:
|
52238
|
+
default: https
|
52239
|
+
description: The protocol for accessing the API.
|
52240
|
+
- url: https://{subdomain}.{site}
|
52241
|
+
variables:
|
52242
|
+
site:
|
52243
|
+
default: datadoghq.com
|
52244
|
+
description: Any Datadog deployment.
|
52245
|
+
subdomain:
|
52246
|
+
default: api
|
52247
|
+
description: The subdomain where the API is deployed.
|
52248
|
+
summary: Resolve On-Call Page
|
52249
|
+
tags:
|
52250
|
+
- On-Call Paging
|
50905
52251
|
/api/v2/on-call/schedules:
|
50906
52252
|
post:
|
50907
|
-
description: Create a new
|
52253
|
+
description: Create a new On-Call schedule
|
50908
52254
|
operationId: CreateOnCallSchedule
|
50909
52255
|
parameters:
|
50910
52256
|
- description: 'Comma-separated list of included relationships to be returned.
|
@@ -50938,12 +52284,16 @@ paths:
|
|
50938
52284
|
- apiKeyAuth: []
|
50939
52285
|
appKeyAuth: []
|
50940
52286
|
- AuthZ: []
|
50941
|
-
summary: Create
|
52287
|
+
summary: Create On-Call schedule
|
50942
52288
|
tags:
|
50943
52289
|
- On-Call
|
52290
|
+
x-permission:
|
52291
|
+
operator: AND
|
52292
|
+
permissions:
|
52293
|
+
- on_call_write
|
50944
52294
|
/api/v2/on-call/schedules/{schedule_id}:
|
50945
52295
|
delete:
|
50946
|
-
description: Delete an
|
52296
|
+
description: Delete an On-Call schedule
|
50947
52297
|
operationId: DeleteOnCallSchedule
|
50948
52298
|
parameters:
|
50949
52299
|
- description: The ID of the schedule
|
@@ -50968,11 +52318,15 @@ paths:
|
|
50968
52318
|
- apiKeyAuth: []
|
50969
52319
|
appKeyAuth: []
|
50970
52320
|
- AuthZ: []
|
50971
|
-
summary: Delete
|
52321
|
+
summary: Delete On-Call schedule
|
50972
52322
|
tags:
|
50973
52323
|
- On-Call
|
52324
|
+
x-permission:
|
52325
|
+
operator: AND
|
52326
|
+
permissions:
|
52327
|
+
- on_call_write
|
50974
52328
|
get:
|
50975
|
-
description: Get an
|
52329
|
+
description: Get an On-Call schedule
|
50976
52330
|
operationId: GetOnCallSchedule
|
50977
52331
|
parameters:
|
50978
52332
|
- description: 'Comma-separated list of included relationships to be returned.
|
@@ -51007,11 +52361,15 @@ paths:
|
|
51007
52361
|
- apiKeyAuth: []
|
51008
52362
|
appKeyAuth: []
|
51009
52363
|
- AuthZ: []
|
51010
|
-
summary: Get
|
52364
|
+
summary: Get On-Call schedule
|
51011
52365
|
tags:
|
51012
52366
|
- On-Call
|
52367
|
+
x-permission:
|
52368
|
+
operator: AND
|
52369
|
+
permissions:
|
52370
|
+
- on_call_read
|
51013
52371
|
put:
|
51014
|
-
description: Update a new
|
52372
|
+
description: Update a new On-Call schedule
|
51015
52373
|
operationId: UpdateOnCallSchedule
|
51016
52374
|
parameters:
|
51017
52375
|
- description: 'Comma-separated list of included relationships to be returned.
|
@@ -51054,9 +52412,144 @@ paths:
|
|
51054
52412
|
- apiKeyAuth: []
|
51055
52413
|
appKeyAuth: []
|
51056
52414
|
- AuthZ: []
|
51057
|
-
summary: Update
|
52415
|
+
summary: Update On-Call schedule
|
52416
|
+
tags:
|
52417
|
+
- On-Call
|
52418
|
+
x-permission:
|
52419
|
+
operator: AND
|
52420
|
+
permissions:
|
52421
|
+
- on_call_write
|
52422
|
+
/api/v2/on-call/schedules/{schedule_id}/on-call:
|
52423
|
+
get:
|
52424
|
+
description: Retrieves the user who is on-call for the specified schedule at
|
52425
|
+
a given time.
|
52426
|
+
operationId: GetScheduleOnCallUser
|
52427
|
+
parameters:
|
52428
|
+
- description: 'Specifies related resources to include in the response as a
|
52429
|
+
comma-separated list. Allowed value: `user`.'
|
52430
|
+
in: query
|
52431
|
+
name: include
|
52432
|
+
schema:
|
52433
|
+
type: string
|
52434
|
+
- description: The ID of the schedule.
|
52435
|
+
in: path
|
52436
|
+
name: schedule_id
|
52437
|
+
required: true
|
52438
|
+
schema:
|
52439
|
+
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
|
52440
|
+
type: string
|
52441
|
+
- description: Retrieves the on-call user at the given timestamp (ISO-8601).
|
52442
|
+
Defaults to the current time if omitted."
|
52443
|
+
in: query
|
52444
|
+
name: filter[at_ts]
|
52445
|
+
schema:
|
52446
|
+
example: '2025-05-07T02:53:01Z'
|
52447
|
+
type: string
|
52448
|
+
responses:
|
52449
|
+
'200':
|
52450
|
+
content:
|
52451
|
+
application/json:
|
52452
|
+
schema:
|
52453
|
+
$ref: '#/components/schemas/Shift'
|
52454
|
+
description: OK
|
52455
|
+
'400':
|
52456
|
+
$ref: '#/components/responses/BadRequestResponse'
|
52457
|
+
'401':
|
52458
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
52459
|
+
'403':
|
52460
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
52461
|
+
'404':
|
52462
|
+
$ref: '#/components/responses/NotFoundResponse'
|
52463
|
+
'429':
|
52464
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
52465
|
+
security:
|
52466
|
+
- apiKeyAuth: []
|
52467
|
+
appKeyAuth: []
|
52468
|
+
- AuthZ: []
|
52469
|
+
summary: Get the schedule on-call user
|
52470
|
+
tags:
|
52471
|
+
- On-Call
|
52472
|
+
/api/v2/on-call/teams/{team_id}/routing-rules:
|
52473
|
+
get:
|
52474
|
+
description: Get a team's On-Call routing rules
|
52475
|
+
operationId: GetOnCallTeamRoutingRules
|
52476
|
+
parameters:
|
52477
|
+
- description: The team ID
|
52478
|
+
in: path
|
52479
|
+
name: team_id
|
52480
|
+
required: true
|
52481
|
+
schema:
|
52482
|
+
example: 27590dae-47be-4a7d-9abf-8f4e45124020
|
52483
|
+
type: string
|
52484
|
+
- description: 'Comma-separated list of included relationships to be returned.
|
52485
|
+
Allowed values: `rules`, `rules.policy`.'
|
52486
|
+
in: query
|
52487
|
+
name: include
|
52488
|
+
schema:
|
52489
|
+
type: string
|
52490
|
+
responses:
|
52491
|
+
'200':
|
52492
|
+
content:
|
52493
|
+
application/json:
|
52494
|
+
schema:
|
52495
|
+
$ref: '#/components/schemas/TeamRoutingRules'
|
52496
|
+
description: OK
|
52497
|
+
'429':
|
52498
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
52499
|
+
security:
|
52500
|
+
- apiKeyAuth: []
|
52501
|
+
appKeyAuth: []
|
52502
|
+
- AuthZ: []
|
52503
|
+
summary: Get On-Call team routing rules
|
51058
52504
|
tags:
|
51059
52505
|
- On-Call
|
52506
|
+
x-permission:
|
52507
|
+
operator: AND
|
52508
|
+
permissions:
|
52509
|
+
- on_call_read
|
52510
|
+
put:
|
52511
|
+
description: Set a team's On-Call routing rules
|
52512
|
+
operationId: SetOnCallTeamRoutingRules
|
52513
|
+
parameters:
|
52514
|
+
- description: The team ID
|
52515
|
+
in: path
|
52516
|
+
name: team_id
|
52517
|
+
required: true
|
52518
|
+
schema:
|
52519
|
+
example: 27590dae-47be-4a7d-9abf-8f4e45124020
|
52520
|
+
type: string
|
52521
|
+
- description: 'Comma-separated list of included relationships to be returned.
|
52522
|
+
Allowed values: `rules`, `rules.policy`.'
|
52523
|
+
in: query
|
52524
|
+
name: include
|
52525
|
+
schema:
|
52526
|
+
type: string
|
52527
|
+
requestBody:
|
52528
|
+
content:
|
52529
|
+
application/json:
|
52530
|
+
schema:
|
52531
|
+
$ref: '#/components/schemas/TeamRoutingRulesRequest'
|
52532
|
+
required: true
|
52533
|
+
responses:
|
52534
|
+
'200':
|
52535
|
+
content:
|
52536
|
+
application/json:
|
52537
|
+
schema:
|
52538
|
+
$ref: '#/components/schemas/TeamRoutingRules'
|
52539
|
+
description: OK
|
52540
|
+
'429':
|
52541
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
52542
|
+
security:
|
52543
|
+
- apiKeyAuth: []
|
52544
|
+
appKeyAuth: []
|
52545
|
+
- AuthZ: []
|
52546
|
+
summary: Set On-Call team routing rules
|
52547
|
+
tags:
|
52548
|
+
- On-Call
|
52549
|
+
x-permission:
|
52550
|
+
operator: AND
|
52551
|
+
permissions:
|
52552
|
+
- on_call_write
|
51060
52553
|
/api/v2/org_configs:
|
51061
52554
|
get:
|
51062
52555
|
description: Returns all Org Configs (name, description, and value).
|
@@ -52099,8 +53592,14 @@ paths:
|
|
52099
53592
|
x-terraform-resource: appsec_waf_exclusion_filter
|
52100
53593
|
/api/v2/remote_config/products/cws/agent_rules:
|
52101
53594
|
get:
|
52102
|
-
description: Get the list of
|
53595
|
+
description: 'Get the list of Workload Protection agent rules.
|
53596
|
+
|
53597
|
+
|
53598
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53599
|
+
Please reference the (US1-FED) specific resource below.'
|
52103
53600
|
operationId: ListCSMThreatsAgentRules
|
53601
|
+
parameters:
|
53602
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID'
|
52104
53603
|
responses:
|
52105
53604
|
'200':
|
52106
53605
|
content:
|
@@ -52112,19 +53611,22 @@ paths:
|
|
52112
53611
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
52113
53612
|
'429':
|
52114
53613
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
52115
|
-
summary: Get all
|
53614
|
+
summary: Get all Workload Protection agent rules
|
52116
53615
|
tags:
|
52117
53616
|
- CSM Threats
|
52118
53617
|
post:
|
52119
|
-
description: Create a new
|
52120
|
-
|
53618
|
+
description: 'Create a new Workload Protection agent rule with the given parameters.
|
53619
|
+
|
53620
|
+
|
53621
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53622
|
+
Please reference the (US1-FED) specific resource below.'
|
52121
53623
|
operationId: CreateCSMThreatsAgentRule
|
52122
53624
|
requestBody:
|
52123
53625
|
content:
|
52124
53626
|
application/json:
|
52125
53627
|
schema:
|
52126
53628
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest'
|
52127
|
-
description: The definition of the new
|
53629
|
+
description: The definition of the new agent rule
|
52128
53630
|
required: true
|
52129
53631
|
responses:
|
52130
53632
|
'200':
|
@@ -52141,16 +53643,21 @@ paths:
|
|
52141
53643
|
$ref: '#/components/responses/ConflictResponse'
|
52142
53644
|
'429':
|
52143
53645
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
52144
|
-
summary: Create a
|
53646
|
+
summary: Create a Workload Protection agent rule
|
52145
53647
|
tags:
|
52146
53648
|
- CSM Threats
|
52147
53649
|
x-codegen-request-body-name: body
|
52148
53650
|
/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}:
|
52149
53651
|
delete:
|
52150
|
-
description: Delete a specific
|
53652
|
+
description: 'Delete a specific Workload Protection agent rule.
|
53653
|
+
|
53654
|
+
|
53655
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53656
|
+
Please reference the (US1-FED) specific resource below.'
|
52151
53657
|
operationId: DeleteCSMThreatsAgentRule
|
52152
53658
|
parameters:
|
52153
53659
|
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
53660
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID'
|
52154
53661
|
responses:
|
52155
53662
|
'204':
|
52156
53663
|
description: OK
|
@@ -52160,15 +53667,19 @@ paths:
|
|
52160
53667
|
$ref: '#/components/responses/NotFoundResponse'
|
52161
53668
|
'429':
|
52162
53669
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
52163
|
-
summary: Delete a
|
53670
|
+
summary: Delete a Workload Protection agent rule
|
52164
53671
|
tags:
|
52165
53672
|
- CSM Threats
|
52166
53673
|
get:
|
52167
|
-
description: Get the details of a specific
|
52168
|
-
|
53674
|
+
description: 'Get the details of a specific Workload Protection agent rule.
|
53675
|
+
|
53676
|
+
|
53677
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53678
|
+
Please reference the (US1-FED) specific resource below.'
|
52169
53679
|
operationId: GetCSMThreatsAgentRule
|
52170
53680
|
parameters:
|
52171
53681
|
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
53682
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID'
|
52172
53683
|
responses:
|
52173
53684
|
'200':
|
52174
53685
|
content:
|
@@ -52182,22 +53693,27 @@ paths:
|
|
52182
53693
|
$ref: '#/components/responses/NotFoundResponse'
|
52183
53694
|
'429':
|
52184
53695
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
52185
|
-
summary: Get a
|
53696
|
+
summary: Get a Workload Protection agent rule
|
52186
53697
|
tags:
|
52187
53698
|
- CSM Threats
|
52188
53699
|
patch:
|
52189
|
-
description: 'Update a specific
|
53700
|
+
description: 'Update a specific Workload Protection Agent rule.
|
53701
|
+
|
53702
|
+
Returns the agent rule object when the request is successful.
|
52190
53703
|
|
52191
|
-
|
53704
|
+
|
53705
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53706
|
+
Please reference the (US1-FED) specific resource below.'
|
52192
53707
|
operationId: UpdateCSMThreatsAgentRule
|
52193
53708
|
parameters:
|
52194
53709
|
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
53710
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID'
|
52195
53711
|
requestBody:
|
52196
53712
|
content:
|
52197
53713
|
application/json:
|
52198
53714
|
schema:
|
52199
53715
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest'
|
52200
|
-
description: New definition of the
|
53716
|
+
description: New definition of the agent rule
|
52201
53717
|
required: true
|
52202
53718
|
responses:
|
52203
53719
|
'200':
|
@@ -52216,19 +53732,78 @@ paths:
|
|
52216
53732
|
$ref: '#/components/responses/ConcurrentModificationResponse'
|
52217
53733
|
'429':
|
52218
53734
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
52219
|
-
summary: Update a
|
53735
|
+
summary: Update a Workload Protection agent rule
|
53736
|
+
tags:
|
53737
|
+
- CSM Threats
|
53738
|
+
x-codegen-request-body-name: body
|
53739
|
+
/api/v2/remote_config/products/cws/policy:
|
53740
|
+
get:
|
53741
|
+
description: 'Get the list of Workload Protection policies.
|
53742
|
+
|
53743
|
+
|
53744
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53745
|
+
Please reference the (US1-FED) specific resource below.'
|
53746
|
+
operationId: ListCSMThreatsAgentPolicies
|
53747
|
+
responses:
|
53748
|
+
'200':
|
53749
|
+
content:
|
53750
|
+
application/json:
|
53751
|
+
schema:
|
53752
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse'
|
53753
|
+
description: OK
|
53754
|
+
'403':
|
53755
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
53756
|
+
'429':
|
53757
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53758
|
+
summary: Get all Workload Protection policies
|
53759
|
+
tags:
|
53760
|
+
- CSM Threats
|
53761
|
+
post:
|
53762
|
+
description: 'Create a new Workload Protection policy with the given parameters.
|
53763
|
+
|
53764
|
+
|
53765
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53766
|
+
Please reference the (US1-FED) specific resource below.'
|
53767
|
+
operationId: CreateCSMThreatsAgentPolicy
|
53768
|
+
requestBody:
|
53769
|
+
content:
|
53770
|
+
application/json:
|
53771
|
+
schema:
|
53772
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateRequest'
|
53773
|
+
description: The definition of the new Agent policy
|
53774
|
+
required: true
|
53775
|
+
responses:
|
53776
|
+
'200':
|
53777
|
+
content:
|
53778
|
+
application/json:
|
53779
|
+
schema:
|
53780
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse'
|
53781
|
+
description: OK
|
53782
|
+
'400':
|
53783
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53784
|
+
'403':
|
53785
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
53786
|
+
'409':
|
53787
|
+
$ref: '#/components/responses/ConflictResponse'
|
53788
|
+
'429':
|
53789
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53790
|
+
summary: Create a Workload Protection policy
|
52220
53791
|
tags:
|
52221
53792
|
- CSM Threats
|
52222
53793
|
x-codegen-request-body-name: body
|
52223
53794
|
/api/v2/remote_config/products/cws/policy/download:
|
52224
53795
|
get:
|
52225
|
-
description: 'The download endpoint generates a
|
52226
|
-
your currently active
|
53796
|
+
description: 'The download endpoint generates a Workload Protection policy file
|
53797
|
+
from your currently active
|
53798
|
+
|
53799
|
+
Workload Protection agent rules, and downloads them as a `.policy` file. This
|
53800
|
+
file can then be deployed to
|
52227
53801
|
|
52228
|
-
|
52229
|
-
be deployed to
|
53802
|
+
your agents to update the policy running in your environment.
|
52230
53803
|
|
52231
|
-
|
53804
|
+
|
53805
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53806
|
+
Please reference the (US1-FED) specific resource below.'
|
52232
53807
|
operationId: DownloadCSMThreatsPolicy
|
52233
53808
|
responses:
|
52234
53809
|
'200':
|
@@ -52242,9 +53817,97 @@ paths:
|
|
52242
53817
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
52243
53818
|
'429':
|
52244
53819
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
52245
|
-
summary:
|
53820
|
+
summary: Download the Workload Protection policy
|
52246
53821
|
tags:
|
52247
53822
|
- CSM Threats
|
53823
|
+
/api/v2/remote_config/products/cws/policy/{policy_id}:
|
53824
|
+
delete:
|
53825
|
+
description: 'Delete a specific Workload Protection policy.
|
53826
|
+
|
53827
|
+
|
53828
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53829
|
+
Please reference the (US1-FED) specific resource below.'
|
53830
|
+
operationId: DeleteCSMThreatsAgentPolicy
|
53831
|
+
parameters:
|
53832
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID'
|
53833
|
+
responses:
|
53834
|
+
'202':
|
53835
|
+
description: OK
|
53836
|
+
'204':
|
53837
|
+
description: OK
|
53838
|
+
'403':
|
53839
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
53840
|
+
'404':
|
53841
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53842
|
+
'429':
|
53843
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53844
|
+
summary: Delete a Workload Protection policy
|
53845
|
+
tags:
|
53846
|
+
- CSM Threats
|
53847
|
+
get:
|
53848
|
+
description: 'Get the details of a specific Workload Protection policy.
|
53849
|
+
|
53850
|
+
|
53851
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53852
|
+
Please reference the (US1-FED) specific resource below.'
|
53853
|
+
operationId: GetCSMThreatsAgentPolicy
|
53854
|
+
parameters:
|
53855
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID'
|
53856
|
+
responses:
|
53857
|
+
'200':
|
53858
|
+
content:
|
53859
|
+
application/json:
|
53860
|
+
schema:
|
53861
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse'
|
53862
|
+
description: OK
|
53863
|
+
'403':
|
53864
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
53865
|
+
'404':
|
53866
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53867
|
+
'429':
|
53868
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53869
|
+
summary: Get a Workload Protection policy
|
53870
|
+
tags:
|
53871
|
+
- CSM Threats
|
53872
|
+
patch:
|
53873
|
+
description: 'Update a specific Workload Protection policy.
|
53874
|
+
|
53875
|
+
Returns the policy object when the request is successful.
|
53876
|
+
|
53877
|
+
|
53878
|
+
**Note**: This endpoint is not available for the Government (US1-FED) site.
|
53879
|
+
Please reference the (US1-FED) specific resource below.'
|
53880
|
+
operationId: UpdateCSMThreatsAgentPolicy
|
53881
|
+
parameters:
|
53882
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID'
|
53883
|
+
requestBody:
|
53884
|
+
content:
|
53885
|
+
application/json:
|
53886
|
+
schema:
|
53887
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateRequest'
|
53888
|
+
description: New definition of the Agent policy
|
53889
|
+
required: true
|
53890
|
+
responses:
|
53891
|
+
'200':
|
53892
|
+
content:
|
53893
|
+
application/json:
|
53894
|
+
schema:
|
53895
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse'
|
53896
|
+
description: OK
|
53897
|
+
'400':
|
53898
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53899
|
+
'403':
|
53900
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
53901
|
+
'404':
|
53902
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53903
|
+
'409':
|
53904
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
53905
|
+
'429':
|
53906
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53907
|
+
summary: Update a Workload Protection policy
|
53908
|
+
tags:
|
53909
|
+
- CSM Threats
|
53910
|
+
x-codegen-request-body-name: body
|
52248
53911
|
/api/v2/remote_config/products/obs_pipelines/pipelines:
|
52249
53912
|
get:
|
52250
53913
|
description: Retrieve a list of pipelines.
|
@@ -54359,13 +56022,16 @@ paths:
|
|
54359
56022
|
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
54360
56023
|
/api/v2/security/cloud_workload/policy/download:
|
54361
56024
|
get:
|
54362
|
-
description: 'The download endpoint generates a
|
54363
|
-
|
56025
|
+
description: 'The download endpoint generates a Workload Protection policy file
|
56026
|
+
from your currently active
|
54364
56027
|
|
54365
|
-
|
56028
|
+
Workload Protection agent rules, and downloads them as a `.policy` file. This
|
54366
56029
|
file can then be deployed to
|
54367
56030
|
|
54368
|
-
your
|
56031
|
+
your agents to update the policy running in your environment.
|
56032
|
+
|
56033
|
+
|
56034
|
+
**Note**: This endpoint should only be used for the Government (US1-FED) site.'
|
54369
56035
|
operationId: DownloadCloudWorkloadPolicyFile
|
54370
56036
|
responses:
|
54371
56037
|
'200':
|
@@ -54379,7 +56045,7 @@ paths:
|
|
54379
56045
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
54380
56046
|
'429':
|
54381
56047
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
54382
|
-
summary:
|
56048
|
+
summary: Download the Workload Protection policy (US1-FED)
|
54383
56049
|
tags:
|
54384
56050
|
- CSM Threats
|
54385
56051
|
x-permission:
|
@@ -55201,7 +56867,10 @@ paths:
|
|
55201
56867
|
- security_monitoring_notification_profiles_write
|
55202
56868
|
/api/v2/security_monitoring/cloud_workload_security/agent_rules:
|
55203
56869
|
get:
|
55204
|
-
description: Get the list of
|
56870
|
+
description: 'Get the list of agent rules.
|
56871
|
+
|
56872
|
+
|
56873
|
+
**Note**: This endpoint should only be used for the Government (US1-FED) site.'
|
55205
56874
|
operationId: ListCloudWorkloadSecurityAgentRules
|
55206
56875
|
responses:
|
55207
56876
|
'200':
|
@@ -55214,7 +56883,7 @@ paths:
|
|
55214
56883
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
55215
56884
|
'429':
|
55216
56885
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
55217
|
-
summary: Get all
|
56886
|
+
summary: Get all Workload Protection agent rules (US1-FED)
|
55218
56887
|
tags:
|
55219
56888
|
- CSM Threats
|
55220
56889
|
x-permission:
|
@@ -55222,14 +56891,17 @@ paths:
|
|
55222
56891
|
permissions:
|
55223
56892
|
- security_monitoring_cws_agent_rules_read
|
55224
56893
|
post:
|
55225
|
-
description: Create a new
|
56894
|
+
description: 'Create a new agent rule with the given parameters.
|
56895
|
+
|
56896
|
+
|
56897
|
+
**Note**: This endpoint should only be used for the Government (US1-FED) site.'
|
55226
56898
|
operationId: CreateCloudWorkloadSecurityAgentRule
|
55227
56899
|
requestBody:
|
55228
56900
|
content:
|
55229
56901
|
application/json:
|
55230
56902
|
schema:
|
55231
56903
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest'
|
55232
|
-
description: The definition of the new
|
56904
|
+
description: The definition of the new agent rule
|
55233
56905
|
required: true
|
55234
56906
|
responses:
|
55235
56907
|
'200':
|
@@ -55246,7 +56918,7 @@ paths:
|
|
55246
56918
|
$ref: '#/components/responses/ConflictResponse'
|
55247
56919
|
'429':
|
55248
56920
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
55249
|
-
summary: Create a
|
56921
|
+
summary: Create a Workload Protection agent rule (US1-FED)
|
55250
56922
|
tags:
|
55251
56923
|
- CSM Threats
|
55252
56924
|
x-codegen-request-body-name: body
|
@@ -55256,7 +56928,10 @@ paths:
|
|
55256
56928
|
- security_monitoring_cws_agent_rules_write
|
55257
56929
|
/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}:
|
55258
56930
|
delete:
|
55259
|
-
description: Delete a specific
|
56931
|
+
description: 'Delete a specific agent rule.
|
56932
|
+
|
56933
|
+
|
56934
|
+
**Note**: This endpoint should only be used for the Government (US1-FED) site.'
|
55260
56935
|
operationId: DeleteCloudWorkloadSecurityAgentRule
|
55261
56936
|
parameters:
|
55262
56937
|
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
@@ -55269,7 +56944,7 @@ paths:
|
|
55269
56944
|
$ref: '#/components/responses/NotFoundResponse'
|
55270
56945
|
'429':
|
55271
56946
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
55272
|
-
summary: Delete a
|
56947
|
+
summary: Delete a Workload Protection agent rule (US1-FED)
|
55273
56948
|
tags:
|
55274
56949
|
- CSM Threats
|
55275
56950
|
x-permission:
|
@@ -55277,7 +56952,10 @@ paths:
|
|
55277
56952
|
permissions:
|
55278
56953
|
- security_monitoring_cws_agent_rules_write
|
55279
56954
|
get:
|
55280
|
-
description: Get the details of a specific
|
56955
|
+
description: 'Get the details of a specific agent rule.
|
56956
|
+
|
56957
|
+
|
56958
|
+
**Note**: This endpoint should only be used for the Government (US1-FED) site.'
|
55281
56959
|
operationId: GetCloudWorkloadSecurityAgentRule
|
55282
56960
|
parameters:
|
55283
56961
|
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
@@ -55294,7 +56972,7 @@ paths:
|
|
55294
56972
|
$ref: '#/components/responses/NotFoundResponse'
|
55295
56973
|
'429':
|
55296
56974
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
55297
|
-
summary: Get a
|
56975
|
+
summary: Get a Workload Protection agent rule (US1-FED)
|
55298
56976
|
tags:
|
55299
56977
|
- CSM Threats
|
55300
56978
|
x-permission:
|
@@ -55302,9 +56980,12 @@ paths:
|
|
55302
56980
|
permissions:
|
55303
56981
|
- security_monitoring_cws_agent_rules_read
|
55304
56982
|
patch:
|
55305
|
-
description: 'Update a specific
|
56983
|
+
description: 'Update a specific agent rule.
|
56984
|
+
|
56985
|
+
Returns the agent rule object when the request is successful.
|
56986
|
+
|
55306
56987
|
|
55307
|
-
|
56988
|
+
**Note**: This endpoint should only be used for the Government (US1-FED) site.'
|
55308
56989
|
operationId: UpdateCloudWorkloadSecurityAgentRule
|
55309
56990
|
parameters:
|
55310
56991
|
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
@@ -55313,7 +56994,7 @@ paths:
|
|
55313
56994
|
application/json:
|
55314
56995
|
schema:
|
55315
56996
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest'
|
55316
|
-
description: New definition of the
|
56997
|
+
description: New definition of the agent rule
|
55317
56998
|
required: true
|
55318
56999
|
responses:
|
55319
57000
|
'200':
|
@@ -55332,7 +57013,7 @@ paths:
|
|
55332
57013
|
$ref: '#/components/responses/ConcurrentModificationResponse'
|
55333
57014
|
'429':
|
55334
57015
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
55335
|
-
summary: Update a
|
57016
|
+
summary: Update a Workload Protection agent rule (US1-FED)
|
55336
57017
|
tags:
|
55337
57018
|
- CSM Threats
|
55338
57019
|
x-codegen-request-body-name: body
|
@@ -60603,10 +62284,14 @@ tags:
|
|
60603
62284
|
|
60604
62285
|
Go to https://docs.datadoghq.com/security/cloud_security_management to learn more.'
|
60605
62286
|
name: CSM Coverage Analysis
|
60606
|
-
- description:
|
60607
|
-
|
60608
|
-
|
60609
|
-
|
62287
|
+
- description: 'Workload Protection monitors file, network, and process activity across
|
62288
|
+
your environment to detect real-time threats to your infrastructure. See [Workload
|
62289
|
+
Protection](https://docs.datadoghq.com/security/workload_protection/) for more
|
62290
|
+
information on setting up Workload Protection.
|
62291
|
+
|
62292
|
+
|
62293
|
+
**Note**: These endpoints are split based on whether you are using the US1-FED
|
62294
|
+
site or not. Please reference the specific resource for the site you are using.'
|
60610
62295
|
name: CSM Threats
|
60611
62296
|
- description: View and manage cases and projects within Case Management. See the
|
60612
62297
|
[Case Management page](https://docs.datadoghq.com/service_management/case_management/)
|
@@ -60638,9 +62323,12 @@ tags:
|
|
60638
62323
|
See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for
|
60639
62324
|
more information.
|
60640
62325
|
name: Containers
|
60641
|
-
- description:
|
60642
|
-
See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/)
|
60643
|
-
information.
|
62326
|
+
- description: 'Search or send events for DORA Metrics to measure and improve your
|
62327
|
+
software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/)
|
62328
|
+
for more information.
|
62329
|
+
|
62330
|
+
|
62331
|
+
**Note**: DORA Metrics are not available in the US1-FED site.'
|
60644
62332
|
name: DORA Metrics
|
60645
62333
|
- description: 'Interact with your dashboard lists through the API to
|
60646
62334
|
|
@@ -60815,6 +62503,12 @@ tags:
|
|
60815
62503
|
externalDocs:
|
60816
62504
|
url: https://docs.datadoghq.com/service_management/on-call/
|
60817
62505
|
name: On-Call
|
62506
|
+
- description: 'Trigger and manage [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/)
|
62507
|
+
|
62508
|
+
pages directly through the Datadog API.'
|
62509
|
+
externalDocs:
|
62510
|
+
url: https://docs.datadoghq.com/service_management/on-call/
|
62511
|
+
name: On-Call Paging
|
60818
62512
|
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
60819
62513
|
|
60820
62514
|
directly through the Datadog API.'
|