datadog_api_client 2.45.0 → 2.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.generator/schemas/v1/openapi.yaml +81 -0
- data/.generator/schemas/v2/openapi.yaml +3968 -94
- data/.pre-commit-config.yaml +4 -0
- data/CHANGELOG.md +20 -0
- data/examples/v1/monitors/CreateMonitor_3541766733.rb +32 -0
- data/examples/v2/deployment-gates/CreateDeploymentGate.rb +20 -0
- data/examples/v2/deployment-gates/CreateDeploymentRule.rb +25 -0
- data/examples/v2/deployment-gates/DeleteDeploymentGate.rb +11 -0
- data/examples/v2/deployment-gates/DeleteDeploymentRule.rb +14 -0
- data/examples/v2/deployment-gates/GetDeploymentGate.rb +11 -0
- data/examples/v2/deployment-gates/GetDeploymentRule.rb +14 -0
- data/examples/v2/deployment-gates/UpdateDeploymentGate.rb +21 -0
- data/examples/v2/deployment-gates/UpdateDeploymentRule.rb +27 -0
- data/examples/v2/fleet-automation/GetFleetAgentInfo.rb +8 -0
- data/examples/v2/fleet-automation/ListFleetAgents.rb +8 -0
- data/examples/v2/logs-restriction-queries/AddRoleToRestrictionQuery.rb +21 -0
- data/examples/v2/logs-restriction-queries/CreateRestrictionQuery.rb +17 -0
- data/examples/v2/logs-restriction-queries/DeleteRestrictionQuery.rb +11 -0
- data/examples/v2/logs-restriction-queries/GetRestrictionQuery.rb +11 -0
- data/examples/v2/logs-restriction-queries/GetRoleRestrictionQuery.rb +11 -0
- data/examples/v2/logs-restriction-queries/ListRestrictionQueries.rb +8 -0
- data/examples/v2/logs-restriction-queries/ListRestrictionQueryRoles.rb +11 -0
- data/examples/v2/logs-restriction-queries/ListUserRestrictionQueries.rb +11 -0
- data/examples/v2/logs-restriction-queries/RemoveRoleFromRestrictionQuery.rb +21 -0
- data/examples/v2/logs-restriction-queries/ReplaceRestrictionQuery.rb +20 -0
- data/examples/v2/logs-restriction-queries/UpdateRestrictionQuery.rb +20 -0
- data/examples/v2/monitors/CreateMonitorNotificationRule_1379932371.rb +21 -0
- data/examples/v2/monitors/UpdateMonitorNotificationRule_1446058210.rb +24 -0
- data/examples/v2/on-call/CreateOnCallEscalationPolicy.rb +9 -0
- data/examples/v2/on-call/GetScheduleOnCallUser.rb +1 -1
- data/examples/v2/reference-tables/CreateReferenceTable.rb +23 -14
- data/examples/v2/reference-tables/DeleteRows.rb +14 -0
- data/examples/v2/reference-tables/UpsertRows.rb +19 -0
- data/examples/v2/security-monitoring/AttachCase.rb +26 -0
- data/examples/v2/security-monitoring/AttachCase_897782765.rb +22 -0
- data/examples/v2/security-monitoring/AttachJiraIssue.rb +34 -0
- data/examples/v2/security-monitoring/AttachJiraIssue_3042842144.rb +30 -0
- data/examples/v2/security-monitoring/CreateCases.rb +56 -0
- data/examples/v2/security-monitoring/CreateCases_2385516013.rb +33 -0
- data/examples/v2/security-monitoring/CreateCases_2798851680.rb +37 -0
- data/examples/v2/security-monitoring/CreateJiraIssues.rb +96 -0
- data/examples/v2/security-monitoring/CreateJiraIssues_379590688.rb +56 -0
- data/examples/v2/security-monitoring/CreateJiraIssues_829823123.rb +64 -0
- data/examples/v2/security-monitoring/DetachCase.rb +21 -0
- data/examples/v2/teams/AddTeamHierarchyLink.rb +31 -0
- data/examples/v2/{team-connections → teams}/CreateTeamConnections.rb +1 -1
- data/examples/v2/{team-connections → teams}/DeleteTeamConnections.rb +1 -1
- data/examples/v2/teams/GetTeamHierarchyLink.rb +8 -0
- data/examples/v2/teams/GetTeamSync.rb +8 -0
- data/examples/v2/{team-connections → teams}/ListTeamConnections.rb +1 -1
- data/examples/v2/{team-connections → teams}/ListTeamConnections_1473516764.rb +1 -1
- data/examples/v2/{team-connections → teams}/ListTeamConnections_2418873869.rb +1 -1
- data/examples/v2/teams/ListTeamHierarchyLinks.rb +15 -0
- data/examples/v2/teams/ListTeamHierarchyLinks_3360757486.rb +5 -0
- data/examples/v2/teams/RemoveTeamHierarchyLink.rb +8 -0
- data/lib/datadog_api_client/configuration.rb +25 -3
- data/lib/datadog_api_client/inflector.rb +141 -3
- data/lib/datadog_api_client/v1/api/monitors_api.rb +2 -0
- data/lib/datadog_api_client/v1/models/monitor.rb +13 -1
- data/lib/datadog_api_client/v1/models/monitor_asset.rb +186 -0
- data/lib/datadog_api_client/v1/models/monitor_asset_category.rb +26 -0
- data/lib/datadog_api_client/v1/models/monitor_asset_resource_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/monitor_update_request.rb +14 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +11 -1
- data/lib/datadog_api_client/v2/api/deployment_gates_api.rb +632 -0
- data/lib/datadog_api_client/v2/api/fleet_automation_api.rb +166 -1
- data/lib/datadog_api_client/v2/api/logs_restriction_queries_api.rb +842 -0
- data/lib/datadog_api_client/v2/api/on_call_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/reference_tables_api.rb +144 -0
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +355 -5
- data/lib/datadog_api_client/v2/api/teams_api.rb +628 -1
- data/lib/datadog_api_client/v2/models/attach_case_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/attach_case_request_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/attach_case_request_data_relationships.rb +123 -0
- data/lib/datadog_api_client/v2/models/attach_jira_issue_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/attach_jira_issue_request_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/attach_jira_issue_request_data_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/attach_jira_issue_request_data_relationships.rb +144 -0
- data/lib/datadog_api_client/v2/models/batch_delete_rows_request_array.rb +129 -0
- data/lib/datadog_api_client/v2/models/batch_delete_rows_request_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/batch_upsert_rows_request_array.rb +129 -0
- data/lib/datadog_api_client/v2/models/batch_upsert_rows_request_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/batch_upsert_rows_request_data_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/case_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/case_insights_items.rb +125 -0
- data/lib/datadog_api_client/v2/models/case_management_project.rb +123 -0
- data/lib/datadog_api_client/v2/models/case_management_project_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/case_management_project_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/configured_schedule.rb +186 -0
- data/lib/datadog_api_client/v2/models/configured_schedule_target.rb +144 -0
- data/lib/datadog_api_client/v2/models/configured_schedule_target_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/configured_schedule_target_relationships.rb +123 -0
- data/lib/datadog_api_client/v2/models/configured_schedule_target_relationships_schedule.rb +123 -0
- data/lib/datadog_api_client/v2/models/configured_schedule_target_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/create_case_request_array.rb +125 -0
- data/lib/datadog_api_client/v2/models/create_case_request_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/create_case_request_data_attributes.rb +135 -0
- data/lib/datadog_api_client/v2/models/create_case_request_data_relationships.rb +144 -0
- data/lib/datadog_api_client/v2/models/create_deployment_gate_params.rb +123 -0
- data/lib/datadog_api_client/v2/models/create_deployment_gate_params_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/create_deployment_gate_params_data_attributes.rb +164 -0
- data/lib/datadog_api_client/v2/models/create_deployment_rule_params.rb +105 -0
- data/lib/datadog_api_client/v2/models/create_deployment_rule_params_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/create_deployment_rule_params_data_attributes.rb +175 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_array.rb +137 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_array_included.rb +64 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_data_attributes.rb +105 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_data_attributes_fields.rb +105 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_data_relationships.rb +123 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_data_relationships_case.rb +123 -0
- data/lib/datadog_api_client/v2/models/create_jira_issue_request_data_relationships_case_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/deployment_gate_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/deployment_gate_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/deployment_gate_response_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/deployment_gate_response_data_attributes.rb +248 -0
- data/lib/datadog_api_client/v2/models/deployment_gate_response_data_attributes_created_by.rb +143 -0
- data/lib/datadog_api_client/v2/models/deployment_gate_response_data_attributes_updated_by.rb +143 -0
- data/lib/datadog_api_client/v2/models/deployment_rule_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/{table_result_v2_data_attributes_file_metadata_local_file.rb → deployment_rule_options_faulty_deployment_detection.rb} +21 -19
- data/lib/datadog_api_client/v2/models/deployment_rule_options_monitor.rb +108 -0
- data/lib/datadog_api_client/v2/models/deployment_rule_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/deployment_rule_response_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/deployment_rule_response_data_attributes.rb +269 -0
- data/lib/datadog_api_client/v2/models/deployment_rule_response_data_attributes_created_by.rb +143 -0
- data/lib/datadog_api_client/v2/models/deployment_rule_response_data_attributes_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/deployment_rule_response_data_attributes_updated_by.rb +143 -0
- data/lib/datadog_api_client/v2/models/deployment_rules_options.rb +63 -0
- data/lib/datadog_api_client/v2/models/detach_case_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/detach_case_request_data.rb +143 -0
- data/lib/datadog_api_client/v2/models/detach_case_request_data_relationships.rb +123 -0
- data/lib/datadog_api_client/v2/models/escalation_policy_create_request_data_attributes.rb +28 -1
- data/lib/datadog_api_client/v2/models/escalation_policy_create_request_data_attributes_steps_items.rb +16 -1
- data/lib/datadog_api_client/v2/models/escalation_policy_data_attributes.rb +20 -1
- data/lib/datadog_api_client/v2/models/escalation_policy_included.rb +3 -2
- data/lib/datadog_api_client/v2/models/escalation_policy_step_target.rb +12 -2
- data/lib/datadog_api_client/v2/models/escalation_policy_step_target_config.rb +105 -0
- data/lib/datadog_api_client/v2/models/escalation_policy_step_target_config_schedule.rb +105 -0
- data/lib/datadog_api_client/v2/models/escalation_policy_update_request_data_attributes.rb +28 -1
- data/lib/datadog_api_client/v2/models/escalation_policy_update_request_data_attributes_steps_items.rb +16 -1
- data/lib/datadog_api_client/v2/models/escalation_target.rb +3 -2
- data/lib/datadog_api_client/v2/models/finding_case_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/finding_case_response_array.rb +125 -0
- data/lib/datadog_api_client/v2/models/finding_case_response_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/finding_case_response_data_attributes.rb +277 -0
- data/lib/datadog_api_client/v2/models/finding_case_response_data_relationships.rb +125 -0
- data/lib/datadog_api_client/v2/models/finding_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/finding_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/finding_jira_issue.rb +125 -0
- data/lib/datadog_api_client/v2/models/finding_jira_issue_result.rb +135 -0
- data/lib/datadog_api_client/v2/models/findings.rb +107 -0
- data/lib/datadog_api_client/v2/models/fleet_agent_attributes.rb +327 -0
- data/lib/datadog_api_client/v2/models/fleet_agent_attributes_tags_items.rb +115 -0
- data/lib/datadog_api_client/v2/models/fleet_agent_info.rb +165 -0
- data/lib/datadog_api_client/v2/models/fleet_agent_info_attributes.rb +137 -0
- data/lib/datadog_api_client/v2/models/fleet_agent_info_details.rb +403 -0
- data/lib/datadog_api_client/v2/models/fleet_agent_info_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/fleet_agent_info_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/fleet_agents_response.rb +133 -0
- data/lib/datadog_api_client/v2/models/fleet_agents_response_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/fleet_agents_response_data_attributes.rb +107 -0
- data/lib/datadog_api_client/v2/models/fleet_agents_response_meta.rb +105 -0
- data/lib/datadog_api_client/v2/models/fleet_configuration_file.rb +125 -0
- data/lib/datadog_api_client/v2/models/fleet_configuration_layer.rb +155 -0
- data/lib/datadog_api_client/v2/models/fleet_detected_integration.rb +115 -0
- data/lib/datadog_api_client/v2/models/fleet_integration_details.rb +197 -0
- data/lib/datadog_api_client/v2/models/fleet_integrations_by_status.rb +165 -0
- data/lib/datadog_api_client/v2/models/httpcd_gates_bad_request_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/httpcd_gates_not_found_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/httpcd_rules_not_found_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/jira_issues_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/layer_attributes.rb +13 -3
- data/lib/datadog_api_client/v2/models/logs_restriction_queries_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/monitor_notification_rule_attributes.rb +2 -2
- data/lib/datadog_api_client/v2/models/monitor_notification_rule_condition.rb +1 -1
- data/lib/datadog_api_client/v2/models/monitor_notification_rule_conditional_recipients.rb +2 -2
- data/lib/datadog_api_client/v2/models/monitor_notification_rule_filter.rb +2 -1
- data/lib/datadog_api_client/v2/models/monitor_notification_rule_filter_scope.rb +106 -0
- data/lib/datadog_api_client/v2/models/monitor_notification_rule_filter_tags.rb +2 -2
- data/lib/datadog_api_client/v2/models/monitor_notification_rule_response_attributes.rb +2 -2
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_chronicle_destination.rb +1 -12
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_cloud_storage_destination.rb +2 -24
- data/lib/datadog_api_client/v2/models/observability_pipeline_google_pub_sub_source.rb +1 -12
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_permission.rb +8 -0
- data/lib/datadog_api_client/v2/models/restriction_query_attributes.rb +165 -0
- data/lib/datadog_api_client/v2/models/restriction_query_create_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/restriction_query_create_data.rb +115 -0
- data/lib/datadog_api_client/v2/models/restriction_query_create_payload.rb +105 -0
- data/lib/datadog_api_client/v2/models/restriction_query_list_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/restriction_query_response_included_item.rb +62 -0
- data/lib/datadog_api_client/v2/models/restriction_query_role.rb +165 -0
- data/lib/datadog_api_client/v2/models/restriction_query_role_attribute.rb +105 -0
- data/lib/datadog_api_client/v2/models/restriction_query_roles_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/restriction_query_update_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/restriction_query_update_data.rb +115 -0
- data/lib/datadog_api_client/v2/models/restriction_query_update_payload.rb +105 -0
- data/lib/datadog_api_client/v2/models/restriction_query_with_relationships.rb +135 -0
- data/lib/datadog_api_client/v2/models/restriction_query_with_relationships_response.rb +117 -0
- data/lib/datadog_api_client/v2/models/restriction_query_without_relationships.rb +125 -0
- data/lib/datadog_api_client/v2/models/restriction_query_without_relationships_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items.rb +13 -3
- data/lib/datadog_api_client/v2/models/schedule_target.rb +1 -1
- data/lib/datadog_api_client/v2/models/schedule_target_position.rb +28 -0
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items.rb +13 -3
- data/lib/datadog_api_client/v2/models/table_result_v2_data_attributes.rb +8 -0
- data/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata.rb +101 -36
- data/lib/datadog_api_client/v2/models/team_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/team_hierarchy_link.rb +175 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_attributes.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_create.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_create_relationships.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_create_team.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_create_team_relationship.rb +123 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_relationships.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_response.rb +127 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_team.rb +154 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_team_attributes.rb +223 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_team_relationship.rb +123 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_link_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_hierarchy_links_response.rb +139 -0
- data/lib/datadog_api_client/v2/models/team_sync_attributes.rb +22 -2
- data/lib/datadog_api_client/v2/models/team_sync_attributes_frequency.rb +28 -0
- data/lib/datadog_api_client/v2/models/team_sync_attributes_type.rb +2 -1
- data/lib/datadog_api_client/v2/models/team_sync_data.rb +12 -2
- data/lib/datadog_api_client/v2/models/team_sync_request.rb +1 -1
- data/lib/datadog_api_client/v2/models/team_sync_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/teams_hierarchy_links_response_links.rb +156 -0
- data/lib/datadog_api_client/v2/models/teams_hierarchy_links_response_meta.rb +105 -0
- data/lib/datadog_api_client/v2/models/teams_hierarchy_links_response_meta_page.rb +184 -0
- data/lib/datadog_api_client/v2/models/threat_hunting_job_response_attributes.rb +13 -3
- data/lib/datadog_api_client/v2/models/update_deployment_gate_params.rb +123 -0
- data/lib/datadog_api_client/v2/models/update_deployment_gate_params_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/update_deployment_gate_params_data_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/update_deployment_rule_params.rb +123 -0
- data/lib/datadog_api_client/v2/models/update_deployment_rule_params_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/update_deployment_rule_params_data_attributes.rb +165 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +190 -9
- data/lib/datadog_api_client/v2/api/team_connections_api.rb +0 -272
- data/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_cloud_storage.rb +0 -138
|
@@ -945,6 +945,27 @@ components:
|
|
|
945
945
|
required: true
|
|
946
946
|
schema:
|
|
947
947
|
type: string
|
|
948
|
+
RestrictionQueryID:
|
|
949
|
+
description: The ID of the restriction query.
|
|
950
|
+
in: path
|
|
951
|
+
name: restriction_query_id
|
|
952
|
+
required: true
|
|
953
|
+
schema:
|
|
954
|
+
type: string
|
|
955
|
+
RestrictionQueryRoleID:
|
|
956
|
+
description: The ID of the role.
|
|
957
|
+
in: path
|
|
958
|
+
name: role_id
|
|
959
|
+
required: true
|
|
960
|
+
schema:
|
|
961
|
+
type: string
|
|
962
|
+
RestrictionQueryUserID:
|
|
963
|
+
description: The ID of the user.
|
|
964
|
+
in: path
|
|
965
|
+
name: user_id
|
|
966
|
+
required: true
|
|
967
|
+
schema:
|
|
968
|
+
type: string
|
|
948
969
|
RetentionFilterIdParam:
|
|
949
970
|
description: The ID of the retention filter.
|
|
950
971
|
in: path
|
|
@@ -1158,6 +1179,24 @@ components:
|
|
|
1158
1179
|
schema:
|
|
1159
1180
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
1160
1181
|
description: Forbidden
|
|
1182
|
+
HTTPCDGatesBadRequestResponse:
|
|
1183
|
+
content:
|
|
1184
|
+
application/json:
|
|
1185
|
+
schema:
|
|
1186
|
+
$ref: '#/components/schemas/HTTPCDGatesBadRequestResponse'
|
|
1187
|
+
description: Bad request.
|
|
1188
|
+
HTTPCDGatesNotFoundResponse:
|
|
1189
|
+
content:
|
|
1190
|
+
application/json:
|
|
1191
|
+
schema:
|
|
1192
|
+
$ref: '#/components/schemas/HTTPCDGatesNotFoundResponse'
|
|
1193
|
+
description: Deployment gate not found.
|
|
1194
|
+
HTTPCDRulesNotFoundResponse:
|
|
1195
|
+
content:
|
|
1196
|
+
application/json:
|
|
1197
|
+
schema:
|
|
1198
|
+
$ref: '#/components/schemas/HTTPCDRulesNotFoundResponse'
|
|
1199
|
+
description: Deployment rule not found.
|
|
1161
1200
|
NotAuthorizedResponse:
|
|
1162
1201
|
content:
|
|
1163
1202
|
application/json:
|
|
@@ -5231,6 +5270,79 @@ components:
|
|
|
5231
5270
|
example: _latest
|
|
5232
5271
|
type: string
|
|
5233
5272
|
type: object
|
|
5273
|
+
AttachCaseRequest:
|
|
5274
|
+
description: Request for attaching security findings to a case.
|
|
5275
|
+
properties:
|
|
5276
|
+
data:
|
|
5277
|
+
$ref: '#/components/schemas/AttachCaseRequestData'
|
|
5278
|
+
type: object
|
|
5279
|
+
AttachCaseRequestData:
|
|
5280
|
+
description: Data of the case to attach security findings to.
|
|
5281
|
+
properties:
|
|
5282
|
+
id:
|
|
5283
|
+
description: The unique identifier of the case.
|
|
5284
|
+
example: c1234567-89ab-cdef-0123-456789abcdef
|
|
5285
|
+
type: string
|
|
5286
|
+
relationships:
|
|
5287
|
+
$ref: '#/components/schemas/AttachCaseRequestDataRelationships'
|
|
5288
|
+
type:
|
|
5289
|
+
$ref: '#/components/schemas/CaseDataType'
|
|
5290
|
+
required:
|
|
5291
|
+
- type
|
|
5292
|
+
- id
|
|
5293
|
+
type: object
|
|
5294
|
+
AttachCaseRequestDataRelationships:
|
|
5295
|
+
description: Relationships of the case to attach security findings to.
|
|
5296
|
+
properties:
|
|
5297
|
+
findings:
|
|
5298
|
+
$ref: '#/components/schemas/Findings'
|
|
5299
|
+
description: Security findings to attach to the case.
|
|
5300
|
+
required:
|
|
5301
|
+
- findings
|
|
5302
|
+
type: object
|
|
5303
|
+
AttachJiraIssueRequest:
|
|
5304
|
+
description: Request for attaching security findings to a Jira issue.
|
|
5305
|
+
properties:
|
|
5306
|
+
data:
|
|
5307
|
+
$ref: '#/components/schemas/AttachJiraIssueRequestData'
|
|
5308
|
+
type: object
|
|
5309
|
+
AttachJiraIssueRequestData:
|
|
5310
|
+
description: Data of the Jira issue to attach security findings to.
|
|
5311
|
+
properties:
|
|
5312
|
+
attributes:
|
|
5313
|
+
$ref: '#/components/schemas/AttachJiraIssueRequestDataAttributes'
|
|
5314
|
+
id:
|
|
5315
|
+
description: The unique identifier of the Jira issue attachment request.
|
|
5316
|
+
example: j1234567-89ab-cdef-0123-456789abcdef
|
|
5317
|
+
type: string
|
|
5318
|
+
relationships:
|
|
5319
|
+
$ref: '#/components/schemas/AttachJiraIssueRequestDataRelationships'
|
|
5320
|
+
type:
|
|
5321
|
+
$ref: '#/components/schemas/JiraIssuesDataType'
|
|
5322
|
+
required:
|
|
5323
|
+
- type
|
|
5324
|
+
type: object
|
|
5325
|
+
AttachJiraIssueRequestDataAttributes:
|
|
5326
|
+
description: Attributes of the Jira issue to attach security findings to.
|
|
5327
|
+
properties:
|
|
5328
|
+
jira_issue_url:
|
|
5329
|
+
description: The URL of the Jira issue to attach security findings to.
|
|
5330
|
+
example: https://domain.atlassian.net/browse/PROJ-123
|
|
5331
|
+
type: string
|
|
5332
|
+
required:
|
|
5333
|
+
- jira_issue_url
|
|
5334
|
+
type: object
|
|
5335
|
+
AttachJiraIssueRequestDataRelationships:
|
|
5336
|
+
description: Relationships of the Jira issue to attach security findings to.
|
|
5337
|
+
properties:
|
|
5338
|
+
findings:
|
|
5339
|
+
$ref: '#/components/schemas/Findings'
|
|
5340
|
+
project:
|
|
5341
|
+
$ref: '#/components/schemas/CaseManagementProject'
|
|
5342
|
+
required:
|
|
5343
|
+
- findings
|
|
5344
|
+
- project
|
|
5345
|
+
type: object
|
|
5234
5346
|
AuditLogsEvent:
|
|
5235
5347
|
description: Object description of an Audit Logs event after it is processed
|
|
5236
5348
|
and stored by Datadog.
|
|
@@ -6788,6 +6900,72 @@ components:
|
|
|
6788
6900
|
required:
|
|
6789
6901
|
- data
|
|
6790
6902
|
type: object
|
|
6903
|
+
BatchDeleteRowsRequestArray:
|
|
6904
|
+
description: The request body for deleting multiple rows from a reference table.
|
|
6905
|
+
properties:
|
|
6906
|
+
data:
|
|
6907
|
+
items:
|
|
6908
|
+
$ref: '#/components/schemas/BatchDeleteRowsRequestData'
|
|
6909
|
+
maxItems: 200
|
|
6910
|
+
type: array
|
|
6911
|
+
required:
|
|
6912
|
+
- data
|
|
6913
|
+
type: object
|
|
6914
|
+
BatchDeleteRowsRequestData:
|
|
6915
|
+
description: Row resource containing a single row identifier for deletion.
|
|
6916
|
+
properties:
|
|
6917
|
+
id:
|
|
6918
|
+
example: primary_key_value
|
|
6919
|
+
type: string
|
|
6920
|
+
type:
|
|
6921
|
+
$ref: '#/components/schemas/TableRowResourceDataType'
|
|
6922
|
+
required:
|
|
6923
|
+
- type
|
|
6924
|
+
- id
|
|
6925
|
+
type: object
|
|
6926
|
+
BatchUpsertRowsRequestArray:
|
|
6927
|
+
description: The request body for creating or updating multiple rows into a
|
|
6928
|
+
reference table.
|
|
6929
|
+
properties:
|
|
6930
|
+
data:
|
|
6931
|
+
items:
|
|
6932
|
+
$ref: '#/components/schemas/BatchUpsertRowsRequestData'
|
|
6933
|
+
maxItems: 200
|
|
6934
|
+
type: array
|
|
6935
|
+
required:
|
|
6936
|
+
- data
|
|
6937
|
+
type: object
|
|
6938
|
+
BatchUpsertRowsRequestData:
|
|
6939
|
+
description: Row resource containing a single row identifier and its column
|
|
6940
|
+
values.
|
|
6941
|
+
properties:
|
|
6942
|
+
attributes:
|
|
6943
|
+
$ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributes'
|
|
6944
|
+
id:
|
|
6945
|
+
example: primary_key_value
|
|
6946
|
+
type: string
|
|
6947
|
+
type:
|
|
6948
|
+
$ref: '#/components/schemas/TableRowResourceDataType'
|
|
6949
|
+
required:
|
|
6950
|
+
- type
|
|
6951
|
+
- id
|
|
6952
|
+
type: object
|
|
6953
|
+
BatchUpsertRowsRequestDataAttributes:
|
|
6954
|
+
description: Attributes containing row data values for row creation or update
|
|
6955
|
+
operations.
|
|
6956
|
+
properties:
|
|
6957
|
+
values:
|
|
6958
|
+
additionalProperties:
|
|
6959
|
+
x-required-field: true
|
|
6960
|
+
description: Key-value pairs representing row data, where keys are field
|
|
6961
|
+
names from the schema.
|
|
6962
|
+
example:
|
|
6963
|
+
example_key_value: primary_key_value
|
|
6964
|
+
name: row_name
|
|
6965
|
+
type: object
|
|
6966
|
+
required:
|
|
6967
|
+
- values
|
|
6968
|
+
type: object
|
|
6791
6969
|
BillConfig:
|
|
6792
6970
|
description: Bill config.
|
|
6793
6971
|
properties:
|
|
@@ -8903,6 +9081,15 @@ components:
|
|
|
8903
9081
|
required:
|
|
8904
9082
|
- data
|
|
8905
9083
|
type: object
|
|
9084
|
+
CaseDataType:
|
|
9085
|
+
default: cases
|
|
9086
|
+
description: Cases resource type.
|
|
9087
|
+
enum:
|
|
9088
|
+
- cases
|
|
9089
|
+
example: cases
|
|
9090
|
+
type: string
|
|
9091
|
+
x-enum-varnames:
|
|
9092
|
+
- CASES
|
|
8906
9093
|
CaseEmpty:
|
|
8907
9094
|
description: Case empty request data
|
|
8908
9095
|
properties:
|
|
@@ -8919,6 +9106,53 @@ components:
|
|
|
8919
9106
|
required:
|
|
8920
9107
|
- data
|
|
8921
9108
|
type: object
|
|
9109
|
+
CaseInsightsItems:
|
|
9110
|
+
description: An insight of the case.
|
|
9111
|
+
properties:
|
|
9112
|
+
ref:
|
|
9113
|
+
description: The reference of the insight.
|
|
9114
|
+
example: /security/appsec/vm/library/vulnerability/dfa027f7c037b2f77159adc027fecb56?detection=static
|
|
9115
|
+
type: string
|
|
9116
|
+
resource_id:
|
|
9117
|
+
description: The unique identifier of the resource. For example, the unique
|
|
9118
|
+
identifier of a security finding.
|
|
9119
|
+
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
|
9120
|
+
type: string
|
|
9121
|
+
type:
|
|
9122
|
+
description: The type of the resource. For example, the type of a security
|
|
9123
|
+
finding is "SECURITY_FINDING".
|
|
9124
|
+
example: SECURITY_FINDING
|
|
9125
|
+
type: string
|
|
9126
|
+
type: object
|
|
9127
|
+
CaseManagementProject:
|
|
9128
|
+
description: Case management project.
|
|
9129
|
+
properties:
|
|
9130
|
+
data:
|
|
9131
|
+
$ref: '#/components/schemas/CaseManagementProjectData'
|
|
9132
|
+
required:
|
|
9133
|
+
- data
|
|
9134
|
+
type: object
|
|
9135
|
+
CaseManagementProjectData:
|
|
9136
|
+
properties:
|
|
9137
|
+
id:
|
|
9138
|
+
description: The unique identifier of the case management project.
|
|
9139
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
9140
|
+
type: string
|
|
9141
|
+
type:
|
|
9142
|
+
$ref: '#/components/schemas/CaseManagementProjectDataType'
|
|
9143
|
+
required:
|
|
9144
|
+
- type
|
|
9145
|
+
- id
|
|
9146
|
+
type: object
|
|
9147
|
+
CaseManagementProjectDataType:
|
|
9148
|
+
default: projects
|
|
9149
|
+
description: Projects resource type.
|
|
9150
|
+
enum:
|
|
9151
|
+
- projects
|
|
9152
|
+
example: projects
|
|
9153
|
+
type: string
|
|
9154
|
+
x-enum-varnames:
|
|
9155
|
+
- PROJECTS
|
|
8922
9156
|
CaseObjectAttributes:
|
|
8923
9157
|
additionalProperties:
|
|
8924
9158
|
items:
|
|
@@ -11209,6 +11443,76 @@ components:
|
|
|
11209
11443
|
required:
|
|
11210
11444
|
- type
|
|
11211
11445
|
type: object
|
|
11446
|
+
ConfiguredSchedule:
|
|
11447
|
+
description: Full resource representation of a configured schedule target with
|
|
11448
|
+
position (previous, current, or next).
|
|
11449
|
+
properties:
|
|
11450
|
+
attributes:
|
|
11451
|
+
$ref: '#/components/schemas/ConfiguredScheduleTargetAttributes'
|
|
11452
|
+
id:
|
|
11453
|
+
description: Specifies the unique identifier of the configured schedule
|
|
11454
|
+
target.
|
|
11455
|
+
example: 00000000-aba1-0000-0000-000000000000_previous
|
|
11456
|
+
type: string
|
|
11457
|
+
relationships:
|
|
11458
|
+
$ref: '#/components/schemas/ConfiguredScheduleTargetRelationships'
|
|
11459
|
+
type:
|
|
11460
|
+
$ref: '#/components/schemas/ConfiguredScheduleTargetType'
|
|
11461
|
+
required:
|
|
11462
|
+
- type
|
|
11463
|
+
- id
|
|
11464
|
+
- attributes
|
|
11465
|
+
- relationships
|
|
11466
|
+
type: object
|
|
11467
|
+
ConfiguredScheduleTarget:
|
|
11468
|
+
description: Relationship reference to a configured schedule target.
|
|
11469
|
+
properties:
|
|
11470
|
+
id:
|
|
11471
|
+
description: Specifies the unique identifier of the configured schedule
|
|
11472
|
+
target.
|
|
11473
|
+
example: 00000000-aba1-0000-0000-000000000000_previous
|
|
11474
|
+
type: string
|
|
11475
|
+
type:
|
|
11476
|
+
$ref: '#/components/schemas/ConfiguredScheduleTargetType'
|
|
11477
|
+
required:
|
|
11478
|
+
- type
|
|
11479
|
+
- id
|
|
11480
|
+
type: object
|
|
11481
|
+
ConfiguredScheduleTargetAttributes:
|
|
11482
|
+
description: Attributes for a configured schedule target, including position.
|
|
11483
|
+
example:
|
|
11484
|
+
position: previous
|
|
11485
|
+
properties:
|
|
11486
|
+
position:
|
|
11487
|
+
$ref: '#/components/schemas/ScheduleTargetPosition'
|
|
11488
|
+
required:
|
|
11489
|
+
- position
|
|
11490
|
+
type: object
|
|
11491
|
+
ConfiguredScheduleTargetRelationships:
|
|
11492
|
+
description: Represents the relationships of a configured schedule target.
|
|
11493
|
+
properties:
|
|
11494
|
+
schedule:
|
|
11495
|
+
$ref: '#/components/schemas/ConfiguredScheduleTargetRelationshipsSchedule'
|
|
11496
|
+
required:
|
|
11497
|
+
- schedule
|
|
11498
|
+
type: object
|
|
11499
|
+
ConfiguredScheduleTargetRelationshipsSchedule:
|
|
11500
|
+
description: Holds the schedule reference for a configured schedule target.
|
|
11501
|
+
properties:
|
|
11502
|
+
data:
|
|
11503
|
+
$ref: '#/components/schemas/ScheduleTarget'
|
|
11504
|
+
required:
|
|
11505
|
+
- data
|
|
11506
|
+
type: object
|
|
11507
|
+
ConfiguredScheduleTargetType:
|
|
11508
|
+
default: schedule_target
|
|
11509
|
+
description: Indicates that the resource is of type `schedule_target`.
|
|
11510
|
+
enum:
|
|
11511
|
+
- schedule_target
|
|
11512
|
+
example: schedule_target
|
|
11513
|
+
type: string
|
|
11514
|
+
x-enum-varnames:
|
|
11515
|
+
- SCHEDULE_TARGET
|
|
11212
11516
|
ConfluentAccountCreateRequest:
|
|
11213
11517
|
description: Payload schema when adding a Confluent account.
|
|
11214
11518
|
properties:
|
|
@@ -12563,6 +12867,68 @@ components:
|
|
|
12563
12867
|
required:
|
|
12564
12868
|
- type
|
|
12565
12869
|
type: object
|
|
12870
|
+
CreateCaseRequestArray:
|
|
12871
|
+
description: List of requests to create cases for security findings.
|
|
12872
|
+
properties:
|
|
12873
|
+
data:
|
|
12874
|
+
items:
|
|
12875
|
+
$ref: '#/components/schemas/CreateCaseRequestData'
|
|
12876
|
+
type: array
|
|
12877
|
+
required:
|
|
12878
|
+
- data
|
|
12879
|
+
type: object
|
|
12880
|
+
CreateCaseRequestData:
|
|
12881
|
+
description: Data of the case to create.
|
|
12882
|
+
properties:
|
|
12883
|
+
attributes:
|
|
12884
|
+
$ref: '#/components/schemas/CreateCaseRequestDataAttributes'
|
|
12885
|
+
id:
|
|
12886
|
+
description: The unique identifier of the case.
|
|
12887
|
+
example: c1234567-89ab-cdef-0123-456789abcdef
|
|
12888
|
+
type: string
|
|
12889
|
+
relationships:
|
|
12890
|
+
$ref: '#/components/schemas/CreateCaseRequestDataRelationships'
|
|
12891
|
+
type:
|
|
12892
|
+
$ref: '#/components/schemas/CaseDataType'
|
|
12893
|
+
required:
|
|
12894
|
+
- type
|
|
12895
|
+
type: object
|
|
12896
|
+
CreateCaseRequestDataAttributes:
|
|
12897
|
+
description: Attributes of the case to create.
|
|
12898
|
+
properties:
|
|
12899
|
+
assignee_id:
|
|
12900
|
+
description: The unique identifier of the user assigned to the case.
|
|
12901
|
+
example: f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0
|
|
12902
|
+
type: string
|
|
12903
|
+
description:
|
|
12904
|
+
description: The description of the case. If not provided, the description
|
|
12905
|
+
will be automatically generated.
|
|
12906
|
+
example: A description of the case.
|
|
12907
|
+
type: string
|
|
12908
|
+
priority:
|
|
12909
|
+
$ref: '#/components/schemas/CasePriority'
|
|
12910
|
+
description: The priority of the case. If not provided, the priority will
|
|
12911
|
+
be automatically set to "NOT_DEFINED".
|
|
12912
|
+
example: P4
|
|
12913
|
+
title:
|
|
12914
|
+
description: The title of the case. If not provided, the title will be automatically
|
|
12915
|
+
generated.
|
|
12916
|
+
example: A title for the case.
|
|
12917
|
+
type: string
|
|
12918
|
+
type: object
|
|
12919
|
+
CreateCaseRequestDataRelationships:
|
|
12920
|
+
description: Relationships of the case to create.
|
|
12921
|
+
properties:
|
|
12922
|
+
findings:
|
|
12923
|
+
$ref: '#/components/schemas/Findings'
|
|
12924
|
+
description: Security findings of the case to create.
|
|
12925
|
+
project:
|
|
12926
|
+
$ref: '#/components/schemas/CaseManagementProject'
|
|
12927
|
+
description: Project of the case to create.
|
|
12928
|
+
required:
|
|
12929
|
+
- findings
|
|
12930
|
+
- project
|
|
12931
|
+
type: object
|
|
12566
12932
|
CreateConnectionRequest:
|
|
12567
12933
|
example:
|
|
12568
12934
|
data:
|
|
@@ -12733,6 +13099,91 @@ components:
|
|
|
12733
13099
|
meta:
|
|
12734
13100
|
$ref: '#/components/schemas/DataDeletionResponseMeta'
|
|
12735
13101
|
type: object
|
|
13102
|
+
CreateDeploymentGateParams:
|
|
13103
|
+
description: Parameters for creating a deployment gate.
|
|
13104
|
+
properties:
|
|
13105
|
+
data:
|
|
13106
|
+
$ref: '#/components/schemas/CreateDeploymentGateParamsData'
|
|
13107
|
+
required:
|
|
13108
|
+
- data
|
|
13109
|
+
type: object
|
|
13110
|
+
CreateDeploymentGateParamsData:
|
|
13111
|
+
description: Parameters for creating a deployment gate.
|
|
13112
|
+
properties:
|
|
13113
|
+
attributes:
|
|
13114
|
+
$ref: '#/components/schemas/CreateDeploymentGateParamsDataAttributes'
|
|
13115
|
+
type:
|
|
13116
|
+
$ref: '#/components/schemas/DeploymentGateDataType'
|
|
13117
|
+
required:
|
|
13118
|
+
- type
|
|
13119
|
+
- attributes
|
|
13120
|
+
type: object
|
|
13121
|
+
CreateDeploymentGateParamsDataAttributes:
|
|
13122
|
+
description: Parameters for creating a deployment gate.
|
|
13123
|
+
properties:
|
|
13124
|
+
dry_run:
|
|
13125
|
+
default: false
|
|
13126
|
+
description: Whether this gate is run in dry-run mode.
|
|
13127
|
+
example: false
|
|
13128
|
+
type: boolean
|
|
13129
|
+
env:
|
|
13130
|
+
description: The environment of the deployment gate.
|
|
13131
|
+
example: production
|
|
13132
|
+
type: string
|
|
13133
|
+
identifier:
|
|
13134
|
+
default: default
|
|
13135
|
+
description: The identifier of the deployment gate.
|
|
13136
|
+
example: pre
|
|
13137
|
+
type: string
|
|
13138
|
+
service:
|
|
13139
|
+
description: The service of the deployment gate.
|
|
13140
|
+
example: my-service
|
|
13141
|
+
type: string
|
|
13142
|
+
required:
|
|
13143
|
+
- env
|
|
13144
|
+
- service
|
|
13145
|
+
type: object
|
|
13146
|
+
CreateDeploymentRuleParams:
|
|
13147
|
+
description: Parameters for creating a deployment rule.
|
|
13148
|
+
properties:
|
|
13149
|
+
data:
|
|
13150
|
+
$ref: '#/components/schemas/CreateDeploymentRuleParamsData'
|
|
13151
|
+
type: object
|
|
13152
|
+
CreateDeploymentRuleParamsData:
|
|
13153
|
+
description: Parameters for creating a deployment rule.
|
|
13154
|
+
properties:
|
|
13155
|
+
attributes:
|
|
13156
|
+
$ref: '#/components/schemas/CreateDeploymentRuleParamsDataAttributes'
|
|
13157
|
+
type:
|
|
13158
|
+
$ref: '#/components/schemas/DeploymentRuleDataType'
|
|
13159
|
+
required:
|
|
13160
|
+
- type
|
|
13161
|
+
- attributes
|
|
13162
|
+
type: object
|
|
13163
|
+
CreateDeploymentRuleParamsDataAttributes:
|
|
13164
|
+
description: Parameters for creating a deployment rule.
|
|
13165
|
+
properties:
|
|
13166
|
+
dry_run:
|
|
13167
|
+
default: false
|
|
13168
|
+
description: Whether this rule is run in dry-run mode.
|
|
13169
|
+
example: false
|
|
13170
|
+
type: boolean
|
|
13171
|
+
name:
|
|
13172
|
+
description: The name of the deployment rule.
|
|
13173
|
+
example: My deployment rule
|
|
13174
|
+
type: string
|
|
13175
|
+
options:
|
|
13176
|
+
$ref: '#/components/schemas/DeploymentRulesOptions'
|
|
13177
|
+
type:
|
|
13178
|
+
description: The type of the deployment rule (faulty_deployment_detection
|
|
13179
|
+
or monitor).
|
|
13180
|
+
example: faulty_deployment_detection
|
|
13181
|
+
type: string
|
|
13182
|
+
required:
|
|
13183
|
+
- name
|
|
13184
|
+
- options
|
|
13185
|
+
- type
|
|
13186
|
+
type: object
|
|
12736
13187
|
CreateIncidentNotificationRuleRequest:
|
|
12737
13188
|
description: Create request for a notification rule.
|
|
12738
13189
|
properties:
|
|
@@ -12749,6 +13200,89 @@ components:
|
|
|
12749
13200
|
required:
|
|
12750
13201
|
- data
|
|
12751
13202
|
type: object
|
|
13203
|
+
CreateJiraIssueRequestArray:
|
|
13204
|
+
description: List of requests to create Jira issues for security findings.
|
|
13205
|
+
properties:
|
|
13206
|
+
data:
|
|
13207
|
+
items:
|
|
13208
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestData'
|
|
13209
|
+
type: array
|
|
13210
|
+
included:
|
|
13211
|
+
items:
|
|
13212
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestArrayIncluded'
|
|
13213
|
+
type: array
|
|
13214
|
+
required:
|
|
13215
|
+
- data
|
|
13216
|
+
type: object
|
|
13217
|
+
CreateJiraIssueRequestArrayIncluded:
|
|
13218
|
+
description: 'Attributes and relationships of the case linked to the Jira issue.
|
|
13219
|
+
Should contain all of the following: case, project, and security findings.'
|
|
13220
|
+
oneOf:
|
|
13221
|
+
- $ref: '#/components/schemas/CreateCaseRequestData'
|
|
13222
|
+
- $ref: '#/components/schemas/CaseManagementProjectData'
|
|
13223
|
+
- $ref: '#/components/schemas/FindingData'
|
|
13224
|
+
CreateJiraIssueRequestData:
|
|
13225
|
+
description: Data of the Jira issue to create.
|
|
13226
|
+
properties:
|
|
13227
|
+
attributes:
|
|
13228
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestDataAttributes'
|
|
13229
|
+
id:
|
|
13230
|
+
description: The unique identifier of the Jira issue creation request.
|
|
13231
|
+
example: j1234567-89ab-cdef-0123-456789abcdef
|
|
13232
|
+
type: string
|
|
13233
|
+
relationships:
|
|
13234
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestDataRelationships'
|
|
13235
|
+
type:
|
|
13236
|
+
$ref: '#/components/schemas/JiraIssuesDataType'
|
|
13237
|
+
required:
|
|
13238
|
+
- type
|
|
13239
|
+
type: object
|
|
13240
|
+
CreateJiraIssueRequestDataAttributes:
|
|
13241
|
+
description: Attributes of the Jira issue to create.
|
|
13242
|
+
properties:
|
|
13243
|
+
fields:
|
|
13244
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestDataAttributesFields'
|
|
13245
|
+
type: object
|
|
13246
|
+
CreateJiraIssueRequestDataAttributesFields:
|
|
13247
|
+
description: Custom fields of the Jira issue to create. For the list of available
|
|
13248
|
+
fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get).
|
|
13249
|
+
properties:
|
|
13250
|
+
fields:
|
|
13251
|
+
example:
|
|
13252
|
+
customfield_10001: Value 1
|
|
13253
|
+
customfield_10002:
|
|
13254
|
+
- Value 2
|
|
13255
|
+
- Value 3
|
|
13256
|
+
type: object
|
|
13257
|
+
type: object
|
|
13258
|
+
CreateJiraIssueRequestDataRelationships:
|
|
13259
|
+
description: Relationships of the Jira issue to create.
|
|
13260
|
+
properties:
|
|
13261
|
+
case:
|
|
13262
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestDataRelationshipsCase'
|
|
13263
|
+
required:
|
|
13264
|
+
- case
|
|
13265
|
+
type: object
|
|
13266
|
+
CreateJiraIssueRequestDataRelationshipsCase:
|
|
13267
|
+
description: Case linked to the Jira issue.
|
|
13268
|
+
properties:
|
|
13269
|
+
data:
|
|
13270
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestDataRelationshipsCaseData'
|
|
13271
|
+
required:
|
|
13272
|
+
- data
|
|
13273
|
+
type: object
|
|
13274
|
+
CreateJiraIssueRequestDataRelationshipsCaseData:
|
|
13275
|
+
description: Case linked to the Jira issue.
|
|
13276
|
+
properties:
|
|
13277
|
+
id:
|
|
13278
|
+
example: c1234567-89ab-cdef-0123-456789abcdef
|
|
13279
|
+
type: string
|
|
13280
|
+
type:
|
|
13281
|
+
$ref: '#/components/schemas/CaseDataType'
|
|
13282
|
+
required:
|
|
13283
|
+
- type
|
|
13284
|
+
- id
|
|
13285
|
+
type: object
|
|
12752
13286
|
CreateNotificationRuleParameters:
|
|
12753
13287
|
description: Body of the notification rule create request.
|
|
12754
13288
|
properties:
|
|
@@ -13142,30 +13676,6 @@ components:
|
|
|
13142
13676
|
CreateTableRequest:
|
|
13143
13677
|
description: Request body for creating a new reference table from a local file
|
|
13144
13678
|
or cloud storage.
|
|
13145
|
-
example:
|
|
13146
|
-
data:
|
|
13147
|
-
attributes:
|
|
13148
|
-
description: this is a cloud table generated via a cloud bucket sync
|
|
13149
|
-
file_metadata:
|
|
13150
|
-
access_details:
|
|
13151
|
-
aws_detail:
|
|
13152
|
-
aws_account_id: test-account-id
|
|
13153
|
-
aws_bucket_name: test-bucket
|
|
13154
|
-
file_path: test_rt.csv
|
|
13155
|
-
sync_enabled: true
|
|
13156
|
-
schema:
|
|
13157
|
-
fields:
|
|
13158
|
-
- name: name
|
|
13159
|
-
type: STRING
|
|
13160
|
-
- name: account_id
|
|
13161
|
-
type: STRING
|
|
13162
|
-
primary_keys:
|
|
13163
|
-
- account_id
|
|
13164
|
-
source: S3
|
|
13165
|
-
table_name: test_reference_table
|
|
13166
|
-
tags:
|
|
13167
|
-
- test_tag
|
|
13168
|
-
type: reference_table
|
|
13169
13679
|
properties:
|
|
13170
13680
|
data:
|
|
13171
13681
|
$ref: '#/components/schemas/CreateTableRequestData'
|
|
@@ -13387,6 +13897,17 @@ components:
|
|
|
13387
13897
|
CreateUploadRequest:
|
|
13388
13898
|
description: Request to create an upload for a file to be ingested into a reference
|
|
13389
13899
|
table.
|
|
13900
|
+
example:
|
|
13901
|
+
data:
|
|
13902
|
+
attributes:
|
|
13903
|
+
headers:
|
|
13904
|
+
- product_id
|
|
13905
|
+
- product_name
|
|
13906
|
+
- price
|
|
13907
|
+
part_count: 3
|
|
13908
|
+
part_size: 10000000
|
|
13909
|
+
table_name: my_products_table
|
|
13910
|
+
type: upload
|
|
13390
13911
|
properties:
|
|
13391
13912
|
data:
|
|
13392
13913
|
$ref: '#/components/schemas/CreateUploadRequestData'
|
|
@@ -16447,6 +16968,113 @@ components:
|
|
|
16447
16968
|
format: uuid
|
|
16448
16969
|
type: string
|
|
16449
16970
|
type: object
|
|
16971
|
+
DeploymentGateDataType:
|
|
16972
|
+
description: Deployment gate resource type.
|
|
16973
|
+
enum:
|
|
16974
|
+
- deployment_gate
|
|
16975
|
+
example: deployment_gate
|
|
16976
|
+
type: string
|
|
16977
|
+
x-enum-varnames:
|
|
16978
|
+
- DEPLOYMENT_GATE
|
|
16979
|
+
DeploymentGateResponse:
|
|
16980
|
+
description: Response for a deployment gate.
|
|
16981
|
+
properties:
|
|
16982
|
+
data:
|
|
16983
|
+
$ref: '#/components/schemas/DeploymentGateResponseData'
|
|
16984
|
+
type: object
|
|
16985
|
+
DeploymentGateResponseData:
|
|
16986
|
+
description: Data for a deployment gate.
|
|
16987
|
+
properties:
|
|
16988
|
+
attributes:
|
|
16989
|
+
$ref: '#/components/schemas/DeploymentGateResponseDataAttributes'
|
|
16990
|
+
id:
|
|
16991
|
+
description: Unique identifier of the deployment gate.
|
|
16992
|
+
example: 1111-2222-3333-4444-555566667777
|
|
16993
|
+
type: string
|
|
16994
|
+
type:
|
|
16995
|
+
$ref: '#/components/schemas/DeploymentGateDataType'
|
|
16996
|
+
required:
|
|
16997
|
+
- type
|
|
16998
|
+
- attributes
|
|
16999
|
+
- id
|
|
17000
|
+
type: object
|
|
17001
|
+
DeploymentGateResponseDataAttributes:
|
|
17002
|
+
description: Basic information about a deployment gate.
|
|
17003
|
+
properties:
|
|
17004
|
+
created_at:
|
|
17005
|
+
description: The timestamp when the deployment gate was created.
|
|
17006
|
+
example: '2021-01-01T00:00:00Z'
|
|
17007
|
+
format: date-time
|
|
17008
|
+
type: string
|
|
17009
|
+
created_by:
|
|
17010
|
+
$ref: '#/components/schemas/DeploymentGateResponseDataAttributesCreatedBy'
|
|
17011
|
+
dry_run:
|
|
17012
|
+
description: Whether this gate is run in dry-run mode.
|
|
17013
|
+
example: false
|
|
17014
|
+
type: boolean
|
|
17015
|
+
env:
|
|
17016
|
+
description: The environment of the deployment gate.
|
|
17017
|
+
example: production
|
|
17018
|
+
type: string
|
|
17019
|
+
identifier:
|
|
17020
|
+
description: The identifier of the deployment gate.
|
|
17021
|
+
example: pre
|
|
17022
|
+
type: string
|
|
17023
|
+
service:
|
|
17024
|
+
description: The service of the deployment gate.
|
|
17025
|
+
example: my-service
|
|
17026
|
+
type: string
|
|
17027
|
+
updated_at:
|
|
17028
|
+
description: The timestamp when the deployment gate was last updated.
|
|
17029
|
+
example: '2021-01-01T00:00:00Z'
|
|
17030
|
+
format: date-time
|
|
17031
|
+
type: string
|
|
17032
|
+
updated_by:
|
|
17033
|
+
$ref: '#/components/schemas/DeploymentGateResponseDataAttributesUpdatedBy'
|
|
17034
|
+
required:
|
|
17035
|
+
- created_at
|
|
17036
|
+
- created_by
|
|
17037
|
+
- dry_run
|
|
17038
|
+
- env
|
|
17039
|
+
- identifier
|
|
17040
|
+
- service
|
|
17041
|
+
type: object
|
|
17042
|
+
DeploymentGateResponseDataAttributesCreatedBy:
|
|
17043
|
+
description: Information about the user who created the deployment gate.
|
|
17044
|
+
properties:
|
|
17045
|
+
handle:
|
|
17046
|
+
description: The handle of the user who created the deployment rule.
|
|
17047
|
+
example: test-user
|
|
17048
|
+
type: string
|
|
17049
|
+
id:
|
|
17050
|
+
description: The ID of the user who created the deployment rule.
|
|
17051
|
+
example: 1111-2222-3333-4444-555566667777
|
|
17052
|
+
type: string
|
|
17053
|
+
name:
|
|
17054
|
+
description: The name of the user who created the deployment rule.
|
|
17055
|
+
example: Test User
|
|
17056
|
+
type: string
|
|
17057
|
+
required:
|
|
17058
|
+
- id
|
|
17059
|
+
type: object
|
|
17060
|
+
DeploymentGateResponseDataAttributesUpdatedBy:
|
|
17061
|
+
description: Information about the user who updated the deployment gate.
|
|
17062
|
+
properties:
|
|
17063
|
+
handle:
|
|
17064
|
+
description: The handle of the user who updated the deployment rule.
|
|
17065
|
+
example: test-user
|
|
17066
|
+
type: string
|
|
17067
|
+
id:
|
|
17068
|
+
description: The ID of the user who updated the deployment rule.
|
|
17069
|
+
example: 1111-2222-3333-4444-555566667777
|
|
17070
|
+
type: string
|
|
17071
|
+
name:
|
|
17072
|
+
description: The name of the user who updated the deployment rule.
|
|
17073
|
+
example: Test User
|
|
17074
|
+
type: string
|
|
17075
|
+
required:
|
|
17076
|
+
- id
|
|
17077
|
+
type: object
|
|
16450
17078
|
DeploymentMetadata:
|
|
16451
17079
|
description: Metadata object containing the publication creation information.
|
|
16452
17080
|
properties:
|
|
@@ -16486,6 +17114,193 @@ components:
|
|
|
16486
17114
|
type:
|
|
16487
17115
|
$ref: '#/components/schemas/AppDeploymentType'
|
|
16488
17116
|
type: object
|
|
17117
|
+
DeploymentRuleDataType:
|
|
17118
|
+
description: Deployment rule resource type.
|
|
17119
|
+
enum:
|
|
17120
|
+
- deployment_rule
|
|
17121
|
+
example: deployment_rule
|
|
17122
|
+
type: string
|
|
17123
|
+
x-enum-varnames:
|
|
17124
|
+
- DEPLOYMENT_RULE
|
|
17125
|
+
DeploymentRuleOptionsFaultyDeploymentDetection:
|
|
17126
|
+
additionalProperties: false
|
|
17127
|
+
description: Faulty deployment detection options for deployment rules.
|
|
17128
|
+
properties:
|
|
17129
|
+
duration:
|
|
17130
|
+
description: The duration for faulty deployment detection.
|
|
17131
|
+
example: 3600
|
|
17132
|
+
format: int64
|
|
17133
|
+
type: integer
|
|
17134
|
+
excluded_resources:
|
|
17135
|
+
description: Resources to exclude from faulty deployment detection.
|
|
17136
|
+
example:
|
|
17137
|
+
- resource1
|
|
17138
|
+
- resource2
|
|
17139
|
+
items:
|
|
17140
|
+
type: string
|
|
17141
|
+
type: array
|
|
17142
|
+
type: object
|
|
17143
|
+
DeploymentRuleOptionsMonitor:
|
|
17144
|
+
additionalProperties: false
|
|
17145
|
+
description: Monitor options for deployment rules.
|
|
17146
|
+
properties:
|
|
17147
|
+
duration:
|
|
17148
|
+
description: Seconds the monitor needs to stay in OK status for the rule
|
|
17149
|
+
to pass.
|
|
17150
|
+
example: 3600
|
|
17151
|
+
format: int64
|
|
17152
|
+
type: integer
|
|
17153
|
+
query:
|
|
17154
|
+
description: Monitors that match this query are evaluated.
|
|
17155
|
+
example: service:my-service env:prod
|
|
17156
|
+
type: string
|
|
17157
|
+
required:
|
|
17158
|
+
- query
|
|
17159
|
+
type: object
|
|
17160
|
+
DeploymentRuleResponse:
|
|
17161
|
+
description: Response for a deployment rule.
|
|
17162
|
+
properties:
|
|
17163
|
+
data:
|
|
17164
|
+
$ref: '#/components/schemas/DeploymentRuleResponseData'
|
|
17165
|
+
type: object
|
|
17166
|
+
DeploymentRuleResponseData:
|
|
17167
|
+
description: Data for a deployment rule.
|
|
17168
|
+
properties:
|
|
17169
|
+
attributes:
|
|
17170
|
+
$ref: '#/components/schemas/DeploymentRuleResponseDataAttributes'
|
|
17171
|
+
id:
|
|
17172
|
+
description: Unique identifier of the deployment rule.
|
|
17173
|
+
example: 1111-2222-3333-4444-555566667777
|
|
17174
|
+
type: string
|
|
17175
|
+
type:
|
|
17176
|
+
$ref: '#/components/schemas/DeploymentRuleDataType'
|
|
17177
|
+
required:
|
|
17178
|
+
- type
|
|
17179
|
+
- attributes
|
|
17180
|
+
- id
|
|
17181
|
+
type: object
|
|
17182
|
+
DeploymentRuleResponseDataAttributes:
|
|
17183
|
+
description: Basic information about a deployment rule.
|
|
17184
|
+
properties:
|
|
17185
|
+
created_at:
|
|
17186
|
+
description: The timestamp when the deployment rule was created.
|
|
17187
|
+
example: '2021-01-01T00:00:00Z'
|
|
17188
|
+
format: date-time
|
|
17189
|
+
type: string
|
|
17190
|
+
created_by:
|
|
17191
|
+
$ref: '#/components/schemas/DeploymentRuleResponseDataAttributesCreatedBy'
|
|
17192
|
+
dry_run:
|
|
17193
|
+
description: Whether this rule is run in dry-run mode.
|
|
17194
|
+
example: false
|
|
17195
|
+
type: boolean
|
|
17196
|
+
gate_id:
|
|
17197
|
+
description: The ID of the deployment gate.
|
|
17198
|
+
example: 1111-2222-3333-4444-555566667777
|
|
17199
|
+
type: string
|
|
17200
|
+
name:
|
|
17201
|
+
description: The name of the deployment rule.
|
|
17202
|
+
example: My deployment rule
|
|
17203
|
+
type: string
|
|
17204
|
+
options:
|
|
17205
|
+
$ref: '#/components/schemas/DeploymentRulesOptions'
|
|
17206
|
+
type:
|
|
17207
|
+
$ref: '#/components/schemas/DeploymentRuleResponseDataAttributesType'
|
|
17208
|
+
updated_at:
|
|
17209
|
+
description: The timestamp when the deployment rule was last updated.
|
|
17210
|
+
format: date-time
|
|
17211
|
+
type: string
|
|
17212
|
+
updated_by:
|
|
17213
|
+
$ref: '#/components/schemas/DeploymentRuleResponseDataAttributesUpdatedBy'
|
|
17214
|
+
required:
|
|
17215
|
+
- created_at
|
|
17216
|
+
- created_by
|
|
17217
|
+
- dry_run
|
|
17218
|
+
- gate_id
|
|
17219
|
+
- name
|
|
17220
|
+
- options
|
|
17221
|
+
- type
|
|
17222
|
+
type: object
|
|
17223
|
+
DeploymentRuleResponseDataAttributesCreatedBy:
|
|
17224
|
+
description: Information about the user who created the deployment rule.
|
|
17225
|
+
properties:
|
|
17226
|
+
handle:
|
|
17227
|
+
description: The handle of the user who created the deployment rule.
|
|
17228
|
+
example: test-user
|
|
17229
|
+
type: string
|
|
17230
|
+
id:
|
|
17231
|
+
description: The ID of the user who created the deployment rule.
|
|
17232
|
+
example: 1111-2222-3333-4444-555566667777
|
|
17233
|
+
type: string
|
|
17234
|
+
name:
|
|
17235
|
+
description: The name of the user who created the deployment rule.
|
|
17236
|
+
example: Test User
|
|
17237
|
+
type: string
|
|
17238
|
+
required:
|
|
17239
|
+
- id
|
|
17240
|
+
type: object
|
|
17241
|
+
DeploymentRuleResponseDataAttributesType:
|
|
17242
|
+
description: The type of the deployment rule.
|
|
17243
|
+
enum:
|
|
17244
|
+
- faulty_deployment_detection
|
|
17245
|
+
- monitor
|
|
17246
|
+
example: faulty_deployment_detection
|
|
17247
|
+
type: string
|
|
17248
|
+
x-enum-varnames:
|
|
17249
|
+
- FAULTY_DEPLOYMENT_DETECTION
|
|
17250
|
+
- MONITOR
|
|
17251
|
+
DeploymentRuleResponseDataAttributesUpdatedBy:
|
|
17252
|
+
description: Information about the user who updated the deployment rule.
|
|
17253
|
+
properties:
|
|
17254
|
+
handle:
|
|
17255
|
+
description: The handle of the user who updated the deployment rule.
|
|
17256
|
+
example: test-user
|
|
17257
|
+
type: string
|
|
17258
|
+
id:
|
|
17259
|
+
description: The ID of the user who updated the deployment rule.
|
|
17260
|
+
example: 1111-2222-3333-4444-555566667777
|
|
17261
|
+
type: string
|
|
17262
|
+
name:
|
|
17263
|
+
description: The name of the user who updated the deployment rule.
|
|
17264
|
+
example: Test User
|
|
17265
|
+
type: string
|
|
17266
|
+
required:
|
|
17267
|
+
- id
|
|
17268
|
+
type: object
|
|
17269
|
+
DeploymentRulesOptions:
|
|
17270
|
+
description: Options for deployment rule response representing either faulty
|
|
17271
|
+
deployment detection or monitor options.
|
|
17272
|
+
oneOf:
|
|
17273
|
+
- $ref: '#/components/schemas/DeploymentRuleOptionsFaultyDeploymentDetection'
|
|
17274
|
+
- $ref: '#/components/schemas/DeploymentRuleOptionsMonitor'
|
|
17275
|
+
DetachCaseRequest:
|
|
17276
|
+
description: Request for detaching security findings from their case.
|
|
17277
|
+
properties:
|
|
17278
|
+
data:
|
|
17279
|
+
$ref: '#/components/schemas/DetachCaseRequestData'
|
|
17280
|
+
type: object
|
|
17281
|
+
DetachCaseRequestData:
|
|
17282
|
+
description: Data for detaching security findings from their case.
|
|
17283
|
+
properties:
|
|
17284
|
+
id:
|
|
17285
|
+
description: The unique identifier of the detachment request.
|
|
17286
|
+
example: f8b9e3b1-24ec-4413-8be5-1b12b98533c6
|
|
17287
|
+
type: string
|
|
17288
|
+
relationships:
|
|
17289
|
+
$ref: '#/components/schemas/DetachCaseRequestDataRelationships'
|
|
17290
|
+
type:
|
|
17291
|
+
$ref: '#/components/schemas/CaseDataType'
|
|
17292
|
+
required:
|
|
17293
|
+
- type
|
|
17294
|
+
type: object
|
|
17295
|
+
DetachCaseRequestDataRelationships:
|
|
17296
|
+
description: Relationships detaching security findings from their case.
|
|
17297
|
+
properties:
|
|
17298
|
+
findings:
|
|
17299
|
+
$ref: '#/components/schemas/Findings'
|
|
17300
|
+
description: Security findings to detach from their case.
|
|
17301
|
+
required:
|
|
17302
|
+
- findings
|
|
17303
|
+
type: object
|
|
16489
17304
|
DetailedFinding:
|
|
16490
17305
|
description: A single finding with with message and resource configuration.
|
|
16491
17306
|
properties:
|
|
@@ -18581,6 +19396,8 @@ components:
|
|
|
18581
19396
|
type: users
|
|
18582
19397
|
- id: 00000000-aba2-0000-0000-000000000000
|
|
18583
19398
|
type: schedules
|
|
19399
|
+
- id: 00000000-aba2-0000-0000-000000000000_previous
|
|
19400
|
+
type: schedule_target
|
|
18584
19401
|
- id: 00000000-aba3-0000-0000-000000000000
|
|
18585
19402
|
type: teams
|
|
18586
19403
|
type: steps
|
|
@@ -18588,6 +19405,15 @@ components:
|
|
|
18588
19405
|
type: users
|
|
18589
19406
|
- id: 00000000-aba2-0000-0000-000000000000
|
|
18590
19407
|
type: schedules
|
|
19408
|
+
- attributes:
|
|
19409
|
+
position: previous
|
|
19410
|
+
id: 00000000-aba2-0000-0000-000000000000_previous
|
|
19411
|
+
relationships:
|
|
19412
|
+
schedule:
|
|
19413
|
+
data:
|
|
19414
|
+
id: 00000000-aba2-0000-0000-000000000000
|
|
19415
|
+
type: schedules
|
|
19416
|
+
type: schedule_target
|
|
18591
19417
|
- id: 00000000-aba3-0000-0000-000000000000
|
|
18592
19418
|
type: teams
|
|
18593
19419
|
properties:
|
|
@@ -18615,7 +19441,10 @@ components:
|
|
|
18615
19441
|
targets:
|
|
18616
19442
|
- id: 00000000-aba1-0000-0000-000000000000
|
|
18617
19443
|
type: users
|
|
18618
|
-
-
|
|
19444
|
+
- config:
|
|
19445
|
+
schedule:
|
|
19446
|
+
position: previous
|
|
19447
|
+
id: 00000000-aba2-0000-0000-000000000000
|
|
18619
19448
|
type: schedules
|
|
18620
19449
|
- id: 00000000-aba3-0000-0000-000000000000
|
|
18621
19450
|
type: teams
|
|
@@ -18659,6 +19488,7 @@ components:
|
|
|
18659
19488
|
name:
|
|
18660
19489
|
description: Specifies the name for the new escalation policy.
|
|
18661
19490
|
example: On-Call Escalation Policy
|
|
19491
|
+
minLength: 1
|
|
18662
19492
|
type: string
|
|
18663
19493
|
resolve_page_on_policy_end:
|
|
18664
19494
|
description: Indicates whether the page is automatically resolved when the
|
|
@@ -18668,12 +19498,16 @@ components:
|
|
|
18668
19498
|
description: Specifies how many times the escalation sequence is retried
|
|
18669
19499
|
if there is no response.
|
|
18670
19500
|
format: int64
|
|
19501
|
+
maximum: 10
|
|
19502
|
+
minimum: 0
|
|
18671
19503
|
type: integer
|
|
18672
19504
|
steps:
|
|
18673
19505
|
description: A list of escalation steps, each defining assignment, escalation
|
|
18674
19506
|
timeout, and targets for the new policy.
|
|
18675
19507
|
items:
|
|
18676
19508
|
$ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItems'
|
|
19509
|
+
maxItems: 10
|
|
19510
|
+
minItems: 1
|
|
18677
19511
|
type: array
|
|
18678
19512
|
required:
|
|
18679
19513
|
- name
|
|
@@ -18690,6 +19524,8 @@ components:
|
|
|
18690
19524
|
step.
|
|
18691
19525
|
example: 3600
|
|
18692
19526
|
format: int64
|
|
19527
|
+
maximum: 36000
|
|
19528
|
+
minimum: 60
|
|
18693
19529
|
type: integer
|
|
18694
19530
|
targets:
|
|
18695
19531
|
description: Specifies the collection of escalation targets for this step.
|
|
@@ -18741,6 +19577,7 @@ components:
|
|
|
18741
19577
|
name:
|
|
18742
19578
|
description: Specifies the name of the escalation policy.
|
|
18743
19579
|
example: On-Call Escalation Policy
|
|
19580
|
+
minLength: 1
|
|
18744
19581
|
type: string
|
|
18745
19582
|
resolve_page_on_policy_end:
|
|
18746
19583
|
description: Indicates whether the page is automatically resolved when the
|
|
@@ -18750,6 +19587,8 @@ components:
|
|
|
18750
19587
|
description: Specifies how many times the escalation sequence is retried
|
|
18751
19588
|
if there is no response.
|
|
18752
19589
|
format: int64
|
|
19590
|
+
maximum: 10
|
|
19591
|
+
minimum: 0
|
|
18753
19592
|
type: integer
|
|
18754
19593
|
required:
|
|
18755
19594
|
- name
|
|
@@ -18812,10 +19651,11 @@ components:
|
|
|
18812
19651
|
description: Represents included related resources when retrieving an escalation
|
|
18813
19652
|
policy, such as teams, steps, or targets.
|
|
18814
19653
|
oneOf:
|
|
18815
|
-
- $ref: '#/components/schemas/TeamReference'
|
|
18816
19654
|
- $ref: '#/components/schemas/EscalationPolicyStep'
|
|
18817
19655
|
- $ref: '#/components/schemas/EscalationPolicyUser'
|
|
18818
19656
|
- $ref: '#/components/schemas/ScheduleData'
|
|
19657
|
+
- $ref: '#/components/schemas/ConfiguredSchedule'
|
|
19658
|
+
- $ref: '#/components/schemas/TeamReference'
|
|
18819
19659
|
EscalationPolicyStep:
|
|
18820
19660
|
description: Represents a single step in an escalation policy, including its
|
|
18821
19661
|
attributes, relationships, and resource type.
|
|
@@ -18863,8 +19703,10 @@ components:
|
|
|
18863
19703
|
type: object
|
|
18864
19704
|
EscalationPolicyStepTarget:
|
|
18865
19705
|
description: Defines a single escalation target within a step for an escalation
|
|
18866
|
-
policy creation request. Contains `id` and `
|
|
19706
|
+
policy creation request. Contains `id`, `type`, and optional `config`.
|
|
18867
19707
|
properties:
|
|
19708
|
+
config:
|
|
19709
|
+
$ref: '#/components/schemas/EscalationPolicyStepTargetConfig'
|
|
18868
19710
|
id:
|
|
18869
19711
|
description: Specifies the unique identifier for this target.
|
|
18870
19712
|
example: 00000000-aba1-0000-0000-000000000000
|
|
@@ -18872,6 +19714,18 @@ components:
|
|
|
18872
19714
|
type:
|
|
18873
19715
|
$ref: '#/components/schemas/EscalationPolicyStepTargetType'
|
|
18874
19716
|
type: object
|
|
19717
|
+
EscalationPolicyStepTargetConfig:
|
|
19718
|
+
description: Configuration for an escalation target, such as schedule position.
|
|
19719
|
+
properties:
|
|
19720
|
+
schedule:
|
|
19721
|
+
$ref: '#/components/schemas/EscalationPolicyStepTargetConfigSchedule'
|
|
19722
|
+
type: object
|
|
19723
|
+
EscalationPolicyStepTargetConfigSchedule:
|
|
19724
|
+
description: Schedule-specific configuration for an escalation target.
|
|
19725
|
+
properties:
|
|
19726
|
+
position:
|
|
19727
|
+
$ref: '#/components/schemas/ScheduleTargetPosition'
|
|
19728
|
+
type: object
|
|
18875
19729
|
EscalationPolicyStepTargetType:
|
|
18876
19730
|
description: Specifies the type of escalation target (example `users`, `schedules`,
|
|
18877
19731
|
or `teams`).
|
|
@@ -18952,6 +19806,7 @@ components:
|
|
|
18952
19806
|
name:
|
|
18953
19807
|
description: Specifies the name of the escalation policy.
|
|
18954
19808
|
example: On-Call Escalation Policy
|
|
19809
|
+
minLength: 1
|
|
18955
19810
|
type: string
|
|
18956
19811
|
resolve_page_on_policy_end:
|
|
18957
19812
|
description: Indicates whether the page is automatically resolved when the
|
|
@@ -18961,12 +19816,16 @@ components:
|
|
|
18961
19816
|
description: Specifies how many times the escalation sequence is retried
|
|
18962
19817
|
if there is no response.
|
|
18963
19818
|
format: int64
|
|
19819
|
+
maximum: 10
|
|
19820
|
+
minimum: 0
|
|
18964
19821
|
type: integer
|
|
18965
19822
|
steps:
|
|
18966
19823
|
description: A list of escalation steps, each defining assignment, escalation
|
|
18967
19824
|
timeout, and targets.
|
|
18968
19825
|
items:
|
|
18969
19826
|
$ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItems'
|
|
19827
|
+
maxItems: 10
|
|
19828
|
+
minItems: 1
|
|
18970
19829
|
type: array
|
|
18971
19830
|
required:
|
|
18972
19831
|
- name
|
|
@@ -18984,6 +19843,8 @@ components:
|
|
|
18984
19843
|
step.
|
|
18985
19844
|
example: 3600
|
|
18986
19845
|
format: int64
|
|
19846
|
+
maximum: 36000
|
|
19847
|
+
minimum: 60
|
|
18987
19848
|
type: integer
|
|
18988
19849
|
id:
|
|
18989
19850
|
description: Specifies the unique identifier of this step.
|
|
@@ -19092,12 +19953,13 @@ components:
|
|
|
19092
19953
|
x-enum-varnames:
|
|
19093
19954
|
- USERS
|
|
19094
19955
|
EscalationTarget:
|
|
19095
|
-
description: Represents an escalation target, which can be a team, user,
|
|
19096
|
-
schedule.
|
|
19956
|
+
description: Represents an escalation target, which can be a team, user, schedule,
|
|
19957
|
+
or configured schedule target.
|
|
19097
19958
|
oneOf:
|
|
19098
19959
|
- $ref: '#/components/schemas/TeamTarget'
|
|
19099
19960
|
- $ref: '#/components/schemas/UserTarget'
|
|
19100
19961
|
- $ref: '#/components/schemas/ScheduleTarget'
|
|
19962
|
+
- $ref: '#/components/schemas/ConfiguredScheduleTarget'
|
|
19101
19963
|
EscalationTargets:
|
|
19102
19964
|
description: A list of escalation targets for a step
|
|
19103
19965
|
properties:
|
|
@@ -20336,6 +21198,153 @@ components:
|
|
|
20336
21198
|
vulnerability_type:
|
|
20337
21199
|
$ref: '#/components/schemas/FindingVulnerabilityType'
|
|
20338
21200
|
type: object
|
|
21201
|
+
FindingCaseResponse:
|
|
21202
|
+
description: Case response.
|
|
21203
|
+
properties:
|
|
21204
|
+
data:
|
|
21205
|
+
$ref: '#/components/schemas/FindingCaseResponseData'
|
|
21206
|
+
type: object
|
|
21207
|
+
FindingCaseResponseArray:
|
|
21208
|
+
description: List of case responses.
|
|
21209
|
+
properties:
|
|
21210
|
+
data:
|
|
21211
|
+
items:
|
|
21212
|
+
$ref: '#/components/schemas/FindingCaseResponseData'
|
|
21213
|
+
type: array
|
|
21214
|
+
required:
|
|
21215
|
+
- data
|
|
21216
|
+
type: object
|
|
21217
|
+
FindingCaseResponseData:
|
|
21218
|
+
description: Data of the case.
|
|
21219
|
+
properties:
|
|
21220
|
+
attributes:
|
|
21221
|
+
$ref: '#/components/schemas/FindingCaseResponseDataAttributes'
|
|
21222
|
+
id:
|
|
21223
|
+
description: The unique identifier of the case.
|
|
21224
|
+
example: c1234567-89ab-cdef-0123-456789abcdef
|
|
21225
|
+
type: string
|
|
21226
|
+
relationships:
|
|
21227
|
+
$ref: '#/components/schemas/FindingCaseResponseDataRelationships'
|
|
21228
|
+
type:
|
|
21229
|
+
$ref: '#/components/schemas/CaseDataType'
|
|
21230
|
+
required:
|
|
21231
|
+
- type
|
|
21232
|
+
type: object
|
|
21233
|
+
FindingCaseResponseDataAttributes:
|
|
21234
|
+
description: Attributes of the case.
|
|
21235
|
+
properties:
|
|
21236
|
+
archived_at:
|
|
21237
|
+
description: Timestamp of when the case was archived.
|
|
21238
|
+
example: '2025-01-01T00:00:00.000Z'
|
|
21239
|
+
format: date-time
|
|
21240
|
+
type: string
|
|
21241
|
+
assigned_to:
|
|
21242
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
21243
|
+
description: User assigned to the case.
|
|
21244
|
+
attributes:
|
|
21245
|
+
additionalProperties:
|
|
21246
|
+
items:
|
|
21247
|
+
type: string
|
|
21248
|
+
type: array
|
|
21249
|
+
type: object
|
|
21250
|
+
closed_at:
|
|
21251
|
+
description: Timestamp of when the case was closed.
|
|
21252
|
+
example: '2025-01-01T00:00:00.000Z'
|
|
21253
|
+
format: date-time
|
|
21254
|
+
type: string
|
|
21255
|
+
created_at:
|
|
21256
|
+
description: Timestamp of when the case was created.
|
|
21257
|
+
example: '2025-01-01T00:00:00.000Z'
|
|
21258
|
+
format: date-time
|
|
21259
|
+
type: string
|
|
21260
|
+
creation_source:
|
|
21261
|
+
description: Source of the case creation.
|
|
21262
|
+
example: CS_SECURITY_FINDING
|
|
21263
|
+
type: string
|
|
21264
|
+
description:
|
|
21265
|
+
description: Description of the case.
|
|
21266
|
+
example: A description of the case.
|
|
21267
|
+
type: string
|
|
21268
|
+
due_date:
|
|
21269
|
+
description: Due date of the case.
|
|
21270
|
+
example: '2025-01-01'
|
|
21271
|
+
type: string
|
|
21272
|
+
insights:
|
|
21273
|
+
description: Insights of the case.
|
|
21274
|
+
items:
|
|
21275
|
+
$ref: '#/components/schemas/CaseInsightsItems'
|
|
21276
|
+
type: array
|
|
21277
|
+
jira_issue:
|
|
21278
|
+
$ref: '#/components/schemas/FindingJiraIssue'
|
|
21279
|
+
description: Jira issue associated with the case.
|
|
21280
|
+
key:
|
|
21281
|
+
description: Key of the case.
|
|
21282
|
+
example: PROJ-123
|
|
21283
|
+
type: string
|
|
21284
|
+
modified_at:
|
|
21285
|
+
description: Timestamp of when the case was last modified.
|
|
21286
|
+
example: '2025-01-01T00:00:00.000Z'
|
|
21287
|
+
format: date-time
|
|
21288
|
+
type: string
|
|
21289
|
+
priority:
|
|
21290
|
+
description: Priority of the case.
|
|
21291
|
+
example: P4
|
|
21292
|
+
type: string
|
|
21293
|
+
status:
|
|
21294
|
+
description: Status of the case.
|
|
21295
|
+
example: OPEN
|
|
21296
|
+
type: string
|
|
21297
|
+
status_group:
|
|
21298
|
+
description: Status group of the case.
|
|
21299
|
+
example: SG_OPEN
|
|
21300
|
+
type: string
|
|
21301
|
+
status_name:
|
|
21302
|
+
description: Status name of the case.
|
|
21303
|
+
example: Open
|
|
21304
|
+
type: string
|
|
21305
|
+
title:
|
|
21306
|
+
description: Title of the case.
|
|
21307
|
+
example: A title for the case.
|
|
21308
|
+
type: string
|
|
21309
|
+
type:
|
|
21310
|
+
description: Type of the case. For security cases, this is always "SECURITY".
|
|
21311
|
+
example: SECURITY
|
|
21312
|
+
type: string
|
|
21313
|
+
type: object
|
|
21314
|
+
FindingCaseResponseDataRelationships:
|
|
21315
|
+
description: Relationships of the case.
|
|
21316
|
+
properties:
|
|
21317
|
+
created_by:
|
|
21318
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
21319
|
+
description: User who created the case.
|
|
21320
|
+
modified_by:
|
|
21321
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
21322
|
+
description: User who last modified the case.
|
|
21323
|
+
project:
|
|
21324
|
+
$ref: '#/components/schemas/CaseManagementProject'
|
|
21325
|
+
description: Project in which the case was created.
|
|
21326
|
+
type: object
|
|
21327
|
+
FindingData:
|
|
21328
|
+
properties:
|
|
21329
|
+
id:
|
|
21330
|
+
description: The unique identifier of the security finding.
|
|
21331
|
+
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
|
21332
|
+
type: string
|
|
21333
|
+
type:
|
|
21334
|
+
$ref: '#/components/schemas/FindingDataType'
|
|
21335
|
+
required:
|
|
21336
|
+
- type
|
|
21337
|
+
- id
|
|
21338
|
+
type: object
|
|
21339
|
+
FindingDataType:
|
|
21340
|
+
default: findings
|
|
21341
|
+
description: Security findings resource type.
|
|
21342
|
+
enum:
|
|
21343
|
+
- findings
|
|
21344
|
+
example: findings
|
|
21345
|
+
type: string
|
|
21346
|
+
x-enum-varnames:
|
|
21347
|
+
- FINDINGS
|
|
20339
21348
|
FindingDatadogLink:
|
|
20340
21349
|
description: The Datadog relative link for this finding.
|
|
20341
21350
|
example: /security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview
|
|
@@ -20377,6 +21386,42 @@ components:
|
|
|
20377
21386
|
description: The unique ID for this finding.
|
|
20378
21387
|
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
|
20379
21388
|
type: string
|
|
21389
|
+
FindingJiraIssue:
|
|
21390
|
+
description: Jira issue associated with the case.
|
|
21391
|
+
properties:
|
|
21392
|
+
error_message:
|
|
21393
|
+
description: The error message if the Jira issue creation failed.
|
|
21394
|
+
example: '{"errorMessages":["An error occured."],"errors":{}}'
|
|
21395
|
+
type: string
|
|
21396
|
+
result:
|
|
21397
|
+
$ref: '#/components/schemas/FindingJiraIssueResult'
|
|
21398
|
+
status:
|
|
21399
|
+
description: The status of the Jira issue creation. Can be "COMPLETED" if
|
|
21400
|
+
the Jira issue was created successfully, or "FAILED" if the Jira issue
|
|
21401
|
+
creation failed.
|
|
21402
|
+
example: COMPLETED
|
|
21403
|
+
type: string
|
|
21404
|
+
type: object
|
|
21405
|
+
FindingJiraIssueResult:
|
|
21406
|
+
description: Result of the Jira issue creation.
|
|
21407
|
+
properties:
|
|
21408
|
+
account_id:
|
|
21409
|
+
description: The account ID of the Jira issue.
|
|
21410
|
+
example: 463a8631-680e-455c-bfd3-3ed04d326eb7
|
|
21411
|
+
type: string
|
|
21412
|
+
issue_id:
|
|
21413
|
+
description: The unique identifier of the Jira issue.
|
|
21414
|
+
example: '2871276'
|
|
21415
|
+
type: string
|
|
21416
|
+
issue_key:
|
|
21417
|
+
description: The key of the Jira issue.
|
|
21418
|
+
example: PROJ-123
|
|
21419
|
+
type: string
|
|
21420
|
+
issue_url:
|
|
21421
|
+
description: The URL of the Jira issue.
|
|
21422
|
+
example: https://domain.atlassian.net/browse/PROJ-123
|
|
21423
|
+
type: string
|
|
21424
|
+
type: object
|
|
20380
21425
|
FindingMute:
|
|
20381
21426
|
additionalProperties: false
|
|
20382
21427
|
description: Information about the mute status of this finding.
|
|
@@ -20502,6 +21547,14 @@ components:
|
|
|
20502
21547
|
- ATTACK_PATH
|
|
20503
21548
|
- IDENTITY_RISK
|
|
20504
21549
|
- API_SECURITY
|
|
21550
|
+
Findings:
|
|
21551
|
+
description: A list of security findings.
|
|
21552
|
+
properties:
|
|
21553
|
+
data:
|
|
21554
|
+
items:
|
|
21555
|
+
$ref: '#/components/schemas/FindingData'
|
|
21556
|
+
type: array
|
|
21557
|
+
type: object
|
|
20505
21558
|
FlakyTest:
|
|
20506
21559
|
description: A flaky test object.
|
|
20507
21560
|
properties:
|
|
@@ -20870,6 +21923,278 @@ components:
|
|
|
20870
21923
|
- PIPELINES_FAILED_DESCENDING
|
|
20871
21924
|
- PIPELINES_DURATION_LOST_ASCENDING
|
|
20872
21925
|
- PIPELINES_DURATION_LOST_DESCENDING
|
|
21926
|
+
FleetAgentAttributes:
|
|
21927
|
+
description: Attributes of a Datadog Agent in the list view.
|
|
21928
|
+
properties:
|
|
21929
|
+
agent_version:
|
|
21930
|
+
description: The Datadog Agent version.
|
|
21931
|
+
example: 7.50.0
|
|
21932
|
+
type: string
|
|
21933
|
+
api_key_name:
|
|
21934
|
+
description: The API key name (if available and not redacted).
|
|
21935
|
+
example: Production API Key
|
|
21936
|
+
type: string
|
|
21937
|
+
api_key_uuid:
|
|
21938
|
+
description: The API key UUID.
|
|
21939
|
+
example: a1b2c3d4-e5f6-4321-a123-123456789abc
|
|
21940
|
+
type: string
|
|
21941
|
+
cloud_provider:
|
|
21942
|
+
description: The cloud provider where the agent is running.
|
|
21943
|
+
example: aws
|
|
21944
|
+
type: string
|
|
21945
|
+
cluster_name:
|
|
21946
|
+
description: Kubernetes cluster name (if applicable).
|
|
21947
|
+
type: string
|
|
21948
|
+
datadog_agent_key:
|
|
21949
|
+
description: The unique agent key identifier.
|
|
21950
|
+
example: my-agent-hostname
|
|
21951
|
+
type: string
|
|
21952
|
+
enabled_products:
|
|
21953
|
+
description: Datadog products enabled on the agent.
|
|
21954
|
+
items:
|
|
21955
|
+
type: string
|
|
21956
|
+
type: array
|
|
21957
|
+
envs:
|
|
21958
|
+
description: Environments the agent is reporting from.
|
|
21959
|
+
items:
|
|
21960
|
+
type: string
|
|
21961
|
+
type: array
|
|
21962
|
+
first_seen_at:
|
|
21963
|
+
description: Timestamp when the agent was first seen.
|
|
21964
|
+
format: int64
|
|
21965
|
+
type: integer
|
|
21966
|
+
hostname:
|
|
21967
|
+
description: The hostname of the agent.
|
|
21968
|
+
example: my-hostname
|
|
21969
|
+
type: string
|
|
21970
|
+
ip_addresses:
|
|
21971
|
+
description: IP addresses of the agent.
|
|
21972
|
+
items:
|
|
21973
|
+
type: string
|
|
21974
|
+
type: array
|
|
21975
|
+
is_single_step_instrumentation_enabled:
|
|
21976
|
+
description: Whether single-step instrumentation is enabled.
|
|
21977
|
+
type: boolean
|
|
21978
|
+
last_restart_at:
|
|
21979
|
+
description: Timestamp of the last agent restart.
|
|
21980
|
+
format: int64
|
|
21981
|
+
type: integer
|
|
21982
|
+
os:
|
|
21983
|
+
description: The operating system.
|
|
21984
|
+
example: linux
|
|
21985
|
+
type: string
|
|
21986
|
+
otel_collector_version:
|
|
21987
|
+
description: OpenTelemetry collector version (if applicable).
|
|
21988
|
+
type: string
|
|
21989
|
+
otel_collector_versions:
|
|
21990
|
+
description: List of OpenTelemetry collector versions (if applicable).
|
|
21991
|
+
items:
|
|
21992
|
+
type: string
|
|
21993
|
+
type: array
|
|
21994
|
+
pod_name:
|
|
21995
|
+
description: Kubernetes pod name (if applicable).
|
|
21996
|
+
type: string
|
|
21997
|
+
remote_agent_management:
|
|
21998
|
+
description: Remote agent management status.
|
|
21999
|
+
example: enabled
|
|
22000
|
+
type: string
|
|
22001
|
+
remote_config_status:
|
|
22002
|
+
description: Remote configuration status.
|
|
22003
|
+
example: connected
|
|
22004
|
+
type: string
|
|
22005
|
+
services:
|
|
22006
|
+
description: Services running on the agent.
|
|
22007
|
+
items:
|
|
22008
|
+
type: string
|
|
22009
|
+
type: array
|
|
22010
|
+
tags:
|
|
22011
|
+
description: Tags associated with the agent.
|
|
22012
|
+
items:
|
|
22013
|
+
$ref: '#/components/schemas/FleetAgentAttributesTagsItems'
|
|
22014
|
+
type: array
|
|
22015
|
+
team:
|
|
22016
|
+
description: Team associated with the agent.
|
|
22017
|
+
type: string
|
|
22018
|
+
type: object
|
|
22019
|
+
FleetAgentAttributesTagsItems:
|
|
22020
|
+
properties:
|
|
22021
|
+
key:
|
|
22022
|
+
type: string
|
|
22023
|
+
value:
|
|
22024
|
+
type: string
|
|
22025
|
+
type: object
|
|
22026
|
+
FleetAgentInfo:
|
|
22027
|
+
description: Represents detailed information about a specific Datadog Agent.
|
|
22028
|
+
properties:
|
|
22029
|
+
attributes:
|
|
22030
|
+
$ref: '#/components/schemas/FleetAgentInfoAttributes'
|
|
22031
|
+
id:
|
|
22032
|
+
description: The unique agent key identifier.
|
|
22033
|
+
example: my-agent-hostname
|
|
22034
|
+
type: string
|
|
22035
|
+
type:
|
|
22036
|
+
$ref: '#/components/schemas/FleetAgentInfoResourceType'
|
|
22037
|
+
required:
|
|
22038
|
+
- id
|
|
22039
|
+
- type
|
|
22040
|
+
- attributes
|
|
22041
|
+
type: object
|
|
22042
|
+
FleetAgentInfoAttributes:
|
|
22043
|
+
description: Attributes for agent information.
|
|
22044
|
+
properties:
|
|
22045
|
+
agent_infos:
|
|
22046
|
+
$ref: '#/components/schemas/FleetAgentInfoDetails'
|
|
22047
|
+
configuration_files:
|
|
22048
|
+
$ref: '#/components/schemas/FleetConfigurationLayer'
|
|
22049
|
+
detected_integrations:
|
|
22050
|
+
description: List of detected integrations.
|
|
22051
|
+
items:
|
|
22052
|
+
$ref: '#/components/schemas/FleetDetectedIntegration'
|
|
22053
|
+
type: array
|
|
22054
|
+
integrations:
|
|
22055
|
+
$ref: '#/components/schemas/FleetIntegrationsByStatus'
|
|
22056
|
+
type: object
|
|
22057
|
+
FleetAgentInfoDetails:
|
|
22058
|
+
description: Detailed information about a Datadog Agent.
|
|
22059
|
+
properties:
|
|
22060
|
+
agent_version:
|
|
22061
|
+
description: The Datadog Agent version.
|
|
22062
|
+
example: 7.50.0
|
|
22063
|
+
type: string
|
|
22064
|
+
api_key_name:
|
|
22065
|
+
description: The API key name (if available and not redacted).
|
|
22066
|
+
example: Production API Key
|
|
22067
|
+
type: string
|
|
22068
|
+
api_key_uuid:
|
|
22069
|
+
description: The API key UUID.
|
|
22070
|
+
example: a1b2c3d4-e5f6-4321-a123-123456789abc
|
|
22071
|
+
type: string
|
|
22072
|
+
cloud_provider:
|
|
22073
|
+
description: The cloud provider where the agent is running.
|
|
22074
|
+
example: aws
|
|
22075
|
+
type: string
|
|
22076
|
+
cluster_name:
|
|
22077
|
+
description: Kubernetes cluster name (if applicable).
|
|
22078
|
+
type: string
|
|
22079
|
+
datadog_agent_key:
|
|
22080
|
+
description: The unique agent key identifier.
|
|
22081
|
+
example: my-agent-hostname
|
|
22082
|
+
type: string
|
|
22083
|
+
enabled_products:
|
|
22084
|
+
description: Datadog products enabled on the agent.
|
|
22085
|
+
items:
|
|
22086
|
+
type: string
|
|
22087
|
+
type: array
|
|
22088
|
+
env:
|
|
22089
|
+
description: Environments the agent is reporting from.
|
|
22090
|
+
items:
|
|
22091
|
+
type: string
|
|
22092
|
+
type: array
|
|
22093
|
+
first_seen_at:
|
|
22094
|
+
description: Timestamp when the agent was first seen.
|
|
22095
|
+
format: int64
|
|
22096
|
+
type: integer
|
|
22097
|
+
hostname:
|
|
22098
|
+
description: The hostname of the agent.
|
|
22099
|
+
example: my-hostname
|
|
22100
|
+
type: string
|
|
22101
|
+
hostname_aliases:
|
|
22102
|
+
description: Alternative hostname list for the agent.
|
|
22103
|
+
items:
|
|
22104
|
+
type: string
|
|
22105
|
+
type: array
|
|
22106
|
+
install_method_installer_version:
|
|
22107
|
+
description: The version of the installer used.
|
|
22108
|
+
example: 1.2.3
|
|
22109
|
+
type: string
|
|
22110
|
+
install_method_tool:
|
|
22111
|
+
description: The tool used to install the agent.
|
|
22112
|
+
example: chef
|
|
22113
|
+
type: string
|
|
22114
|
+
ip_addresses:
|
|
22115
|
+
description: IP addresses of the agent.
|
|
22116
|
+
items:
|
|
22117
|
+
type: string
|
|
22118
|
+
type: array
|
|
22119
|
+
is_single_step_instrumentation_enabled:
|
|
22120
|
+
description: Whether single-step instrumentation is enabled.
|
|
22121
|
+
type: boolean
|
|
22122
|
+
last_restart_at:
|
|
22123
|
+
description: Timestamp of the last agent restart.
|
|
22124
|
+
format: int64
|
|
22125
|
+
type: integer
|
|
22126
|
+
os:
|
|
22127
|
+
description: The operating system.
|
|
22128
|
+
example: linux
|
|
22129
|
+
type: string
|
|
22130
|
+
os_version:
|
|
22131
|
+
description: The operating system version.
|
|
22132
|
+
example: Ubuntu 20.04
|
|
22133
|
+
type: string
|
|
22134
|
+
otel_collector_version:
|
|
22135
|
+
description: OpenTelemetry collector version (if applicable).
|
|
22136
|
+
type: string
|
|
22137
|
+
otel_collector_versions:
|
|
22138
|
+
description: List of OpenTelemetry collector versions (if applicable).
|
|
22139
|
+
items:
|
|
22140
|
+
type: string
|
|
22141
|
+
type: array
|
|
22142
|
+
otel_collectors:
|
|
22143
|
+
description: OpenTelemetry collectors associated with the agent (if applicable).
|
|
22144
|
+
items:
|
|
22145
|
+
$ref: '#/components/schemas/FleetOtelCollector'
|
|
22146
|
+
type: array
|
|
22147
|
+
pod_name:
|
|
22148
|
+
description: Kubernetes pod name (if applicable).
|
|
22149
|
+
type: string
|
|
22150
|
+
python_version:
|
|
22151
|
+
description: The Python version used by the agent.
|
|
22152
|
+
example: 3.9.5
|
|
22153
|
+
type: string
|
|
22154
|
+
region:
|
|
22155
|
+
description: Regions where the agent is running.
|
|
22156
|
+
items:
|
|
22157
|
+
type: string
|
|
22158
|
+
type: array
|
|
22159
|
+
remote_agent_management:
|
|
22160
|
+
description: Remote agent management status.
|
|
22161
|
+
example: enabled
|
|
22162
|
+
type: string
|
|
22163
|
+
remote_config_status:
|
|
22164
|
+
description: Remote configuration status.
|
|
22165
|
+
example: connected
|
|
22166
|
+
type: string
|
|
22167
|
+
services:
|
|
22168
|
+
description: Services running on the agent.
|
|
22169
|
+
items:
|
|
22170
|
+
type: string
|
|
22171
|
+
type: array
|
|
22172
|
+
tags:
|
|
22173
|
+
description: Tags associated with the agent.
|
|
22174
|
+
items:
|
|
22175
|
+
type: string
|
|
22176
|
+
type: array
|
|
22177
|
+
team:
|
|
22178
|
+
description: Team associated with the agent.
|
|
22179
|
+
type: string
|
|
22180
|
+
type: object
|
|
22181
|
+
FleetAgentInfoResourceType:
|
|
22182
|
+
default: datadog_agent_key
|
|
22183
|
+
description: The type of Agent info resource.
|
|
22184
|
+
enum:
|
|
22185
|
+
- datadog_agent_key
|
|
22186
|
+
example: datadog_agent_key
|
|
22187
|
+
type: string
|
|
22188
|
+
x-enum-varnames:
|
|
22189
|
+
- DATADOG_AGENT_KEY
|
|
22190
|
+
FleetAgentInfoResponse:
|
|
22191
|
+
description: Response containing detailed information about a specific agent.
|
|
22192
|
+
properties:
|
|
22193
|
+
data:
|
|
22194
|
+
$ref: '#/components/schemas/FleetAgentInfo'
|
|
22195
|
+
required:
|
|
22196
|
+
- data
|
|
22197
|
+
type: object
|
|
20873
22198
|
FleetAgentVersion:
|
|
20874
22199
|
description: Represents an available Datadog Agent version.
|
|
20875
22200
|
properties:
|
|
@@ -20912,6 +22237,89 @@ components:
|
|
|
20912
22237
|
required:
|
|
20913
22238
|
- data
|
|
20914
22239
|
type: object
|
|
22240
|
+
FleetAgentsResponse:
|
|
22241
|
+
description: Response containing a paginated list of Datadog Agents.
|
|
22242
|
+
properties:
|
|
22243
|
+
data:
|
|
22244
|
+
$ref: '#/components/schemas/FleetAgentsResponseData'
|
|
22245
|
+
meta:
|
|
22246
|
+
$ref: '#/components/schemas/FleetAgentsResponseMeta'
|
|
22247
|
+
required:
|
|
22248
|
+
- data
|
|
22249
|
+
type: object
|
|
22250
|
+
FleetAgentsResponseData:
|
|
22251
|
+
description: The response data containing status and agents array.
|
|
22252
|
+
properties:
|
|
22253
|
+
attributes:
|
|
22254
|
+
$ref: '#/components/schemas/FleetAgentsResponseDataAttributes'
|
|
22255
|
+
id:
|
|
22256
|
+
description: Status identifier.
|
|
22257
|
+
example: done
|
|
22258
|
+
type: string
|
|
22259
|
+
type:
|
|
22260
|
+
description: Resource type.
|
|
22261
|
+
example: status
|
|
22262
|
+
type: string
|
|
22263
|
+
required:
|
|
22264
|
+
- id
|
|
22265
|
+
- type
|
|
22266
|
+
- attributes
|
|
22267
|
+
type: object
|
|
22268
|
+
FleetAgentsResponseDataAttributes:
|
|
22269
|
+
properties:
|
|
22270
|
+
agents:
|
|
22271
|
+
description: Array of agents matching the query criteria.
|
|
22272
|
+
items:
|
|
22273
|
+
$ref: '#/components/schemas/FleetAgentAttributes'
|
|
22274
|
+
type: array
|
|
22275
|
+
type: object
|
|
22276
|
+
FleetAgentsResponseMeta:
|
|
22277
|
+
description: Metadata for the list of agents response.
|
|
22278
|
+
properties:
|
|
22279
|
+
total_filtered_count:
|
|
22280
|
+
description: Total number of agents matching the filter criteria across
|
|
22281
|
+
all pages.
|
|
22282
|
+
example: 150
|
|
22283
|
+
format: int64
|
|
22284
|
+
type: integer
|
|
22285
|
+
type: object
|
|
22286
|
+
FleetConfigurationFile:
|
|
22287
|
+
description: A configuration file for an integration.
|
|
22288
|
+
properties:
|
|
22289
|
+
file_content:
|
|
22290
|
+
description: The raw content of the configuration file.
|
|
22291
|
+
type: string
|
|
22292
|
+
file_path:
|
|
22293
|
+
description: Path to the configuration file.
|
|
22294
|
+
example: /conf.d/postgres.d/postgres.yaml
|
|
22295
|
+
type: string
|
|
22296
|
+
filename:
|
|
22297
|
+
description: Name of the configuration file.
|
|
22298
|
+
example: postgres.yaml
|
|
22299
|
+
type: string
|
|
22300
|
+
type: object
|
|
22301
|
+
FleetConfigurationLayer:
|
|
22302
|
+
description: Configuration information organized by layers.
|
|
22303
|
+
properties:
|
|
22304
|
+
compiled_configuration:
|
|
22305
|
+
description: The final compiled configuration.
|
|
22306
|
+
type: string
|
|
22307
|
+
env_configuration:
|
|
22308
|
+
description: Configuration from environment variables.
|
|
22309
|
+
type: string
|
|
22310
|
+
file_configuration:
|
|
22311
|
+
description: Configuration from files.
|
|
22312
|
+
type: string
|
|
22313
|
+
parsed_configuration:
|
|
22314
|
+
description: Parsed configuration output.
|
|
22315
|
+
type: string
|
|
22316
|
+
remote_configuration:
|
|
22317
|
+
description: Remote configuration settings.
|
|
22318
|
+
type: string
|
|
22319
|
+
runtime_configuration:
|
|
22320
|
+
description: Runtime configuration.
|
|
22321
|
+
type: string
|
|
22322
|
+
type: object
|
|
20915
22323
|
FleetDeployment:
|
|
20916
22324
|
description: A deployment that defines automated configuration changes for a
|
|
20917
22325
|
fleet of hosts.
|
|
@@ -21235,6 +22643,93 @@ components:
|
|
|
21235
22643
|
page:
|
|
21236
22644
|
$ref: '#/components/schemas/FleetDeploymentsPage'
|
|
21237
22645
|
type: object
|
|
22646
|
+
FleetDetectedIntegration:
|
|
22647
|
+
description: An integration detected on the agent but not necessarily configured.
|
|
22648
|
+
properties:
|
|
22649
|
+
escaped_name:
|
|
22650
|
+
description: Escaped integration name.
|
|
22651
|
+
example: postgresql
|
|
22652
|
+
type: string
|
|
22653
|
+
prefix:
|
|
22654
|
+
description: Integration prefix identifier.
|
|
22655
|
+
example: postgres
|
|
22656
|
+
type: string
|
|
22657
|
+
type: object
|
|
22658
|
+
FleetIntegrationDetails:
|
|
22659
|
+
description: Detailed information about a single integration.
|
|
22660
|
+
properties:
|
|
22661
|
+
data_type:
|
|
22662
|
+
description: Type of data collected (metrics, logs).
|
|
22663
|
+
example: metrics
|
|
22664
|
+
type: string
|
|
22665
|
+
error_messages:
|
|
22666
|
+
description: Error messages if the integration has issues.
|
|
22667
|
+
items:
|
|
22668
|
+
type: string
|
|
22669
|
+
type: array
|
|
22670
|
+
init_config:
|
|
22671
|
+
description: Initialization configuration (YAML format).
|
|
22672
|
+
type: string
|
|
22673
|
+
instance_config:
|
|
22674
|
+
description: Instance-specific configuration (YAML format).
|
|
22675
|
+
type: string
|
|
22676
|
+
is_custom_check:
|
|
22677
|
+
description: Whether this is a custom integration.
|
|
22678
|
+
type: boolean
|
|
22679
|
+
log_config:
|
|
22680
|
+
description: Log collection configuration (YAML format).
|
|
22681
|
+
type: string
|
|
22682
|
+
name:
|
|
22683
|
+
description: Name of the integration instance.
|
|
22684
|
+
type: string
|
|
22685
|
+
source_index:
|
|
22686
|
+
description: Index in the configuration file.
|
|
22687
|
+
format: int64
|
|
22688
|
+
type: integer
|
|
22689
|
+
source_path:
|
|
22690
|
+
description: Path to the configuration file.
|
|
22691
|
+
type: string
|
|
22692
|
+
type:
|
|
22693
|
+
description: Integration type.
|
|
22694
|
+
example: postgres
|
|
22695
|
+
type: string
|
|
22696
|
+
type: object
|
|
22697
|
+
FleetIntegrationsByStatus:
|
|
22698
|
+
description: Integrations organized by their status.
|
|
22699
|
+
properties:
|
|
22700
|
+
configuration_files:
|
|
22701
|
+
description: Configuration files for integrations.
|
|
22702
|
+
items:
|
|
22703
|
+
$ref: '#/components/schemas/FleetConfigurationFile'
|
|
22704
|
+
type: array
|
|
22705
|
+
datadog_agent_key:
|
|
22706
|
+
description: The unique agent key identifier.
|
|
22707
|
+
type: string
|
|
22708
|
+
error_integrations:
|
|
22709
|
+
description: Integrations with errors.
|
|
22710
|
+
items:
|
|
22711
|
+
$ref: '#/components/schemas/FleetIntegrationDetails'
|
|
22712
|
+
type: array
|
|
22713
|
+
missing_integrations:
|
|
22714
|
+
description: Detected but not configured integrations.
|
|
22715
|
+
items:
|
|
22716
|
+
$ref: '#/components/schemas/FleetDetectedIntegration'
|
|
22717
|
+
type: array
|
|
22718
|
+
warning_integrations:
|
|
22719
|
+
description: Integrations with warnings.
|
|
22720
|
+
items:
|
|
22721
|
+
$ref: '#/components/schemas/FleetIntegrationDetails'
|
|
22722
|
+
type: array
|
|
22723
|
+
working_integrations:
|
|
22724
|
+
description: Integrations that are working correctly.
|
|
22725
|
+
items:
|
|
22726
|
+
$ref: '#/components/schemas/FleetIntegrationDetails'
|
|
22727
|
+
type: array
|
|
22728
|
+
type: object
|
|
22729
|
+
FleetOtelCollector:
|
|
22730
|
+
additionalProperties: {}
|
|
22731
|
+
description: OpenTelemetry collector information.
|
|
22732
|
+
type: object
|
|
21238
22733
|
FleetSchedule:
|
|
21239
22734
|
description: A schedule that automatically creates deployments based on a recurrence
|
|
21240
22735
|
rule.
|
|
@@ -23433,6 +24928,33 @@ components:
|
|
|
23433
24928
|
example: application/json
|
|
23434
24929
|
type: string
|
|
23435
24930
|
type: object
|
|
24931
|
+
HTTPCDGatesBadRequestResponse:
|
|
24932
|
+
description: Bad request.
|
|
24933
|
+
properties:
|
|
24934
|
+
errors:
|
|
24935
|
+
description: Structured errors.
|
|
24936
|
+
items:
|
|
24937
|
+
$ref: '#/components/schemas/HTTPCIAppError'
|
|
24938
|
+
type: array
|
|
24939
|
+
type: object
|
|
24940
|
+
HTTPCDGatesNotFoundResponse:
|
|
24941
|
+
description: Deployment gate not found.
|
|
24942
|
+
properties:
|
|
24943
|
+
errors:
|
|
24944
|
+
description: Structured errors.
|
|
24945
|
+
items:
|
|
24946
|
+
$ref: '#/components/schemas/HTTPCIAppError'
|
|
24947
|
+
type: array
|
|
24948
|
+
type: object
|
|
24949
|
+
HTTPCDRulesNotFoundResponse:
|
|
24950
|
+
description: Deployment rule not found.
|
|
24951
|
+
properties:
|
|
24952
|
+
errors:
|
|
24953
|
+
description: Structured errors.
|
|
24954
|
+
items:
|
|
24955
|
+
$ref: '#/components/schemas/HTTPCIAppError'
|
|
24956
|
+
type: array
|
|
24957
|
+
type: object
|
|
23436
24958
|
HTTPCIAppError:
|
|
23437
24959
|
description: List of errors.
|
|
23438
24960
|
properties:
|
|
@@ -27892,6 +29414,15 @@ components:
|
|
|
27892
29414
|
description: Jira project key
|
|
27893
29415
|
type: string
|
|
27894
29416
|
type: object
|
|
29417
|
+
JiraIssuesDataType:
|
|
29418
|
+
default: jira_issues
|
|
29419
|
+
description: Jira issues resource type.
|
|
29420
|
+
enum:
|
|
29421
|
+
- jira_issues
|
|
29422
|
+
example: jira_issues
|
|
29423
|
+
type: string
|
|
29424
|
+
x-enum-varnames:
|
|
29425
|
+
- JIRA_ISSUES
|
|
27895
29426
|
JobCreateResponse:
|
|
27896
29427
|
description: Run a threat hunting job response.
|
|
27897
29428
|
properties:
|
|
@@ -28217,6 +29748,10 @@ components:
|
|
|
28217
29748
|
description: The date/time when the rotation starts (ISO 8601).
|
|
28218
29749
|
format: date-time
|
|
28219
29750
|
type: string
|
|
29751
|
+
time_zone:
|
|
29752
|
+
description: The time zone for this layer.
|
|
29753
|
+
example: America/New_York
|
|
29754
|
+
type: string
|
|
28220
29755
|
type: object
|
|
28221
29756
|
LayerAttributesInterval:
|
|
28222
29757
|
description: Defines how often the rotation repeats, using a combination of
|
|
@@ -30115,6 +31650,15 @@ components:
|
|
|
30115
31650
|
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
30116
31651
|
type: string
|
|
30117
31652
|
type: object
|
|
31653
|
+
LogsRestrictionQueriesType:
|
|
31654
|
+
default: logs_restriction_queries
|
|
31655
|
+
description: Restriction query resource type.
|
|
31656
|
+
enum:
|
|
31657
|
+
- logs_restriction_queries
|
|
31658
|
+
example: logs_restriction_queries
|
|
31659
|
+
type: string
|
|
31660
|
+
x-enum-varnames:
|
|
31661
|
+
- LOGS_RESTRICTION_QUERIES
|
|
30118
31662
|
LogsSort:
|
|
30119
31663
|
description: Sort parameters when querying logs.
|
|
30120
31664
|
enum:
|
|
@@ -32305,15 +33849,23 @@ components:
|
|
|
32305
33849
|
properties:
|
|
32306
33850
|
recipients:
|
|
32307
33851
|
$ref: '#/components/schemas/MonitorNotificationRuleRecipients'
|
|
33852
|
+
description: A list of recipients to notify. Uses the same format as the
|
|
33853
|
+
monitor `message` field. Must not start with an '@'.
|
|
32308
33854
|
scope:
|
|
32309
|
-
$ref: '#/components/schemas/
|
|
33855
|
+
$ref: '#/components/schemas/MonitorNotificationRuleConditionScope'
|
|
32310
33856
|
required:
|
|
32311
33857
|
- scope
|
|
32312
33858
|
- recipients
|
|
32313
33859
|
type: object
|
|
33860
|
+
MonitorNotificationRuleConditionScope:
|
|
33861
|
+
description: The scope to which the monitor applied.
|
|
33862
|
+
example: transition_type:alert
|
|
33863
|
+
maxLength: 3000
|
|
33864
|
+
minLength: 1
|
|
33865
|
+
type: string
|
|
32314
33866
|
MonitorNotificationRuleConditionalRecipients:
|
|
32315
33867
|
description: Use conditional recipients to define different recipients for different
|
|
32316
|
-
situations.
|
|
33868
|
+
situations. Cannot be used with `recipients`.
|
|
32317
33869
|
properties:
|
|
32318
33870
|
conditions:
|
|
32319
33871
|
description: Conditions of the notification rule.
|
|
@@ -32363,12 +33915,30 @@ components:
|
|
|
32363
33915
|
description: Filter used to associate the notification rule with monitors.
|
|
32364
33916
|
oneOf:
|
|
32365
33917
|
- $ref: '#/components/schemas/MonitorNotificationRuleFilterTags'
|
|
33918
|
+
- $ref: '#/components/schemas/MonitorNotificationRuleFilterScope'
|
|
33919
|
+
MonitorNotificationRuleFilterScope:
|
|
33920
|
+
additionalProperties: false
|
|
33921
|
+
description: Filter monitor notifications. A monitor notification must match
|
|
33922
|
+
the scope.
|
|
33923
|
+
properties:
|
|
33924
|
+
scope:
|
|
33925
|
+
description: A scope composed of one or several key:value pairs, which can
|
|
33926
|
+
be used to filter monitor notifications on monitor and group tags.
|
|
33927
|
+
example: service:(foo OR bar) AND team:test NOT environment:staging
|
|
33928
|
+
maxLength: 3000
|
|
33929
|
+
minLength: 1
|
|
33930
|
+
type: string
|
|
33931
|
+
required:
|
|
33932
|
+
- scope
|
|
33933
|
+
type: object
|
|
32366
33934
|
MonitorNotificationRuleFilterTags:
|
|
32367
33935
|
additionalProperties: false
|
|
32368
|
-
description: Filter
|
|
33936
|
+
description: Filter monitor notifications by tags. A monitor notification must
|
|
33937
|
+
match all tags.
|
|
32369
33938
|
properties:
|
|
32370
33939
|
tags:
|
|
32371
|
-
description: A list of
|
|
33940
|
+
description: A list of tags (key:value pairs), which can be used to filter
|
|
33941
|
+
monitor notifications on monitor and group tags.
|
|
32372
33942
|
example:
|
|
32373
33943
|
- team:product
|
|
32374
33944
|
- host:abc
|
|
@@ -32408,7 +33978,7 @@ components:
|
|
|
32408
33978
|
type: string
|
|
32409
33979
|
MonitorNotificationRuleRecipients:
|
|
32410
33980
|
description: A list of recipients to notify. Uses the same format as the monitor
|
|
32411
|
-
`message` field. Must not start with an '@'.
|
|
33981
|
+
`message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`.
|
|
32412
33982
|
example:
|
|
32413
33983
|
- slack-test-channel
|
|
32414
33984
|
- jira-test
|
|
@@ -32491,12 +34061,6 @@ components:
|
|
|
32491
34061
|
description: An object related to a monitor notification rule.
|
|
32492
34062
|
oneOf:
|
|
32493
34063
|
- $ref: '#/components/schemas/User'
|
|
32494
|
-
MonitorNotificationRuleScope:
|
|
32495
|
-
description: The scope to which the monitor applied.
|
|
32496
|
-
example: transition_type:alert
|
|
32497
|
-
maxLength: 3000
|
|
32498
|
-
minLength: 1
|
|
32499
|
-
type: string
|
|
32500
34064
|
MonitorNotificationRuleUpdateRequest:
|
|
32501
34065
|
description: Request for updating a monitor notification rule.
|
|
32502
34066
|
properties:
|
|
@@ -34523,7 +36087,6 @@ components:
|
|
|
34523
36087
|
- id
|
|
34524
36088
|
- type
|
|
34525
36089
|
- inputs
|
|
34526
|
-
- auth
|
|
34527
36090
|
- customer_id
|
|
34528
36091
|
type: object
|
|
34529
36092
|
ObservabilityPipelineGoogleChronicleDestinationEncoding:
|
|
@@ -34589,9 +36152,7 @@ components:
|
|
|
34589
36152
|
- type
|
|
34590
36153
|
- inputs
|
|
34591
36154
|
- bucket
|
|
34592
|
-
- auth
|
|
34593
36155
|
- storage_class
|
|
34594
|
-
- acl
|
|
34595
36156
|
type: object
|
|
34596
36157
|
ObservabilityPipelineGoogleCloudStorageDestinationAcl:
|
|
34597
36158
|
description: Access control list setting for objects written to the bucket.
|
|
@@ -34722,7 +36283,6 @@ components:
|
|
|
34722
36283
|
required:
|
|
34723
36284
|
- id
|
|
34724
36285
|
- type
|
|
34725
|
-
- auth
|
|
34726
36286
|
- decoding
|
|
34727
36287
|
- project
|
|
34728
36288
|
- subscription
|
|
@@ -41008,6 +42568,7 @@ components:
|
|
|
41008
42568
|
type: object
|
|
41009
42569
|
RelationshipToUserTeamPermissionData:
|
|
41010
42570
|
description: Related user team permission data
|
|
42571
|
+
nullable: true
|
|
41011
42572
|
properties:
|
|
41012
42573
|
id:
|
|
41013
42574
|
description: The ID of the user team permission
|
|
@@ -41436,6 +42997,191 @@ components:
|
|
|
41436
42997
|
required:
|
|
41437
42998
|
- data
|
|
41438
42999
|
type: object
|
|
43000
|
+
RestrictionQueryAttributes:
|
|
43001
|
+
description: Attributes of the restriction query.
|
|
43002
|
+
properties:
|
|
43003
|
+
created_at:
|
|
43004
|
+
description: Creation time of the restriction query.
|
|
43005
|
+
example: '2020-03-17T21:06:44.000Z'
|
|
43006
|
+
format: date-time
|
|
43007
|
+
readOnly: true
|
|
43008
|
+
type: string
|
|
43009
|
+
last_modifier_email:
|
|
43010
|
+
description: Email of the user who last modified this restriction query.
|
|
43011
|
+
example: user@example.com
|
|
43012
|
+
readOnly: true
|
|
43013
|
+
type: string
|
|
43014
|
+
last_modifier_name:
|
|
43015
|
+
description: Name of the user who last modified this restriction query.
|
|
43016
|
+
example: John Doe
|
|
43017
|
+
readOnly: true
|
|
43018
|
+
type: string
|
|
43019
|
+
modified_at:
|
|
43020
|
+
description: Time of last restriction query modification.
|
|
43021
|
+
example: '2020-03-17T21:15:15.000Z'
|
|
43022
|
+
format: date-time
|
|
43023
|
+
readOnly: true
|
|
43024
|
+
type: string
|
|
43025
|
+
restriction_query:
|
|
43026
|
+
description: The query that defines the restriction. Only the content matching
|
|
43027
|
+
the query can be returned.
|
|
43028
|
+
example: env:sandbox
|
|
43029
|
+
type: string
|
|
43030
|
+
role_count:
|
|
43031
|
+
description: Number of roles associated with this restriction query.
|
|
43032
|
+
example: 3
|
|
43033
|
+
format: int64
|
|
43034
|
+
readOnly: true
|
|
43035
|
+
type: integer
|
|
43036
|
+
user_count:
|
|
43037
|
+
description: Number of users associated with this restriction query.
|
|
43038
|
+
example: 5
|
|
43039
|
+
format: int64
|
|
43040
|
+
readOnly: true
|
|
43041
|
+
type: integer
|
|
43042
|
+
type: object
|
|
43043
|
+
RestrictionQueryCreateAttributes:
|
|
43044
|
+
description: Attributes of the created restriction query.
|
|
43045
|
+
properties:
|
|
43046
|
+
restriction_query:
|
|
43047
|
+
description: The restriction query.
|
|
43048
|
+
example: env:sandbox
|
|
43049
|
+
type: string
|
|
43050
|
+
required:
|
|
43051
|
+
- restriction_query
|
|
43052
|
+
type: object
|
|
43053
|
+
RestrictionQueryCreateData:
|
|
43054
|
+
description: Data related to the creation of a restriction query.
|
|
43055
|
+
properties:
|
|
43056
|
+
attributes:
|
|
43057
|
+
$ref: '#/components/schemas/RestrictionQueryCreateAttributes'
|
|
43058
|
+
type:
|
|
43059
|
+
$ref: '#/components/schemas/LogsRestrictionQueriesType'
|
|
43060
|
+
type: object
|
|
43061
|
+
RestrictionQueryCreatePayload:
|
|
43062
|
+
description: Create a restriction query.
|
|
43063
|
+
properties:
|
|
43064
|
+
data:
|
|
43065
|
+
$ref: '#/components/schemas/RestrictionQueryCreateData'
|
|
43066
|
+
type: object
|
|
43067
|
+
RestrictionQueryListResponse:
|
|
43068
|
+
description: Response containing information about multiple restriction queries.
|
|
43069
|
+
properties:
|
|
43070
|
+
data:
|
|
43071
|
+
description: Array of returned restriction queries.
|
|
43072
|
+
items:
|
|
43073
|
+
$ref: '#/components/schemas/RestrictionQueryWithoutRelationships'
|
|
43074
|
+
type: array
|
|
43075
|
+
type: object
|
|
43076
|
+
RestrictionQueryResponseIncludedItem:
|
|
43077
|
+
description: An object related to a restriction query.
|
|
43078
|
+
oneOf:
|
|
43079
|
+
- $ref: '#/components/schemas/RestrictionQueryRole'
|
|
43080
|
+
RestrictionQueryRole:
|
|
43081
|
+
description: Partial role object.
|
|
43082
|
+
properties:
|
|
43083
|
+
attributes:
|
|
43084
|
+
$ref: '#/components/schemas/RestrictionQueryRoleAttribute'
|
|
43085
|
+
id:
|
|
43086
|
+
description: ID of the role.
|
|
43087
|
+
example: <ROLE_ID>
|
|
43088
|
+
type: string
|
|
43089
|
+
type:
|
|
43090
|
+
$ref: '#/components/schemas/RolesType'
|
|
43091
|
+
required:
|
|
43092
|
+
- type
|
|
43093
|
+
- id
|
|
43094
|
+
- attributes
|
|
43095
|
+
type: object
|
|
43096
|
+
RestrictionQueryRoleAttribute:
|
|
43097
|
+
description: Attributes of the role for a restriction query.
|
|
43098
|
+
properties:
|
|
43099
|
+
name:
|
|
43100
|
+
description: The role name.
|
|
43101
|
+
example: Datadog Admin Role
|
|
43102
|
+
type: string
|
|
43103
|
+
type: object
|
|
43104
|
+
RestrictionQueryRolesResponse:
|
|
43105
|
+
description: Response containing information about roles attached to a restriction
|
|
43106
|
+
query.
|
|
43107
|
+
properties:
|
|
43108
|
+
data:
|
|
43109
|
+
description: Array of roles.
|
|
43110
|
+
items:
|
|
43111
|
+
$ref: '#/components/schemas/RestrictionQueryRole'
|
|
43112
|
+
type: array
|
|
43113
|
+
type: object
|
|
43114
|
+
RestrictionQueryUpdateAttributes:
|
|
43115
|
+
description: Attributes of the edited restriction query.
|
|
43116
|
+
properties:
|
|
43117
|
+
restriction_query:
|
|
43118
|
+
description: The restriction query.
|
|
43119
|
+
example: env:sandbox
|
|
43120
|
+
type: string
|
|
43121
|
+
required:
|
|
43122
|
+
- restriction_query
|
|
43123
|
+
type: object
|
|
43124
|
+
RestrictionQueryUpdateData:
|
|
43125
|
+
description: Data related to the update of a restriction query.
|
|
43126
|
+
properties:
|
|
43127
|
+
attributes:
|
|
43128
|
+
$ref: '#/components/schemas/RestrictionQueryUpdateAttributes'
|
|
43129
|
+
type:
|
|
43130
|
+
$ref: '#/components/schemas/LogsRestrictionQueriesType'
|
|
43131
|
+
type: object
|
|
43132
|
+
RestrictionQueryUpdatePayload:
|
|
43133
|
+
description: Update a restriction query.
|
|
43134
|
+
properties:
|
|
43135
|
+
data:
|
|
43136
|
+
$ref: '#/components/schemas/RestrictionQueryUpdateData'
|
|
43137
|
+
type: object
|
|
43138
|
+
RestrictionQueryWithRelationships:
|
|
43139
|
+
description: Restriction query object returned by the API.
|
|
43140
|
+
properties:
|
|
43141
|
+
attributes:
|
|
43142
|
+
$ref: '#/components/schemas/RestrictionQueryAttributes'
|
|
43143
|
+
id:
|
|
43144
|
+
description: ID of the restriction query.
|
|
43145
|
+
example: 79a0e60a-644a-11ea-ad29-43329f7f58b5
|
|
43146
|
+
type: string
|
|
43147
|
+
relationships:
|
|
43148
|
+
$ref: '#/components/schemas/UserRelationships'
|
|
43149
|
+
type:
|
|
43150
|
+
$ref: '#/components/schemas/LogsRestrictionQueriesType'
|
|
43151
|
+
type: object
|
|
43152
|
+
RestrictionQueryWithRelationshipsResponse:
|
|
43153
|
+
description: Response containing information about a single restriction query.
|
|
43154
|
+
properties:
|
|
43155
|
+
data:
|
|
43156
|
+
$ref: '#/components/schemas/RestrictionQueryWithRelationships'
|
|
43157
|
+
included:
|
|
43158
|
+
description: Array of objects related to the restriction query.
|
|
43159
|
+
items:
|
|
43160
|
+
$ref: '#/components/schemas/RestrictionQueryResponseIncludedItem'
|
|
43161
|
+
type: array
|
|
43162
|
+
type: object
|
|
43163
|
+
RestrictionQueryWithoutRelationships:
|
|
43164
|
+
description: Restriction query object returned by the API.
|
|
43165
|
+
properties:
|
|
43166
|
+
attributes:
|
|
43167
|
+
$ref: '#/components/schemas/RestrictionQueryAttributes'
|
|
43168
|
+
id:
|
|
43169
|
+
description: ID of the restriction query.
|
|
43170
|
+
example: 79a0e60a-644a-11ea-ad29-43329f7f58b5
|
|
43171
|
+
type: string
|
|
43172
|
+
type:
|
|
43173
|
+
default: logs_restriction_queries
|
|
43174
|
+
description: Restriction queries type.
|
|
43175
|
+
example: logs_restriction_queries
|
|
43176
|
+
readOnly: true
|
|
43177
|
+
type: string
|
|
43178
|
+
type: object
|
|
43179
|
+
RestrictionQueryWithoutRelationshipsResponse:
|
|
43180
|
+
description: Response containing information about a single restriction query.
|
|
43181
|
+
properties:
|
|
43182
|
+
data:
|
|
43183
|
+
$ref: '#/components/schemas/RestrictionQueryWithoutRelationships'
|
|
43184
|
+
type: object
|
|
41439
43185
|
RetentionFilter:
|
|
41440
43186
|
description: The definition of the retention filter.
|
|
41441
43187
|
properties:
|
|
@@ -44321,6 +46067,10 @@ components:
|
|
|
44321
46067
|
example: '2025-01-01T00:00:00Z'
|
|
44322
46068
|
format: date-time
|
|
44323
46069
|
type: string
|
|
46070
|
+
time_zone:
|
|
46071
|
+
description: The time zone for this layer.
|
|
46072
|
+
example: America/New_York
|
|
46073
|
+
type: string
|
|
44324
46074
|
required:
|
|
44325
46075
|
- name
|
|
44326
46076
|
- interval
|
|
@@ -44511,7 +46261,8 @@ components:
|
|
|
44511
46261
|
type: object
|
|
44512
46262
|
ScheduleTarget:
|
|
44513
46263
|
description: Represents a schedule target for an escalation policy step, including
|
|
44514
|
-
its ID and resource type.
|
|
46264
|
+
its ID and resource type. This is a shortcut for a configured schedule target
|
|
46265
|
+
with position set to 'current'.
|
|
44515
46266
|
properties:
|
|
44516
46267
|
id:
|
|
44517
46268
|
description: Specifies the unique identifier of the schedule resource.
|
|
@@ -44523,6 +46274,19 @@ components:
|
|
|
44523
46274
|
- type
|
|
44524
46275
|
- id
|
|
44525
46276
|
type: object
|
|
46277
|
+
ScheduleTargetPosition:
|
|
46278
|
+
description: Specifies the position of a schedule target (example `previous`,
|
|
46279
|
+
`current`, or `next`).
|
|
46280
|
+
enum:
|
|
46281
|
+
- previous
|
|
46282
|
+
- current
|
|
46283
|
+
- next
|
|
46284
|
+
example: previous
|
|
46285
|
+
type: string
|
|
46286
|
+
x-enum-varnames:
|
|
46287
|
+
- PREVIOUS
|
|
46288
|
+
- CURRENT
|
|
46289
|
+
- NEXT
|
|
44526
46290
|
ScheduleTargetType:
|
|
44527
46291
|
default: schedules
|
|
44528
46292
|
description: Indicates that the resource is of type `schedules`.
|
|
@@ -44671,6 +46435,10 @@ components:
|
|
|
44671
46435
|
example: '2025-02-01T00:00:00Z'
|
|
44672
46436
|
format: date-time
|
|
44673
46437
|
type: string
|
|
46438
|
+
time_zone:
|
|
46439
|
+
description: The time zone for this layer.
|
|
46440
|
+
example: America/New_York
|
|
46441
|
+
type: string
|
|
44674
46442
|
required:
|
|
44675
46443
|
- effective_date
|
|
44676
46444
|
- interval
|
|
@@ -51089,32 +52857,35 @@ components:
|
|
|
51089
52857
|
type: string
|
|
51090
52858
|
type: object
|
|
51091
52859
|
TableResultV2DataAttributesFileMetadata:
|
|
51092
|
-
description: Metadata specifying where and how to access the reference table's
|
|
51093
|
-
data file.
|
|
51094
|
-
oneOf:
|
|
51095
|
-
- $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorage'
|
|
51096
|
-
- $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataLocalFile'
|
|
51097
|
-
TableResultV2DataAttributesFileMetadataCloudStorage:
|
|
51098
52860
|
additionalProperties: false
|
|
51099
|
-
description:
|
|
52861
|
+
description: "Metadata specifying where and how to access the reference table's
|
|
52862
|
+
data file.\n\nFor cloud storage tables (S3/GCS/Azure):\n - sync_enabled and
|
|
52863
|
+
access_details will always be present\n - error fields (error_message, error_row_count,
|
|
52864
|
+
error_type) are present only when errors occur\n\nFor local file tables:\n
|
|
52865
|
+
\ - error fields (error_message, error_row_count) are present only when errors
|
|
52866
|
+
occur\n - sync_enabled, access_details are never present"
|
|
51100
52867
|
properties:
|
|
51101
52868
|
access_details:
|
|
51102
52869
|
$ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetails'
|
|
52870
|
+
description: Cloud storage access configuration. Only present for cloud
|
|
52871
|
+
storage sources (S3, GCS, Azure).
|
|
51103
52872
|
error_message:
|
|
51104
|
-
description: The error message returned from the sync
|
|
52873
|
+
description: The error message returned from the last operation (sync for
|
|
52874
|
+
cloud storage, upload for local file).
|
|
51105
52875
|
type: string
|
|
51106
52876
|
error_row_count:
|
|
51107
|
-
description: The number of rows that failed to
|
|
52877
|
+
description: The number of rows that failed to process.
|
|
51108
52878
|
format: int64
|
|
51109
52879
|
type: integer
|
|
51110
52880
|
error_type:
|
|
51111
52881
|
$ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorageErrorType'
|
|
52882
|
+
description: The type of error that occurred during file processing. Only
|
|
52883
|
+
applicable for cloud storage sources.
|
|
51112
52884
|
sync_enabled:
|
|
51113
|
-
description: Whether this table is synced automatically.
|
|
52885
|
+
description: Whether this table is synced automatically from cloud storage.
|
|
52886
|
+
Only applicable for cloud storage sources.
|
|
51114
52887
|
type: boolean
|
|
51115
|
-
|
|
51116
|
-
- access_details
|
|
51117
|
-
title: CloudFileMetadataV2
|
|
52888
|
+
title: FileMetadataV2
|
|
51118
52889
|
type: object
|
|
51119
52890
|
TableResultV2DataAttributesFileMetadataCloudStorageErrorType:
|
|
51120
52891
|
description: The type of error that occurred during file processing. This field
|
|
@@ -51141,21 +52912,6 @@ components:
|
|
|
51141
52912
|
- STATE_ERROR
|
|
51142
52913
|
- OPERATION_ERROR
|
|
51143
52914
|
- SYSTEM_ERROR
|
|
51144
|
-
TableResultV2DataAttributesFileMetadataLocalFile:
|
|
51145
|
-
additionalProperties: false
|
|
51146
|
-
description: File metadata for reference tables created by upload. Note that
|
|
51147
|
-
upload_id is only returned in the immediate create/replace response and is
|
|
51148
|
-
not available in subsequent GET requests.
|
|
51149
|
-
properties:
|
|
51150
|
-
error_message:
|
|
51151
|
-
description: The error message returned from the creation/update.
|
|
51152
|
-
type: string
|
|
51153
|
-
error_row_count:
|
|
51154
|
-
description: The number of rows that failed to create/update.
|
|
51155
|
-
format: int64
|
|
51156
|
-
type: integer
|
|
51157
|
-
title: LocalFileMetadataV2
|
|
51158
|
-
type: object
|
|
51159
52915
|
TableResultV2DataAttributesFileMetadataOneOfAccessDetails:
|
|
51160
52916
|
description: Cloud storage access configuration for the reference table data
|
|
51161
52917
|
file.
|
|
@@ -51406,7 +53162,11 @@ components:
|
|
|
51406
53162
|
items:
|
|
51407
53163
|
description: String identifier of the module
|
|
51408
53164
|
type: string
|
|
53165
|
+
nullable: true
|
|
51409
53166
|
type: array
|
|
53167
|
+
is_managed:
|
|
53168
|
+
description: Whether the team is managed from an external source
|
|
53169
|
+
type: boolean
|
|
51410
53170
|
link_count:
|
|
51411
53171
|
description: The number of links belonging to the team
|
|
51412
53172
|
format: int32
|
|
@@ -51438,6 +53198,7 @@ components:
|
|
|
51438
53198
|
items:
|
|
51439
53199
|
description: String identifier of the module
|
|
51440
53200
|
type: string
|
|
53201
|
+
nullable: true
|
|
51441
53202
|
type: array
|
|
51442
53203
|
required:
|
|
51443
53204
|
- handle
|
|
@@ -51618,6 +53379,211 @@ components:
|
|
|
51618
53379
|
required:
|
|
51619
53380
|
- data
|
|
51620
53381
|
type: object
|
|
53382
|
+
TeamHierarchyLink:
|
|
53383
|
+
description: Team hierarchy link
|
|
53384
|
+
properties:
|
|
53385
|
+
attributes:
|
|
53386
|
+
$ref: '#/components/schemas/TeamHierarchyLinkAttributes'
|
|
53387
|
+
id:
|
|
53388
|
+
description: The team hierarchy link's identifier
|
|
53389
|
+
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
|
|
53390
|
+
type: string
|
|
53391
|
+
relationships:
|
|
53392
|
+
$ref: '#/components/schemas/TeamHierarchyLinkRelationships'
|
|
53393
|
+
type:
|
|
53394
|
+
$ref: '#/components/schemas/TeamHierarchyLinkType'
|
|
53395
|
+
required:
|
|
53396
|
+
- attributes
|
|
53397
|
+
- id
|
|
53398
|
+
- type
|
|
53399
|
+
type: object
|
|
53400
|
+
TeamHierarchyLinkAttributes:
|
|
53401
|
+
description: Team hierarchy link attributes
|
|
53402
|
+
properties:
|
|
53403
|
+
created_at:
|
|
53404
|
+
description: Timestamp when the team hierarchy link was created
|
|
53405
|
+
example: ''
|
|
53406
|
+
format: date-time
|
|
53407
|
+
type: string
|
|
53408
|
+
provisioned_by:
|
|
53409
|
+
description: The provisioner of the team hierarchy link
|
|
53410
|
+
example: system
|
|
53411
|
+
type: string
|
|
53412
|
+
required:
|
|
53413
|
+
- provisioned_by
|
|
53414
|
+
- created_at
|
|
53415
|
+
type: object
|
|
53416
|
+
TeamHierarchyLinkCreate:
|
|
53417
|
+
description: Data provided when creating a team hierarchy link
|
|
53418
|
+
properties:
|
|
53419
|
+
relationships:
|
|
53420
|
+
$ref: '#/components/schemas/TeamHierarchyLinkCreateRelationships'
|
|
53421
|
+
type:
|
|
53422
|
+
$ref: '#/components/schemas/TeamHierarchyLinkType'
|
|
53423
|
+
required:
|
|
53424
|
+
- relationships
|
|
53425
|
+
- type
|
|
53426
|
+
type: object
|
|
53427
|
+
TeamHierarchyLinkCreateRelationships:
|
|
53428
|
+
description: The related teams that will be connected by the team hierarchy
|
|
53429
|
+
link
|
|
53430
|
+
properties:
|
|
53431
|
+
parent_team:
|
|
53432
|
+
$ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship'
|
|
53433
|
+
sub_team:
|
|
53434
|
+
$ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship'
|
|
53435
|
+
required:
|
|
53436
|
+
- parent_team
|
|
53437
|
+
- sub_team
|
|
53438
|
+
type: object
|
|
53439
|
+
TeamHierarchyLinkCreateRequest:
|
|
53440
|
+
description: Request to create a team hierarchy link
|
|
53441
|
+
properties:
|
|
53442
|
+
data:
|
|
53443
|
+
$ref: '#/components/schemas/TeamHierarchyLinkCreate'
|
|
53444
|
+
required:
|
|
53445
|
+
- data
|
|
53446
|
+
type: object
|
|
53447
|
+
TeamHierarchyLinkCreateTeam:
|
|
53448
|
+
description: This schema defines the attributes about each team that has to
|
|
53449
|
+
be provided when creating a team hierarchy link
|
|
53450
|
+
properties:
|
|
53451
|
+
id:
|
|
53452
|
+
description: The team's identifier
|
|
53453
|
+
example: 692e8073-12c4-4c71-8408-5090bd44c9c8
|
|
53454
|
+
type: string
|
|
53455
|
+
type:
|
|
53456
|
+
$ref: '#/components/schemas/TeamType'
|
|
53457
|
+
required:
|
|
53458
|
+
- id
|
|
53459
|
+
- type
|
|
53460
|
+
type: object
|
|
53461
|
+
TeamHierarchyLinkCreateTeamRelationship:
|
|
53462
|
+
description: Data about each team that will be connected by the team hierarchy
|
|
53463
|
+
link
|
|
53464
|
+
properties:
|
|
53465
|
+
data:
|
|
53466
|
+
$ref: '#/components/schemas/TeamHierarchyLinkCreateTeam'
|
|
53467
|
+
required:
|
|
53468
|
+
- data
|
|
53469
|
+
type: object
|
|
53470
|
+
TeamHierarchyLinkRelationships:
|
|
53471
|
+
description: Team hierarchy link relationships
|
|
53472
|
+
properties:
|
|
53473
|
+
parent_team:
|
|
53474
|
+
$ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship'
|
|
53475
|
+
sub_team:
|
|
53476
|
+
$ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship'
|
|
53477
|
+
required:
|
|
53478
|
+
- parent_team
|
|
53479
|
+
- sub_team
|
|
53480
|
+
type: object
|
|
53481
|
+
TeamHierarchyLinkResponse:
|
|
53482
|
+
description: Team hierarchy link response
|
|
53483
|
+
properties:
|
|
53484
|
+
data:
|
|
53485
|
+
$ref: '#/components/schemas/TeamHierarchyLink'
|
|
53486
|
+
included:
|
|
53487
|
+
description: Included teams
|
|
53488
|
+
items:
|
|
53489
|
+
$ref: '#/components/schemas/TeamHierarchyLinkTeam'
|
|
53490
|
+
type: array
|
|
53491
|
+
links:
|
|
53492
|
+
$ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks'
|
|
53493
|
+
type: object
|
|
53494
|
+
TeamHierarchyLinkTeam:
|
|
53495
|
+
description: Team hierarchy links connect different teams. This represents team
|
|
53496
|
+
objects that are connected by the team hierarchy link.
|
|
53497
|
+
properties:
|
|
53498
|
+
attributes:
|
|
53499
|
+
$ref: '#/components/schemas/TeamHierarchyLinkTeamAttributes'
|
|
53500
|
+
id:
|
|
53501
|
+
description: The team's identifier
|
|
53502
|
+
example: 692e8073-12c4-4c71-8408-5090bd44c9c8
|
|
53503
|
+
type: string
|
|
53504
|
+
type:
|
|
53505
|
+
$ref: '#/components/schemas/TeamType'
|
|
53506
|
+
required:
|
|
53507
|
+
- id
|
|
53508
|
+
- type
|
|
53509
|
+
type: object
|
|
53510
|
+
TeamHierarchyLinkTeamAttributes:
|
|
53511
|
+
description: Team hierarchy links connect different teams. This represents attributes
|
|
53512
|
+
from teams that are connected by the team hierarchy link.
|
|
53513
|
+
properties:
|
|
53514
|
+
avatar:
|
|
53515
|
+
description: The team's avatar
|
|
53516
|
+
nullable: true
|
|
53517
|
+
type: string
|
|
53518
|
+
banner:
|
|
53519
|
+
description: The team's banner
|
|
53520
|
+
format: int64
|
|
53521
|
+
type: integer
|
|
53522
|
+
handle:
|
|
53523
|
+
description: The team's handle
|
|
53524
|
+
example: team-handle
|
|
53525
|
+
type: string
|
|
53526
|
+
is_managed:
|
|
53527
|
+
description: Whether the team is managed
|
|
53528
|
+
type: boolean
|
|
53529
|
+
is_open_membership:
|
|
53530
|
+
description: Whether the team has open membership
|
|
53531
|
+
type: boolean
|
|
53532
|
+
link_count:
|
|
53533
|
+
description: The number of links for the team
|
|
53534
|
+
format: int64
|
|
53535
|
+
type: integer
|
|
53536
|
+
name:
|
|
53537
|
+
description: The team's name
|
|
53538
|
+
example: Team Name
|
|
53539
|
+
type: string
|
|
53540
|
+
summary:
|
|
53541
|
+
description: The team's summary
|
|
53542
|
+
nullable: true
|
|
53543
|
+
type: string
|
|
53544
|
+
user_count:
|
|
53545
|
+
description: The number of users in the team
|
|
53546
|
+
format: int64
|
|
53547
|
+
type: integer
|
|
53548
|
+
required:
|
|
53549
|
+
- handle
|
|
53550
|
+
- name
|
|
53551
|
+
type: object
|
|
53552
|
+
TeamHierarchyLinkTeamRelationship:
|
|
53553
|
+
description: Team hierarchy link team relationship
|
|
53554
|
+
properties:
|
|
53555
|
+
data:
|
|
53556
|
+
$ref: '#/components/schemas/TeamHierarchyLinkTeam'
|
|
53557
|
+
required:
|
|
53558
|
+
- data
|
|
53559
|
+
type: object
|
|
53560
|
+
TeamHierarchyLinkType:
|
|
53561
|
+
default: team_hierarchy_links
|
|
53562
|
+
description: Team hierarchy link type
|
|
53563
|
+
enum:
|
|
53564
|
+
- team_hierarchy_links
|
|
53565
|
+
example: team_hierarchy_links
|
|
53566
|
+
type: string
|
|
53567
|
+
x-enum-varnames:
|
|
53568
|
+
- TEAM_HIERARCHY_LINKS
|
|
53569
|
+
TeamHierarchyLinksResponse:
|
|
53570
|
+
description: Team hierarchy links response
|
|
53571
|
+
properties:
|
|
53572
|
+
data:
|
|
53573
|
+
description: Team hierarchy links response data
|
|
53574
|
+
items:
|
|
53575
|
+
$ref: '#/components/schemas/TeamHierarchyLink'
|
|
53576
|
+
type: array
|
|
53577
|
+
included:
|
|
53578
|
+
description: Included teams
|
|
53579
|
+
items:
|
|
53580
|
+
$ref: '#/components/schemas/TeamHierarchyLinkTeam'
|
|
53581
|
+
type: array
|
|
53582
|
+
links:
|
|
53583
|
+
$ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks'
|
|
53584
|
+
meta:
|
|
53585
|
+
$ref: '#/components/schemas/TeamsHierarchyLinksResponseMeta'
|
|
53586
|
+
type: object
|
|
51621
53587
|
TeamIncluded:
|
|
51622
53588
|
description: Included resources related to the team
|
|
51623
53589
|
oneOf:
|
|
@@ -52263,14 +54229,31 @@ components:
|
|
|
52263
54229
|
TeamSyncAttributes:
|
|
52264
54230
|
description: Team sync attributes.
|
|
52265
54231
|
properties:
|
|
54232
|
+
frequency:
|
|
54233
|
+
$ref: '#/components/schemas/TeamSyncAttributesFrequency'
|
|
52266
54234
|
source:
|
|
52267
54235
|
$ref: '#/components/schemas/TeamSyncAttributesSource'
|
|
54236
|
+
sync_membership:
|
|
54237
|
+
$ref: '#/components/schemas/TeamSyncAttributesSyncMembership'
|
|
52268
54238
|
type:
|
|
52269
54239
|
$ref: '#/components/schemas/TeamSyncAttributesType'
|
|
52270
54240
|
required:
|
|
52271
54241
|
- source
|
|
52272
54242
|
- type
|
|
52273
54243
|
type: object
|
|
54244
|
+
TeamSyncAttributesFrequency:
|
|
54245
|
+
description: How often the sync process should be run. Defaults to `once` when
|
|
54246
|
+
not provided.
|
|
54247
|
+
enum:
|
|
54248
|
+
- once
|
|
54249
|
+
- continuously
|
|
54250
|
+
- paused
|
|
54251
|
+
example: once
|
|
54252
|
+
type: string
|
|
54253
|
+
x-enum-varnames:
|
|
54254
|
+
- ONCE
|
|
54255
|
+
- CONTINUOUSLY
|
|
54256
|
+
- PAUSED
|
|
52274
54257
|
TeamSyncAttributesSource:
|
|
52275
54258
|
description: The external source platform for team synchronization. Only "github"
|
|
52276
54259
|
is supported.
|
|
@@ -52280,15 +54263,22 @@ components:
|
|
|
52280
54263
|
type: string
|
|
52281
54264
|
x-enum-varnames:
|
|
52282
54265
|
- GITHUB
|
|
54266
|
+
TeamSyncAttributesSyncMembership:
|
|
54267
|
+
description: Whether to sync members from the external team to the Datadog team.
|
|
54268
|
+
Defaults to `false` when not provided.
|
|
54269
|
+
example: true
|
|
54270
|
+
type: boolean
|
|
52283
54271
|
TeamSyncAttributesType:
|
|
52284
|
-
description: The type of synchronization operation.
|
|
52285
|
-
|
|
54272
|
+
description: The type of synchronization operation. "link" connects teams by
|
|
54273
|
+
matching names. "provision" creates new teams when no match is found.
|
|
52286
54274
|
enum:
|
|
52287
54275
|
- link
|
|
54276
|
+
- provision
|
|
52288
54277
|
example: link
|
|
52289
54278
|
type: string
|
|
52290
54279
|
x-enum-varnames:
|
|
52291
54280
|
- LINK
|
|
54281
|
+
- PROVISION
|
|
52292
54282
|
TeamSyncBulkType:
|
|
52293
54283
|
description: Team sync bulk type.
|
|
52294
54284
|
enum:
|
|
@@ -52298,10 +54288,15 @@ components:
|
|
|
52298
54288
|
x-enum-varnames:
|
|
52299
54289
|
- TEAM_SYNC_BULK
|
|
52300
54290
|
TeamSyncData:
|
|
52301
|
-
description:
|
|
54291
|
+
description: A configuration governing syncing between Datadog teams and teams
|
|
54292
|
+
from an external system.
|
|
52302
54293
|
properties:
|
|
52303
54294
|
attributes:
|
|
52304
54295
|
$ref: '#/components/schemas/TeamSyncAttributes'
|
|
54296
|
+
id:
|
|
54297
|
+
description: The sync's identifier
|
|
54298
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
54299
|
+
type: string
|
|
52305
54300
|
type:
|
|
52306
54301
|
$ref: '#/components/schemas/TeamSyncBulkType'
|
|
52307
54302
|
required:
|
|
@@ -52322,6 +54317,15 @@ components:
|
|
|
52322
54317
|
required:
|
|
52323
54318
|
- data
|
|
52324
54319
|
type: object
|
|
54320
|
+
TeamSyncResponse:
|
|
54321
|
+
description: Team sync configurations response.
|
|
54322
|
+
properties:
|
|
54323
|
+
data:
|
|
54324
|
+
description: List of team sync configurations
|
|
54325
|
+
items:
|
|
54326
|
+
$ref: '#/components/schemas/TeamSyncData'
|
|
54327
|
+
type: array
|
|
54328
|
+
type: object
|
|
52325
54329
|
TeamTarget:
|
|
52326
54330
|
description: Represents a team target for an escalation policy step, including
|
|
52327
54331
|
the team's ID and resource type.
|
|
@@ -52459,6 +54463,76 @@ components:
|
|
|
52459
54463
|
- LINK_COUNT
|
|
52460
54464
|
- TEAM_LINKS
|
|
52461
54465
|
- USER_TEAM_PERMISSIONS
|
|
54466
|
+
TeamsHierarchyLinksResponseLinks:
|
|
54467
|
+
description: When querying team hierarchy links, a set of links for navigation
|
|
54468
|
+
between different pages is included
|
|
54469
|
+
properties:
|
|
54470
|
+
first:
|
|
54471
|
+
description: Link to the first page.
|
|
54472
|
+
nullable: true
|
|
54473
|
+
type: string
|
|
54474
|
+
last:
|
|
54475
|
+
description: Link to the last page.
|
|
54476
|
+
nullable: true
|
|
54477
|
+
type: string
|
|
54478
|
+
next:
|
|
54479
|
+
description: Link to the next page.
|
|
54480
|
+
nullable: true
|
|
54481
|
+
type: string
|
|
54482
|
+
prev:
|
|
54483
|
+
description: Link to the previous page.
|
|
54484
|
+
nullable: true
|
|
54485
|
+
type: string
|
|
54486
|
+
self:
|
|
54487
|
+
description: Link to the current object.
|
|
54488
|
+
type: string
|
|
54489
|
+
type: object
|
|
54490
|
+
TeamsHierarchyLinksResponseMeta:
|
|
54491
|
+
description: Metadata that is included in the response when querying the team
|
|
54492
|
+
hierarchy links
|
|
54493
|
+
properties:
|
|
54494
|
+
page:
|
|
54495
|
+
$ref: '#/components/schemas/TeamsHierarchyLinksResponseMetaPage'
|
|
54496
|
+
type: object
|
|
54497
|
+
TeamsHierarchyLinksResponseMetaPage:
|
|
54498
|
+
description: Metadata related to paging information that is included in the
|
|
54499
|
+
response when querying the team hierarchy links
|
|
54500
|
+
properties:
|
|
54501
|
+
first_number:
|
|
54502
|
+
description: First page number.
|
|
54503
|
+
format: int64
|
|
54504
|
+
type: integer
|
|
54505
|
+
last_number:
|
|
54506
|
+
description: Last page number.
|
|
54507
|
+
format: int64
|
|
54508
|
+
type: integer
|
|
54509
|
+
next_number:
|
|
54510
|
+
description: Next page number.
|
|
54511
|
+
format: int64
|
|
54512
|
+
nullable: true
|
|
54513
|
+
type: integer
|
|
54514
|
+
number:
|
|
54515
|
+
description: Page number.
|
|
54516
|
+
format: int64
|
|
54517
|
+
type: integer
|
|
54518
|
+
prev_number:
|
|
54519
|
+
description: Previous page number.
|
|
54520
|
+
format: int64
|
|
54521
|
+
nullable: true
|
|
54522
|
+
type: integer
|
|
54523
|
+
size:
|
|
54524
|
+
description: Page size.
|
|
54525
|
+
format: int64
|
|
54526
|
+
type: integer
|
|
54527
|
+
total:
|
|
54528
|
+
description: Total number of results.
|
|
54529
|
+
format: int64
|
|
54530
|
+
type: integer
|
|
54531
|
+
type:
|
|
54532
|
+
description: Pagination type.
|
|
54533
|
+
example: number_size
|
|
54534
|
+
type: string
|
|
54535
|
+
type: object
|
|
52462
54536
|
TeamsResponse:
|
|
52463
54537
|
description: Response with multiple teams
|
|
52464
54538
|
properties:
|
|
@@ -52651,6 +54725,9 @@ components:
|
|
|
52651
54725
|
modifiedAt:
|
|
52652
54726
|
description: Last modification time of the job.
|
|
52653
54727
|
type: string
|
|
54728
|
+
signalOutput:
|
|
54729
|
+
description: Whether the job outputs signals.
|
|
54730
|
+
type: boolean
|
|
52654
54731
|
type: object
|
|
52655
54732
|
ThreatHuntingJobResponseData:
|
|
52656
54733
|
description: Threat hunting job response data.
|
|
@@ -53580,6 +55657,77 @@ components:
|
|
|
53580
55657
|
required:
|
|
53581
55658
|
- data
|
|
53582
55659
|
type: object
|
|
55660
|
+
UpdateDeploymentGateParams:
|
|
55661
|
+
description: Parameters for updating a deployment gate.
|
|
55662
|
+
properties:
|
|
55663
|
+
data:
|
|
55664
|
+
$ref: '#/components/schemas/UpdateDeploymentGateParamsData'
|
|
55665
|
+
required:
|
|
55666
|
+
- data
|
|
55667
|
+
type: object
|
|
55668
|
+
UpdateDeploymentGateParamsData:
|
|
55669
|
+
description: Parameters for updating a deployment gate.
|
|
55670
|
+
properties:
|
|
55671
|
+
attributes:
|
|
55672
|
+
$ref: '#/components/schemas/UpdateDeploymentGateParamsDataAttributes'
|
|
55673
|
+
id:
|
|
55674
|
+
description: Unique identifier of the deployment gate.
|
|
55675
|
+
example: 12345678-1234-1234-1234-123456789012
|
|
55676
|
+
type: string
|
|
55677
|
+
type:
|
|
55678
|
+
$ref: '#/components/schemas/DeploymentGateDataType'
|
|
55679
|
+
required:
|
|
55680
|
+
- type
|
|
55681
|
+
- id
|
|
55682
|
+
- attributes
|
|
55683
|
+
type: object
|
|
55684
|
+
UpdateDeploymentGateParamsDataAttributes:
|
|
55685
|
+
description: Attributes for updating a deployment gate.
|
|
55686
|
+
properties:
|
|
55687
|
+
dry_run:
|
|
55688
|
+
description: Whether to run in dry-run mode.
|
|
55689
|
+
example: false
|
|
55690
|
+
type: boolean
|
|
55691
|
+
required:
|
|
55692
|
+
- dry_run
|
|
55693
|
+
type: object
|
|
55694
|
+
UpdateDeploymentRuleParams:
|
|
55695
|
+
description: Parameters for updating a deployment rule.
|
|
55696
|
+
properties:
|
|
55697
|
+
data:
|
|
55698
|
+
$ref: '#/components/schemas/UpdateDeploymentRuleParamsData'
|
|
55699
|
+
required:
|
|
55700
|
+
- data
|
|
55701
|
+
type: object
|
|
55702
|
+
UpdateDeploymentRuleParamsData:
|
|
55703
|
+
description: Parameters for updating a deployment rule.
|
|
55704
|
+
properties:
|
|
55705
|
+
attributes:
|
|
55706
|
+
$ref: '#/components/schemas/UpdateDeploymentRuleParamsDataAttributes'
|
|
55707
|
+
type:
|
|
55708
|
+
$ref: '#/components/schemas/DeploymentRuleDataType'
|
|
55709
|
+
required:
|
|
55710
|
+
- type
|
|
55711
|
+
- attributes
|
|
55712
|
+
type: object
|
|
55713
|
+
UpdateDeploymentRuleParamsDataAttributes:
|
|
55714
|
+
description: Parameters for updating a deployment rule.
|
|
55715
|
+
properties:
|
|
55716
|
+
dry_run:
|
|
55717
|
+
description: Whether to run this rule in dry-run mode.
|
|
55718
|
+
example: false
|
|
55719
|
+
type: boolean
|
|
55720
|
+
name:
|
|
55721
|
+
description: The name of the deployment rule.
|
|
55722
|
+
example: Updated deployment rule
|
|
55723
|
+
type: string
|
|
55724
|
+
options:
|
|
55725
|
+
$ref: '#/components/schemas/DeploymentRulesOptions'
|
|
55726
|
+
required:
|
|
55727
|
+
- dry_run
|
|
55728
|
+
- name
|
|
55729
|
+
- options
|
|
55730
|
+
type: object
|
|
53583
55731
|
UpdateOpenAPIResponse:
|
|
53584
55732
|
description: Response for `UpdateOpenAPI`.
|
|
53585
55733
|
properties:
|
|
@@ -55846,7 +57994,7 @@ info:
|
|
|
55846
57994
|
version: '1.0'
|
|
55847
57995
|
openapi: 3.0.0
|
|
55848
57996
|
paths:
|
|
55849
|
-
/api/unstable/fleet/
|
|
57997
|
+
/api/unstable/fleet/agent_versions:
|
|
55850
57998
|
get:
|
|
55851
57999
|
description: 'Retrieve a list of all available Datadog Agent versions.
|
|
55852
58000
|
|
|
@@ -55889,6 +58037,142 @@ paths:
|
|
|
55889
58037
|
x-unstable: 'This endpoint is in Preview and may introduce breaking changes.
|
|
55890
58038
|
|
|
55891
58039
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
58040
|
+
/api/unstable/fleet/agents:
|
|
58041
|
+
get:
|
|
58042
|
+
description: 'Retrieve a paginated list of all Datadog Agents.
|
|
58043
|
+
|
|
58044
|
+
This endpoint returns a paginated list of all Datadog Agents with support
|
|
58045
|
+
for pagination, sorting, and filtering.
|
|
58046
|
+
|
|
58047
|
+
Use the `page_number` and `page_size` query parameters to paginate through
|
|
58048
|
+
results.'
|
|
58049
|
+
operationId: ListFleetAgents
|
|
58050
|
+
parameters:
|
|
58051
|
+
- description: Page number for pagination (must be greater than 0).
|
|
58052
|
+
in: query
|
|
58053
|
+
name: page_number
|
|
58054
|
+
required: false
|
|
58055
|
+
schema:
|
|
58056
|
+
format: int64
|
|
58057
|
+
minimum: 1
|
|
58058
|
+
type: integer
|
|
58059
|
+
- description: Number of results per page (must be greater than 0 and less than
|
|
58060
|
+
or equal to 100).
|
|
58061
|
+
in: query
|
|
58062
|
+
name: page_size
|
|
58063
|
+
required: false
|
|
58064
|
+
schema:
|
|
58065
|
+
default: 10
|
|
58066
|
+
format: int64
|
|
58067
|
+
maximum: 100
|
|
58068
|
+
minimum: 1
|
|
58069
|
+
type: integer
|
|
58070
|
+
- description: Attribute to sort by.
|
|
58071
|
+
in: query
|
|
58072
|
+
name: sort_attribute
|
|
58073
|
+
required: false
|
|
58074
|
+
schema:
|
|
58075
|
+
type: string
|
|
58076
|
+
- description: Sort order (true for descending, false for ascending).
|
|
58077
|
+
in: query
|
|
58078
|
+
name: sort_descending
|
|
58079
|
+
required: false
|
|
58080
|
+
schema:
|
|
58081
|
+
type: boolean
|
|
58082
|
+
- description: Comma-separated list of tags to filter agents.
|
|
58083
|
+
in: query
|
|
58084
|
+
name: tags
|
|
58085
|
+
required: false
|
|
58086
|
+
schema:
|
|
58087
|
+
type: string
|
|
58088
|
+
- description: Filter string for narrowing down agent results.
|
|
58089
|
+
example: hostname:my-hostname OR env:dev
|
|
58090
|
+
in: query
|
|
58091
|
+
name: filter
|
|
58092
|
+
required: false
|
|
58093
|
+
schema:
|
|
58094
|
+
type: string
|
|
58095
|
+
responses:
|
|
58096
|
+
'200':
|
|
58097
|
+
content:
|
|
58098
|
+
application/json:
|
|
58099
|
+
schema:
|
|
58100
|
+
$ref: '#/components/schemas/FleetAgentsResponse'
|
|
58101
|
+
description: OK
|
|
58102
|
+
'400':
|
|
58103
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
58104
|
+
'401':
|
|
58105
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
58106
|
+
'403':
|
|
58107
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
58108
|
+
'404':
|
|
58109
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
58110
|
+
'429':
|
|
58111
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
58112
|
+
security:
|
|
58113
|
+
- apiKeyAuth: []
|
|
58114
|
+
appKeyAuth: []
|
|
58115
|
+
summary: List all Datadog Agents
|
|
58116
|
+
tags:
|
|
58117
|
+
- Fleet Automation
|
|
58118
|
+
x-permission:
|
|
58119
|
+
operator: AND
|
|
58120
|
+
permissions:
|
|
58121
|
+
- hosts_read
|
|
58122
|
+
x-unstable: 'This endpoint is in Preview and may introduce breaking changes.
|
|
58123
|
+
|
|
58124
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
58125
|
+
/api/unstable/fleet/agents/{agent_key}:
|
|
58126
|
+
get:
|
|
58127
|
+
description: 'Retrieve detailed information about a specific Datadog Agent.
|
|
58128
|
+
|
|
58129
|
+
This endpoint returns comprehensive information about an agent including:
|
|
58130
|
+
|
|
58131
|
+
- Agent details and metadata
|
|
58132
|
+
|
|
58133
|
+
- Configured integrations organized by status (working, warning, error, missing)
|
|
58134
|
+
|
|
58135
|
+
- Detected integrations
|
|
58136
|
+
|
|
58137
|
+
- Configuration files and layers'
|
|
58138
|
+
operationId: GetFleetAgentInfo
|
|
58139
|
+
parameters:
|
|
58140
|
+
- description: The unique identifier (agent key) for the Datadog Agent.
|
|
58141
|
+
in: path
|
|
58142
|
+
name: agent_key
|
|
58143
|
+
required: true
|
|
58144
|
+
schema:
|
|
58145
|
+
type: string
|
|
58146
|
+
responses:
|
|
58147
|
+
'200':
|
|
58148
|
+
content:
|
|
58149
|
+
application/json:
|
|
58150
|
+
schema:
|
|
58151
|
+
$ref: '#/components/schemas/FleetAgentInfoResponse'
|
|
58152
|
+
description: OK
|
|
58153
|
+
'400':
|
|
58154
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
58155
|
+
'401':
|
|
58156
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
58157
|
+
'403':
|
|
58158
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
58159
|
+
'404':
|
|
58160
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
58161
|
+
'429':
|
|
58162
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
58163
|
+
security:
|
|
58164
|
+
- apiKeyAuth: []
|
|
58165
|
+
appKeyAuth: []
|
|
58166
|
+
summary: Get detailed information about an agent
|
|
58167
|
+
tags:
|
|
58168
|
+
- Fleet Automation
|
|
58169
|
+
x-permission:
|
|
58170
|
+
operator: AND
|
|
58171
|
+
permissions:
|
|
58172
|
+
- hosts_read
|
|
58173
|
+
x-unstable: 'This endpoint is in Preview and may introduce breaking changes.
|
|
58174
|
+
|
|
58175
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
55892
58176
|
/api/unstable/fleet/deployments:
|
|
55893
58177
|
get:
|
|
55894
58178
|
description: 'Retrieve a list of all deployments for fleet automation.
|
|
@@ -55982,6 +58266,77 @@ paths:
|
|
|
55982
58266
|
type: file
|
|
55983
58267
|
filter_query: env:prod
|
|
55984
58268
|
type: deployment
|
|
58269
|
+
comprehensive_configuration:
|
|
58270
|
+
summary: Comprehensive example with multiple configuration file types
|
|
58271
|
+
value:
|
|
58272
|
+
data:
|
|
58273
|
+
attributes:
|
|
58274
|
+
config_operations:
|
|
58275
|
+
- file_op: merge-patch
|
|
58276
|
+
file_path: /datadog.yaml
|
|
58277
|
+
patch:
|
|
58278
|
+
apm_config:
|
|
58279
|
+
apm_dd_url: https://trace.agent.datadoghq.com
|
|
58280
|
+
enabled: true
|
|
58281
|
+
log_level: info
|
|
58282
|
+
logs_enabled: true
|
|
58283
|
+
process_config:
|
|
58284
|
+
enabled: true
|
|
58285
|
+
- file_op: merge-patch
|
|
58286
|
+
file_path: /security-agent.yaml
|
|
58287
|
+
patch:
|
|
58288
|
+
runtime_security_config:
|
|
58289
|
+
enabled: true
|
|
58290
|
+
fim_enabled: true
|
|
58291
|
+
- file_op: merge-patch
|
|
58292
|
+
file_path: /system-probe.yaml
|
|
58293
|
+
patch:
|
|
58294
|
+
network_config:
|
|
58295
|
+
enabled: true
|
|
58296
|
+
service_monitoring_config:
|
|
58297
|
+
enabled: true
|
|
58298
|
+
- file_op: merge-patch
|
|
58299
|
+
file_path: /application_monitoring.yaml
|
|
58300
|
+
patch:
|
|
58301
|
+
enabled: true
|
|
58302
|
+
server:
|
|
58303
|
+
host: 0.0.0.0
|
|
58304
|
+
port: 8126
|
|
58305
|
+
- file_op: merge-patch
|
|
58306
|
+
file_path: /conf.d/logs.d/custom-app.yaml
|
|
58307
|
+
patch:
|
|
58308
|
+
logs:
|
|
58309
|
+
- path: /var/log/custom-app/*.log
|
|
58310
|
+
service: custom-app
|
|
58311
|
+
source: custom
|
|
58312
|
+
type: file
|
|
58313
|
+
- file_op: merge-patch
|
|
58314
|
+
file_path: /conf.d/docker.d/docker-logs.yaml
|
|
58315
|
+
patch:
|
|
58316
|
+
logs:
|
|
58317
|
+
- service: docker
|
|
58318
|
+
source: docker
|
|
58319
|
+
type: docker
|
|
58320
|
+
- file_op: merge-patch
|
|
58321
|
+
file_path: /conf.d/snmp.d/network-devices.yaml
|
|
58322
|
+
patch:
|
|
58323
|
+
init_config:
|
|
58324
|
+
loader: core
|
|
58325
|
+
instances:
|
|
58326
|
+
- community_string: public
|
|
58327
|
+
ip_address: 192.168.1.1
|
|
58328
|
+
- file_op: merge-patch
|
|
58329
|
+
file_path: /conf.d/postgres.d/conf.yaml
|
|
58330
|
+
patch:
|
|
58331
|
+
instances:
|
|
58332
|
+
- dbname: postgres
|
|
58333
|
+
host: localhost
|
|
58334
|
+
port: 5432
|
|
58335
|
+
username: datadog
|
|
58336
|
+
- file_op: delete
|
|
58337
|
+
file_path: /conf.d/deprecated-integration.yaml
|
|
58338
|
+
filter_query: env:prod AND datacenter:us-east-1
|
|
58339
|
+
type: deployment
|
|
55985
58340
|
delete_config_file:
|
|
55986
58341
|
summary: Delete a configuration file
|
|
55987
58342
|
value:
|
|
@@ -63836,6 +66191,403 @@ paths:
|
|
|
63836
66191
|
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
|
63837
66192
|
|
|
63838
66193
|
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66194
|
+
/api/v2/deployment_gates:
|
|
66195
|
+
post:
|
|
66196
|
+
description: Endpoint to create a deployment gate.
|
|
66197
|
+
operationId: CreateDeploymentGate
|
|
66198
|
+
requestBody:
|
|
66199
|
+
content:
|
|
66200
|
+
application/json:
|
|
66201
|
+
schema:
|
|
66202
|
+
$ref: '#/components/schemas/CreateDeploymentGateParams'
|
|
66203
|
+
required: true
|
|
66204
|
+
responses:
|
|
66205
|
+
'200':
|
|
66206
|
+
content:
|
|
66207
|
+
application/json:
|
|
66208
|
+
schema:
|
|
66209
|
+
$ref: '#/components/schemas/DeploymentGateResponse'
|
|
66210
|
+
description: OK
|
|
66211
|
+
'400':
|
|
66212
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66213
|
+
'401':
|
|
66214
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66215
|
+
'403':
|
|
66216
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66217
|
+
'429':
|
|
66218
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66219
|
+
'500':
|
|
66220
|
+
content:
|
|
66221
|
+
application/json:
|
|
66222
|
+
schema:
|
|
66223
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66224
|
+
description: Internal Server Error
|
|
66225
|
+
security:
|
|
66226
|
+
- apiKeyAuth: []
|
|
66227
|
+
appKeyAuth: []
|
|
66228
|
+
summary: Create deployment gate
|
|
66229
|
+
tags:
|
|
66230
|
+
- Deployment Gates
|
|
66231
|
+
x-permission:
|
|
66232
|
+
operator: OR
|
|
66233
|
+
permissions:
|
|
66234
|
+
- deployment_gates_write
|
|
66235
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66236
|
+
|
|
66237
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66238
|
+
/api/v2/deployment_gates/{gate_id}/rules:
|
|
66239
|
+
post:
|
|
66240
|
+
description: Endpoint to create a deployment rule. A gate for the rule must
|
|
66241
|
+
already exist.
|
|
66242
|
+
operationId: CreateDeploymentRule
|
|
66243
|
+
parameters:
|
|
66244
|
+
- description: The ID of the deployment gate.
|
|
66245
|
+
in: path
|
|
66246
|
+
name: gate_id
|
|
66247
|
+
required: true
|
|
66248
|
+
schema:
|
|
66249
|
+
type: string
|
|
66250
|
+
requestBody:
|
|
66251
|
+
content:
|
|
66252
|
+
application/json:
|
|
66253
|
+
schema:
|
|
66254
|
+
$ref: '#/components/schemas/CreateDeploymentRuleParams'
|
|
66255
|
+
required: true
|
|
66256
|
+
responses:
|
|
66257
|
+
'200':
|
|
66258
|
+
content:
|
|
66259
|
+
application/json:
|
|
66260
|
+
schema:
|
|
66261
|
+
$ref: '#/components/schemas/DeploymentRuleResponse'
|
|
66262
|
+
description: OK
|
|
66263
|
+
'400':
|
|
66264
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66265
|
+
'401':
|
|
66266
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66267
|
+
'403':
|
|
66268
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66269
|
+
'429':
|
|
66270
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66271
|
+
'500':
|
|
66272
|
+
content:
|
|
66273
|
+
application/json:
|
|
66274
|
+
schema:
|
|
66275
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66276
|
+
description: Internal Server Error
|
|
66277
|
+
security:
|
|
66278
|
+
- apiKeyAuth: []
|
|
66279
|
+
appKeyAuth: []
|
|
66280
|
+
summary: Create deployment rule
|
|
66281
|
+
tags:
|
|
66282
|
+
- Deployment Gates
|
|
66283
|
+
x-permission:
|
|
66284
|
+
operator: OR
|
|
66285
|
+
permissions:
|
|
66286
|
+
- deployment_gates_write
|
|
66287
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66288
|
+
|
|
66289
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66290
|
+
/api/v2/deployment_gates/{gate_id}/rules/{id}:
|
|
66291
|
+
delete:
|
|
66292
|
+
description: Endpoint to delete a deployment rule.
|
|
66293
|
+
operationId: DeleteDeploymentRule
|
|
66294
|
+
parameters:
|
|
66295
|
+
- description: The ID of the deployment gate.
|
|
66296
|
+
in: path
|
|
66297
|
+
name: gate_id
|
|
66298
|
+
required: true
|
|
66299
|
+
schema:
|
|
66300
|
+
type: string
|
|
66301
|
+
- description: The ID of the deployment rule.
|
|
66302
|
+
in: path
|
|
66303
|
+
name: id
|
|
66304
|
+
required: true
|
|
66305
|
+
schema:
|
|
66306
|
+
type: string
|
|
66307
|
+
responses:
|
|
66308
|
+
'204':
|
|
66309
|
+
description: No Content
|
|
66310
|
+
'400':
|
|
66311
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66312
|
+
'401':
|
|
66313
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66314
|
+
'403':
|
|
66315
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66316
|
+
'404':
|
|
66317
|
+
$ref: '#/components/responses/HTTPCDGatesNotFoundResponse'
|
|
66318
|
+
'429':
|
|
66319
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66320
|
+
'500':
|
|
66321
|
+
content:
|
|
66322
|
+
application/json:
|
|
66323
|
+
schema:
|
|
66324
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66325
|
+
description: Internal Server Error
|
|
66326
|
+
security:
|
|
66327
|
+
- apiKeyAuth: []
|
|
66328
|
+
appKeyAuth: []
|
|
66329
|
+
summary: Delete deployment rule
|
|
66330
|
+
tags:
|
|
66331
|
+
- Deployment Gates
|
|
66332
|
+
x-permission:
|
|
66333
|
+
operator: OR
|
|
66334
|
+
permissions:
|
|
66335
|
+
- deployment_gates_write
|
|
66336
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66337
|
+
|
|
66338
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66339
|
+
get:
|
|
66340
|
+
description: Endpoint to get a deployment rule.
|
|
66341
|
+
operationId: GetDeploymentRule
|
|
66342
|
+
parameters:
|
|
66343
|
+
- description: The ID of the deployment gate.
|
|
66344
|
+
in: path
|
|
66345
|
+
name: gate_id
|
|
66346
|
+
required: true
|
|
66347
|
+
schema:
|
|
66348
|
+
type: string
|
|
66349
|
+
- description: The ID of the deployment rule.
|
|
66350
|
+
in: path
|
|
66351
|
+
name: id
|
|
66352
|
+
required: true
|
|
66353
|
+
schema:
|
|
66354
|
+
type: string
|
|
66355
|
+
responses:
|
|
66356
|
+
'200':
|
|
66357
|
+
content:
|
|
66358
|
+
application/json:
|
|
66359
|
+
schema:
|
|
66360
|
+
$ref: '#/components/schemas/DeploymentRuleResponse'
|
|
66361
|
+
description: OK
|
|
66362
|
+
'400':
|
|
66363
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66364
|
+
'401':
|
|
66365
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66366
|
+
'403':
|
|
66367
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66368
|
+
'404':
|
|
66369
|
+
$ref: '#/components/responses/HTTPCDRulesNotFoundResponse'
|
|
66370
|
+
'429':
|
|
66371
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66372
|
+
'500':
|
|
66373
|
+
content:
|
|
66374
|
+
application/json:
|
|
66375
|
+
schema:
|
|
66376
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66377
|
+
description: Internal Server Error
|
|
66378
|
+
security:
|
|
66379
|
+
- apiKeyAuth: []
|
|
66380
|
+
appKeyAuth: []
|
|
66381
|
+
summary: Get deployment rule
|
|
66382
|
+
tags:
|
|
66383
|
+
- Deployment Gates
|
|
66384
|
+
x-permission:
|
|
66385
|
+
operator: OR
|
|
66386
|
+
permissions:
|
|
66387
|
+
- deployment_gates_read
|
|
66388
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66389
|
+
|
|
66390
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66391
|
+
put:
|
|
66392
|
+
description: Endpoint to update a deployment rule.
|
|
66393
|
+
operationId: UpdateDeploymentRule
|
|
66394
|
+
parameters:
|
|
66395
|
+
- description: The ID of the deployment gate.
|
|
66396
|
+
in: path
|
|
66397
|
+
name: gate_id
|
|
66398
|
+
required: true
|
|
66399
|
+
schema:
|
|
66400
|
+
type: string
|
|
66401
|
+
- description: The ID of the deployment rule.
|
|
66402
|
+
in: path
|
|
66403
|
+
name: id
|
|
66404
|
+
required: true
|
|
66405
|
+
schema:
|
|
66406
|
+
type: string
|
|
66407
|
+
requestBody:
|
|
66408
|
+
content:
|
|
66409
|
+
application/json:
|
|
66410
|
+
schema:
|
|
66411
|
+
$ref: '#/components/schemas/UpdateDeploymentRuleParams'
|
|
66412
|
+
required: true
|
|
66413
|
+
responses:
|
|
66414
|
+
'200':
|
|
66415
|
+
content:
|
|
66416
|
+
application/json:
|
|
66417
|
+
schema:
|
|
66418
|
+
$ref: '#/components/schemas/DeploymentRuleResponse'
|
|
66419
|
+
description: OK
|
|
66420
|
+
'400':
|
|
66421
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66422
|
+
'401':
|
|
66423
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66424
|
+
'403':
|
|
66425
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66426
|
+
'404':
|
|
66427
|
+
$ref: '#/components/responses/HTTPCDRulesNotFoundResponse'
|
|
66428
|
+
'429':
|
|
66429
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66430
|
+
'500':
|
|
66431
|
+
content:
|
|
66432
|
+
application/json:
|
|
66433
|
+
schema:
|
|
66434
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66435
|
+
description: Internal Server Error
|
|
66436
|
+
security:
|
|
66437
|
+
- apiKeyAuth: []
|
|
66438
|
+
appKeyAuth: []
|
|
66439
|
+
summary: Update deployment rule
|
|
66440
|
+
tags:
|
|
66441
|
+
- Deployment Gates
|
|
66442
|
+
x-permission:
|
|
66443
|
+
operator: OR
|
|
66444
|
+
permissions:
|
|
66445
|
+
- deployment_gates_write
|
|
66446
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66447
|
+
|
|
66448
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66449
|
+
/api/v2/deployment_gates/{id}:
|
|
66450
|
+
delete:
|
|
66451
|
+
description: Endpoint to delete a deployment gate. Rules associated with the
|
|
66452
|
+
gate are also deleted.
|
|
66453
|
+
operationId: DeleteDeploymentGate
|
|
66454
|
+
parameters:
|
|
66455
|
+
- description: The ID of the deployment gate.
|
|
66456
|
+
in: path
|
|
66457
|
+
name: id
|
|
66458
|
+
required: true
|
|
66459
|
+
schema:
|
|
66460
|
+
type: string
|
|
66461
|
+
responses:
|
|
66462
|
+
'204':
|
|
66463
|
+
description: No Content
|
|
66464
|
+
'400':
|
|
66465
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66466
|
+
'401':
|
|
66467
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66468
|
+
'403':
|
|
66469
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66470
|
+
'404':
|
|
66471
|
+
$ref: '#/components/responses/HTTPCDGatesNotFoundResponse'
|
|
66472
|
+
'429':
|
|
66473
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66474
|
+
'500':
|
|
66475
|
+
content:
|
|
66476
|
+
application/json:
|
|
66477
|
+
schema:
|
|
66478
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66479
|
+
description: Internal Server Error
|
|
66480
|
+
security:
|
|
66481
|
+
- apiKeyAuth: []
|
|
66482
|
+
appKeyAuth: []
|
|
66483
|
+
summary: Delete deployment gate
|
|
66484
|
+
tags:
|
|
66485
|
+
- Deployment Gates
|
|
66486
|
+
x-permission:
|
|
66487
|
+
operator: OR
|
|
66488
|
+
permissions:
|
|
66489
|
+
- deployment_gates_write
|
|
66490
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66491
|
+
|
|
66492
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66493
|
+
get:
|
|
66494
|
+
description: Endpoint to get a deployment gate.
|
|
66495
|
+
operationId: GetDeploymentGate
|
|
66496
|
+
parameters:
|
|
66497
|
+
- description: The ID of the deployment gate.
|
|
66498
|
+
in: path
|
|
66499
|
+
name: id
|
|
66500
|
+
required: true
|
|
66501
|
+
schema:
|
|
66502
|
+
type: string
|
|
66503
|
+
responses:
|
|
66504
|
+
'200':
|
|
66505
|
+
content:
|
|
66506
|
+
application/json:
|
|
66507
|
+
schema:
|
|
66508
|
+
$ref: '#/components/schemas/DeploymentGateResponse'
|
|
66509
|
+
description: OK
|
|
66510
|
+
'400':
|
|
66511
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66512
|
+
'401':
|
|
66513
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66514
|
+
'403':
|
|
66515
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66516
|
+
'404':
|
|
66517
|
+
$ref: '#/components/responses/HTTPCDGatesNotFoundResponse'
|
|
66518
|
+
'429':
|
|
66519
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66520
|
+
'500':
|
|
66521
|
+
content:
|
|
66522
|
+
application/json:
|
|
66523
|
+
schema:
|
|
66524
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66525
|
+
description: Internal Server Error
|
|
66526
|
+
security:
|
|
66527
|
+
- apiKeyAuth: []
|
|
66528
|
+
appKeyAuth: []
|
|
66529
|
+
summary: Get deployment gate
|
|
66530
|
+
tags:
|
|
66531
|
+
- Deployment Gates
|
|
66532
|
+
x-permission:
|
|
66533
|
+
operator: OR
|
|
66534
|
+
permissions:
|
|
66535
|
+
- deployment_gates_read
|
|
66536
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66537
|
+
|
|
66538
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
66539
|
+
put:
|
|
66540
|
+
description: Endpoint to update a deployment gate.
|
|
66541
|
+
operationId: UpdateDeploymentGate
|
|
66542
|
+
parameters:
|
|
66543
|
+
- description: The ID of the deployment gate.
|
|
66544
|
+
in: path
|
|
66545
|
+
name: id
|
|
66546
|
+
required: true
|
|
66547
|
+
schema:
|
|
66548
|
+
type: string
|
|
66549
|
+
requestBody:
|
|
66550
|
+
content:
|
|
66551
|
+
application/json:
|
|
66552
|
+
schema:
|
|
66553
|
+
$ref: '#/components/schemas/UpdateDeploymentGateParams'
|
|
66554
|
+
required: true
|
|
66555
|
+
responses:
|
|
66556
|
+
'200':
|
|
66557
|
+
content:
|
|
66558
|
+
application/json:
|
|
66559
|
+
schema:
|
|
66560
|
+
$ref: '#/components/schemas/DeploymentGateResponse'
|
|
66561
|
+
description: OK
|
|
66562
|
+
'400':
|
|
66563
|
+
$ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
|
|
66564
|
+
'401':
|
|
66565
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
66566
|
+
'403':
|
|
66567
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
66568
|
+
'404':
|
|
66569
|
+
$ref: '#/components/responses/HTTPCDGatesNotFoundResponse'
|
|
66570
|
+
'429':
|
|
66571
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
66572
|
+
'500':
|
|
66573
|
+
content:
|
|
66574
|
+
application/json:
|
|
66575
|
+
schema:
|
|
66576
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
66577
|
+
description: Internal Server Error
|
|
66578
|
+
security:
|
|
66579
|
+
- apiKeyAuth: []
|
|
66580
|
+
appKeyAuth: []
|
|
66581
|
+
summary: Update deployment gate
|
|
66582
|
+
tags:
|
|
66583
|
+
- Deployment Gates
|
|
66584
|
+
x-permission:
|
|
66585
|
+
operator: OR
|
|
66586
|
+
permissions:
|
|
66587
|
+
- deployment_gates_write
|
|
66588
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
66589
|
+
|
|
66590
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
63839
66591
|
/api/v2/domain_allowlist:
|
|
63840
66592
|
get:
|
|
63841
66593
|
description: Get the domain allowlist for an organization.
|
|
@@ -69357,6 +72109,487 @@ paths:
|
|
|
69357
72109
|
operator: OR
|
|
69358
72110
|
permissions:
|
|
69359
72111
|
- logs_generate_metrics
|
|
72112
|
+
/api/v2/logs/config/restriction_queries:
|
|
72113
|
+
get:
|
|
72114
|
+
description: Returns all restriction queries, including their names and IDs.
|
|
72115
|
+
operationId: ListRestrictionQueries
|
|
72116
|
+
parameters:
|
|
72117
|
+
- $ref: '#/components/parameters/PageSize'
|
|
72118
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
72119
|
+
responses:
|
|
72120
|
+
'200':
|
|
72121
|
+
content:
|
|
72122
|
+
application/json:
|
|
72123
|
+
schema:
|
|
72124
|
+
$ref: '#/components/schemas/RestrictionQueryListResponse'
|
|
72125
|
+
description: OK
|
|
72126
|
+
'403':
|
|
72127
|
+
content:
|
|
72128
|
+
application/json:
|
|
72129
|
+
schema:
|
|
72130
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72131
|
+
description: Authentication error
|
|
72132
|
+
'429':
|
|
72133
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72134
|
+
summary: List restriction queries
|
|
72135
|
+
tags:
|
|
72136
|
+
- Logs Restriction Queries
|
|
72137
|
+
x-permission:
|
|
72138
|
+
operator: OR
|
|
72139
|
+
permissions:
|
|
72140
|
+
- logs_read_config
|
|
72141
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72142
|
+
|
|
72143
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72144
|
+
post:
|
|
72145
|
+
description: Create a new restriction query for your organization.
|
|
72146
|
+
operationId: CreateRestrictionQuery
|
|
72147
|
+
requestBody:
|
|
72148
|
+
content:
|
|
72149
|
+
application/json:
|
|
72150
|
+
schema:
|
|
72151
|
+
$ref: '#/components/schemas/RestrictionQueryCreatePayload'
|
|
72152
|
+
required: true
|
|
72153
|
+
responses:
|
|
72154
|
+
'200':
|
|
72155
|
+
content:
|
|
72156
|
+
application/json:
|
|
72157
|
+
schema:
|
|
72158
|
+
$ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse'
|
|
72159
|
+
description: OK
|
|
72160
|
+
'400':
|
|
72161
|
+
content:
|
|
72162
|
+
application/json:
|
|
72163
|
+
schema:
|
|
72164
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72165
|
+
description: Bad Request
|
|
72166
|
+
'403':
|
|
72167
|
+
content:
|
|
72168
|
+
application/json:
|
|
72169
|
+
schema:
|
|
72170
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72171
|
+
description: Authentication error
|
|
72172
|
+
'429':
|
|
72173
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72174
|
+
summary: Create a restriction query
|
|
72175
|
+
tags:
|
|
72176
|
+
- Logs Restriction Queries
|
|
72177
|
+
x-codegen-request-body-name: body
|
|
72178
|
+
x-permission:
|
|
72179
|
+
operator: OR
|
|
72180
|
+
permissions:
|
|
72181
|
+
- user_access_manage
|
|
72182
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72183
|
+
|
|
72184
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72185
|
+
/api/v2/logs/config/restriction_queries/role/{role_id}:
|
|
72186
|
+
get:
|
|
72187
|
+
description: Get restriction query for a given role.
|
|
72188
|
+
operationId: GetRoleRestrictionQuery
|
|
72189
|
+
parameters:
|
|
72190
|
+
- $ref: '#/components/parameters/RestrictionQueryRoleID'
|
|
72191
|
+
responses:
|
|
72192
|
+
'200':
|
|
72193
|
+
content:
|
|
72194
|
+
application/json:
|
|
72195
|
+
schema:
|
|
72196
|
+
$ref: '#/components/schemas/RestrictionQueryListResponse'
|
|
72197
|
+
description: OK
|
|
72198
|
+
'400':
|
|
72199
|
+
content:
|
|
72200
|
+
application/json:
|
|
72201
|
+
schema:
|
|
72202
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72203
|
+
description: Bad Request
|
|
72204
|
+
'403':
|
|
72205
|
+
content:
|
|
72206
|
+
application/json:
|
|
72207
|
+
schema:
|
|
72208
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72209
|
+
description: Authentication error
|
|
72210
|
+
'404':
|
|
72211
|
+
content:
|
|
72212
|
+
application/json:
|
|
72213
|
+
schema:
|
|
72214
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72215
|
+
description: Not found
|
|
72216
|
+
'429':
|
|
72217
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72218
|
+
summary: Get restriction query for a given role
|
|
72219
|
+
tags:
|
|
72220
|
+
- Logs Restriction Queries
|
|
72221
|
+
x-permission:
|
|
72222
|
+
operator: OR
|
|
72223
|
+
permissions:
|
|
72224
|
+
- logs_read_config
|
|
72225
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72226
|
+
|
|
72227
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72228
|
+
/api/v2/logs/config/restriction_queries/user/{user_id}:
|
|
72229
|
+
get:
|
|
72230
|
+
description: Get all restriction queries for a given user.
|
|
72231
|
+
operationId: ListUserRestrictionQueries
|
|
72232
|
+
parameters:
|
|
72233
|
+
- $ref: '#/components/parameters/RestrictionQueryUserID'
|
|
72234
|
+
responses:
|
|
72235
|
+
'200':
|
|
72236
|
+
content:
|
|
72237
|
+
application/json:
|
|
72238
|
+
schema:
|
|
72239
|
+
$ref: '#/components/schemas/RestrictionQueryListResponse'
|
|
72240
|
+
description: OK
|
|
72241
|
+
'400':
|
|
72242
|
+
content:
|
|
72243
|
+
application/json:
|
|
72244
|
+
schema:
|
|
72245
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72246
|
+
description: Bad Request
|
|
72247
|
+
'403':
|
|
72248
|
+
content:
|
|
72249
|
+
application/json:
|
|
72250
|
+
schema:
|
|
72251
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72252
|
+
description: Authentication error
|
|
72253
|
+
'404':
|
|
72254
|
+
content:
|
|
72255
|
+
application/json:
|
|
72256
|
+
schema:
|
|
72257
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72258
|
+
description: Not found
|
|
72259
|
+
'429':
|
|
72260
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72261
|
+
summary: Get all restriction queries for a given user
|
|
72262
|
+
tags:
|
|
72263
|
+
- Logs Restriction Queries
|
|
72264
|
+
x-permission:
|
|
72265
|
+
operator: OR
|
|
72266
|
+
permissions:
|
|
72267
|
+
- logs_read_config
|
|
72268
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72269
|
+
|
|
72270
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72271
|
+
/api/v2/logs/config/restriction_queries/{restriction_query_id}:
|
|
72272
|
+
delete:
|
|
72273
|
+
description: Deletes a restriction query.
|
|
72274
|
+
operationId: DeleteRestrictionQuery
|
|
72275
|
+
parameters:
|
|
72276
|
+
- $ref: '#/components/parameters/RestrictionQueryID'
|
|
72277
|
+
responses:
|
|
72278
|
+
'204':
|
|
72279
|
+
description: OK
|
|
72280
|
+
'400':
|
|
72281
|
+
content:
|
|
72282
|
+
application/json:
|
|
72283
|
+
schema:
|
|
72284
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72285
|
+
description: Bad Request
|
|
72286
|
+
'403':
|
|
72287
|
+
content:
|
|
72288
|
+
application/json:
|
|
72289
|
+
schema:
|
|
72290
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72291
|
+
description: Authentication error
|
|
72292
|
+
'404':
|
|
72293
|
+
content:
|
|
72294
|
+
application/json:
|
|
72295
|
+
schema:
|
|
72296
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72297
|
+
description: Not found
|
|
72298
|
+
'429':
|
|
72299
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72300
|
+
summary: Delete a restriction query
|
|
72301
|
+
tags:
|
|
72302
|
+
- Logs Restriction Queries
|
|
72303
|
+
x-codegen-request-body-name: body
|
|
72304
|
+
x-permission:
|
|
72305
|
+
operator: OR
|
|
72306
|
+
permissions:
|
|
72307
|
+
- user_access_manage
|
|
72308
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72309
|
+
|
|
72310
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72311
|
+
get:
|
|
72312
|
+
description: Get a restriction query in the organization specified by the restriction
|
|
72313
|
+
query's `restriction_query_id`.
|
|
72314
|
+
operationId: GetRestrictionQuery
|
|
72315
|
+
parameters:
|
|
72316
|
+
- $ref: '#/components/parameters/RestrictionQueryID'
|
|
72317
|
+
responses:
|
|
72318
|
+
'200':
|
|
72319
|
+
content:
|
|
72320
|
+
application/json:
|
|
72321
|
+
schema:
|
|
72322
|
+
$ref: '#/components/schemas/RestrictionQueryWithRelationshipsResponse'
|
|
72323
|
+
description: OK
|
|
72324
|
+
'400':
|
|
72325
|
+
content:
|
|
72326
|
+
application/json:
|
|
72327
|
+
schema:
|
|
72328
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72329
|
+
description: Bad Request
|
|
72330
|
+
'403':
|
|
72331
|
+
content:
|
|
72332
|
+
application/json:
|
|
72333
|
+
schema:
|
|
72334
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72335
|
+
description: Authentication error
|
|
72336
|
+
'404':
|
|
72337
|
+
content:
|
|
72338
|
+
application/json:
|
|
72339
|
+
schema:
|
|
72340
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72341
|
+
description: Not found
|
|
72342
|
+
'429':
|
|
72343
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72344
|
+
summary: Get a restriction query
|
|
72345
|
+
tags:
|
|
72346
|
+
- Logs Restriction Queries
|
|
72347
|
+
x-codegen-request-body-name: body
|
|
72348
|
+
x-permission:
|
|
72349
|
+
operator: OR
|
|
72350
|
+
permissions:
|
|
72351
|
+
- logs_read_config
|
|
72352
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72353
|
+
|
|
72354
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72355
|
+
patch:
|
|
72356
|
+
description: Edit a restriction query.
|
|
72357
|
+
operationId: UpdateRestrictionQuery
|
|
72358
|
+
parameters:
|
|
72359
|
+
- $ref: '#/components/parameters/RestrictionQueryID'
|
|
72360
|
+
requestBody:
|
|
72361
|
+
content:
|
|
72362
|
+
application/json:
|
|
72363
|
+
schema:
|
|
72364
|
+
$ref: '#/components/schemas/RestrictionQueryUpdatePayload'
|
|
72365
|
+
required: true
|
|
72366
|
+
responses:
|
|
72367
|
+
'200':
|
|
72368
|
+
content:
|
|
72369
|
+
application/json:
|
|
72370
|
+
schema:
|
|
72371
|
+
$ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse'
|
|
72372
|
+
description: OK
|
|
72373
|
+
'400':
|
|
72374
|
+
content:
|
|
72375
|
+
application/json:
|
|
72376
|
+
schema:
|
|
72377
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72378
|
+
description: Bad Request
|
|
72379
|
+
'403':
|
|
72380
|
+
content:
|
|
72381
|
+
application/json:
|
|
72382
|
+
schema:
|
|
72383
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72384
|
+
description: Authentication error
|
|
72385
|
+
'404':
|
|
72386
|
+
content:
|
|
72387
|
+
application/json:
|
|
72388
|
+
schema:
|
|
72389
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72390
|
+
description: Not found
|
|
72391
|
+
'429':
|
|
72392
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72393
|
+
summary: Update a restriction query
|
|
72394
|
+
tags:
|
|
72395
|
+
- Logs Restriction Queries
|
|
72396
|
+
x-codegen-request-body-name: body
|
|
72397
|
+
x-permission:
|
|
72398
|
+
operator: OR
|
|
72399
|
+
permissions:
|
|
72400
|
+
- user_access_manage
|
|
72401
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72402
|
+
|
|
72403
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72404
|
+
put:
|
|
72405
|
+
description: Replace a restriction query.
|
|
72406
|
+
operationId: ReplaceRestrictionQuery
|
|
72407
|
+
parameters:
|
|
72408
|
+
- $ref: '#/components/parameters/RestrictionQueryID'
|
|
72409
|
+
requestBody:
|
|
72410
|
+
content:
|
|
72411
|
+
application/json:
|
|
72412
|
+
schema:
|
|
72413
|
+
$ref: '#/components/schemas/RestrictionQueryUpdatePayload'
|
|
72414
|
+
required: true
|
|
72415
|
+
responses:
|
|
72416
|
+
'200':
|
|
72417
|
+
content:
|
|
72418
|
+
application/json:
|
|
72419
|
+
schema:
|
|
72420
|
+
$ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse'
|
|
72421
|
+
description: OK
|
|
72422
|
+
'400':
|
|
72423
|
+
content:
|
|
72424
|
+
application/json:
|
|
72425
|
+
schema:
|
|
72426
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72427
|
+
description: Bad Request
|
|
72428
|
+
'403':
|
|
72429
|
+
content:
|
|
72430
|
+
application/json:
|
|
72431
|
+
schema:
|
|
72432
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72433
|
+
description: Authentication error
|
|
72434
|
+
'404':
|
|
72435
|
+
content:
|
|
72436
|
+
application/json:
|
|
72437
|
+
schema:
|
|
72438
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72439
|
+
description: Not found
|
|
72440
|
+
'429':
|
|
72441
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72442
|
+
summary: Replace a restriction query
|
|
72443
|
+
tags:
|
|
72444
|
+
- Logs Restriction Queries
|
|
72445
|
+
x-codegen-request-body-name: body
|
|
72446
|
+
x-permission:
|
|
72447
|
+
operator: OR
|
|
72448
|
+
permissions:
|
|
72449
|
+
- user_access_manage
|
|
72450
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72451
|
+
|
|
72452
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72453
|
+
/api/v2/logs/config/restriction_queries/{restriction_query_id}/roles:
|
|
72454
|
+
delete:
|
|
72455
|
+
description: Removes a role from a restriction query.
|
|
72456
|
+
operationId: RemoveRoleFromRestrictionQuery
|
|
72457
|
+
parameters:
|
|
72458
|
+
- $ref: '#/components/parameters/RestrictionQueryID'
|
|
72459
|
+
requestBody:
|
|
72460
|
+
content:
|
|
72461
|
+
application/json:
|
|
72462
|
+
schema:
|
|
72463
|
+
$ref: '#/components/schemas/RelationshipToRole'
|
|
72464
|
+
required: true
|
|
72465
|
+
responses:
|
|
72466
|
+
'204':
|
|
72467
|
+
description: OK
|
|
72468
|
+
'400':
|
|
72469
|
+
content:
|
|
72470
|
+
application/json:
|
|
72471
|
+
schema:
|
|
72472
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72473
|
+
description: Bad Request
|
|
72474
|
+
'403':
|
|
72475
|
+
content:
|
|
72476
|
+
application/json:
|
|
72477
|
+
schema:
|
|
72478
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72479
|
+
description: Authentication error
|
|
72480
|
+
'404':
|
|
72481
|
+
content:
|
|
72482
|
+
application/json:
|
|
72483
|
+
schema:
|
|
72484
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72485
|
+
description: Not found
|
|
72486
|
+
'429':
|
|
72487
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72488
|
+
summary: Revoke role from a restriction query
|
|
72489
|
+
tags:
|
|
72490
|
+
- Logs Restriction Queries
|
|
72491
|
+
x-codegen-request-body-name: body
|
|
72492
|
+
x-permission:
|
|
72493
|
+
operator: OR
|
|
72494
|
+
permissions:
|
|
72495
|
+
- user_access_manage
|
|
72496
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72497
|
+
|
|
72498
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72499
|
+
get:
|
|
72500
|
+
description: Returns all roles that have a given restriction query.
|
|
72501
|
+
operationId: ListRestrictionQueryRoles
|
|
72502
|
+
parameters:
|
|
72503
|
+
- $ref: '#/components/parameters/RestrictionQueryID'
|
|
72504
|
+
- $ref: '#/components/parameters/PageSize'
|
|
72505
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
72506
|
+
responses:
|
|
72507
|
+
'200':
|
|
72508
|
+
content:
|
|
72509
|
+
application/json:
|
|
72510
|
+
schema:
|
|
72511
|
+
$ref: '#/components/schemas/RestrictionQueryRolesResponse'
|
|
72512
|
+
description: OK
|
|
72513
|
+
'400':
|
|
72514
|
+
content:
|
|
72515
|
+
application/json:
|
|
72516
|
+
schema:
|
|
72517
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72518
|
+
description: Bad Request
|
|
72519
|
+
'403':
|
|
72520
|
+
content:
|
|
72521
|
+
application/json:
|
|
72522
|
+
schema:
|
|
72523
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72524
|
+
description: Authentication error
|
|
72525
|
+
'404':
|
|
72526
|
+
content:
|
|
72527
|
+
application/json:
|
|
72528
|
+
schema:
|
|
72529
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72530
|
+
description: Not found
|
|
72531
|
+
'429':
|
|
72532
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72533
|
+
summary: List roles for a restriction query
|
|
72534
|
+
tags:
|
|
72535
|
+
- Logs Restriction Queries
|
|
72536
|
+
x-codegen-request-body-name: body
|
|
72537
|
+
x-permission:
|
|
72538
|
+
operator: OR
|
|
72539
|
+
permissions:
|
|
72540
|
+
- logs_read_config
|
|
72541
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72542
|
+
|
|
72543
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
72544
|
+
post:
|
|
72545
|
+
description: 'Adds a role to a restriction query.
|
|
72546
|
+
|
|
72547
|
+
|
|
72548
|
+
**Note**: This operation automatically grants the `logs_read_data` permission
|
|
72549
|
+
to the role if it doesn''t already have it.'
|
|
72550
|
+
operationId: AddRoleToRestrictionQuery
|
|
72551
|
+
parameters:
|
|
72552
|
+
- $ref: '#/components/parameters/RestrictionQueryID'
|
|
72553
|
+
requestBody:
|
|
72554
|
+
content:
|
|
72555
|
+
application/json:
|
|
72556
|
+
schema:
|
|
72557
|
+
$ref: '#/components/schemas/RelationshipToRole'
|
|
72558
|
+
required: true
|
|
72559
|
+
responses:
|
|
72560
|
+
'204':
|
|
72561
|
+
description: OK
|
|
72562
|
+
'400':
|
|
72563
|
+
content:
|
|
72564
|
+
application/json:
|
|
72565
|
+
schema:
|
|
72566
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72567
|
+
description: Bad Request
|
|
72568
|
+
'403':
|
|
72569
|
+
content:
|
|
72570
|
+
application/json:
|
|
72571
|
+
schema:
|
|
72572
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72573
|
+
description: Authentication error
|
|
72574
|
+
'404':
|
|
72575
|
+
content:
|
|
72576
|
+
application/json:
|
|
72577
|
+
schema:
|
|
72578
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
72579
|
+
description: Not found
|
|
72580
|
+
'429':
|
|
72581
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
72582
|
+
summary: Grant role to a restriction query
|
|
72583
|
+
tags:
|
|
72584
|
+
- Logs Restriction Queries
|
|
72585
|
+
x-codegen-request-body-name: body
|
|
72586
|
+
x-permission:
|
|
72587
|
+
operator: OR
|
|
72588
|
+
permissions:
|
|
72589
|
+
- user_access_manage
|
|
72590
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72591
|
+
|
|
72592
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
69360
72593
|
/api/v2/logs/events:
|
|
69361
72594
|
get:
|
|
69362
72595
|
description: 'List endpoint returns logs that match a log search query.
|
|
@@ -72011,9 +75244,13 @@ paths:
|
|
|
72011
75244
|
- apiKeyAuth: []
|
|
72012
75245
|
appKeyAuth: []
|
|
72013
75246
|
- AuthZ: []
|
|
72014
|
-
summary: Get
|
|
75247
|
+
summary: Get scheduled on-call user
|
|
72015
75248
|
tags:
|
|
72016
75249
|
- On-Call
|
|
75250
|
+
x-permission:
|
|
75251
|
+
operator: AND
|
|
75252
|
+
permissions:
|
|
75253
|
+
- on_call_read
|
|
72017
75254
|
/api/v2/on-call/teams/{team_id}/on-call:
|
|
72018
75255
|
get:
|
|
72019
75256
|
description: Get a team's on-call users at a given time
|
|
@@ -72056,6 +75293,10 @@ paths:
|
|
|
72056
75293
|
summary: Get team on-call users
|
|
72057
75294
|
tags:
|
|
72058
75295
|
- On-Call
|
|
75296
|
+
x-permission:
|
|
75297
|
+
operator: AND
|
|
75298
|
+
permissions:
|
|
75299
|
+
- on_call_read
|
|
72059
75300
|
/api/v2/on-call/teams/{team_id}/routing-rules:
|
|
72060
75301
|
get:
|
|
72061
75302
|
description: Get a team's On-Call routing rules
|
|
@@ -72659,10 +75900,16 @@ paths:
|
|
|
72659
75900
|
security:
|
|
72660
75901
|
- apiKeyAuth: []
|
|
72661
75902
|
appKeyAuth: []
|
|
75903
|
+
- AuthZ: []
|
|
72662
75904
|
summary: Mute or unmute a batch of findings
|
|
72663
75905
|
tags:
|
|
72664
75906
|
- Security Monitoring
|
|
72665
75907
|
x-codegen-request-body-name: body
|
|
75908
|
+
x-permission:
|
|
75909
|
+
operator: OR
|
|
75910
|
+
permissions:
|
|
75911
|
+
- security_monitoring_findings_write
|
|
75912
|
+
- appsec_vm_write
|
|
72666
75913
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
72667
75914
|
|
|
72668
75915
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
@@ -73470,6 +76717,58 @@ paths:
|
|
|
73470
76717
|
requestBody:
|
|
73471
76718
|
content:
|
|
73472
76719
|
application/json:
|
|
76720
|
+
examples:
|
|
76721
|
+
cloud_storage:
|
|
76722
|
+
summary: Create table from cloud storage (S3)
|
|
76723
|
+
value:
|
|
76724
|
+
data:
|
|
76725
|
+
attributes:
|
|
76726
|
+
description: Customer reference data synced from S3
|
|
76727
|
+
file_metadata:
|
|
76728
|
+
access_details:
|
|
76729
|
+
aws_detail:
|
|
76730
|
+
aws_account_id: '924305315327'
|
|
76731
|
+
aws_bucket_name: my-data-bucket
|
|
76732
|
+
file_path: customers.csv
|
|
76733
|
+
sync_enabled: true
|
|
76734
|
+
schema:
|
|
76735
|
+
fields:
|
|
76736
|
+
- name: customer_id
|
|
76737
|
+
type: STRING
|
|
76738
|
+
- name: customer_name
|
|
76739
|
+
type: STRING
|
|
76740
|
+
- name: email
|
|
76741
|
+
type: STRING
|
|
76742
|
+
primary_keys:
|
|
76743
|
+
- customer_id
|
|
76744
|
+
source: S3
|
|
76745
|
+
table_name: customer_reference_data
|
|
76746
|
+
tags:
|
|
76747
|
+
- team:data-platform
|
|
76748
|
+
type: reference_table
|
|
76749
|
+
local_file:
|
|
76750
|
+
summary: Create table from local file upload
|
|
76751
|
+
value:
|
|
76752
|
+
data:
|
|
76753
|
+
attributes:
|
|
76754
|
+
description: Product catalog uploaded via local file
|
|
76755
|
+
file_metadata:
|
|
76756
|
+
upload_id: 00000000-0000-0000-0000-000000000000
|
|
76757
|
+
schema:
|
|
76758
|
+
fields:
|
|
76759
|
+
- name: product_id
|
|
76760
|
+
type: STRING
|
|
76761
|
+
- name: product_name
|
|
76762
|
+
type: STRING
|
|
76763
|
+
- name: price
|
|
76764
|
+
type: DOUBLE
|
|
76765
|
+
primary_keys:
|
|
76766
|
+
- product_id
|
|
76767
|
+
source: LOCAL_FILE
|
|
76768
|
+
table_name: product_catalog
|
|
76769
|
+
tags:
|
|
76770
|
+
- team:ecommerce
|
|
76771
|
+
type: reference_table
|
|
73473
76772
|
schema:
|
|
73474
76773
|
$ref: '#/components/schemas/CreateTableRequest'
|
|
73475
76774
|
required: true
|
|
@@ -73590,6 +76889,47 @@ paths:
|
|
|
73590
76889
|
tags:
|
|
73591
76890
|
- Reference Tables
|
|
73592
76891
|
/api/v2/reference-tables/tables/{id}/rows:
|
|
76892
|
+
delete:
|
|
76893
|
+
description: Delete multiple rows from a Reference Table by their primary key
|
|
76894
|
+
values.
|
|
76895
|
+
operationId: DeleteRows
|
|
76896
|
+
parameters:
|
|
76897
|
+
- description: Unique identifier of the reference table to delete rows from
|
|
76898
|
+
in: path
|
|
76899
|
+
name: id
|
|
76900
|
+
required: true
|
|
76901
|
+
schema:
|
|
76902
|
+
type: string
|
|
76903
|
+
requestBody:
|
|
76904
|
+
content:
|
|
76905
|
+
application/json:
|
|
76906
|
+
schema:
|
|
76907
|
+
$ref: '#/components/schemas/BatchDeleteRowsRequestArray'
|
|
76908
|
+
required: true
|
|
76909
|
+
responses:
|
|
76910
|
+
'200':
|
|
76911
|
+
description: Rows deleted successfully
|
|
76912
|
+
'400':
|
|
76913
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
76914
|
+
'403':
|
|
76915
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
76916
|
+
'404':
|
|
76917
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
76918
|
+
'429':
|
|
76919
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
76920
|
+
'500':
|
|
76921
|
+
content:
|
|
76922
|
+
application/json:
|
|
76923
|
+
schema:
|
|
76924
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
76925
|
+
description: Internal Server Error
|
|
76926
|
+
security:
|
|
76927
|
+
- apiKeyAuth: []
|
|
76928
|
+
appKeyAuth: []
|
|
76929
|
+
- AuthZ: []
|
|
76930
|
+
summary: Delete rows
|
|
76931
|
+
tags:
|
|
76932
|
+
- Reference Tables
|
|
73593
76933
|
get:
|
|
73594
76934
|
description: Get reference table rows by their primary key values.
|
|
73595
76935
|
operationId: GetRowsByID
|
|
@@ -73634,6 +76974,48 @@ paths:
|
|
|
73634
76974
|
summary: Get rows by id
|
|
73635
76975
|
tags:
|
|
73636
76976
|
- Reference Tables
|
|
76977
|
+
post:
|
|
76978
|
+
description: Create or update rows in a Reference Table by their primary key
|
|
76979
|
+
values. If a row with the specified primary key exists, it is updated; otherwise,
|
|
76980
|
+
a new row is created.
|
|
76981
|
+
operationId: UpsertRows
|
|
76982
|
+
parameters:
|
|
76983
|
+
- description: Unique identifier of the reference table to upsert rows into
|
|
76984
|
+
in: path
|
|
76985
|
+
name: id
|
|
76986
|
+
required: true
|
|
76987
|
+
schema:
|
|
76988
|
+
type: string
|
|
76989
|
+
requestBody:
|
|
76990
|
+
content:
|
|
76991
|
+
application/json:
|
|
76992
|
+
schema:
|
|
76993
|
+
$ref: '#/components/schemas/BatchUpsertRowsRequestArray'
|
|
76994
|
+
required: true
|
|
76995
|
+
responses:
|
|
76996
|
+
'200':
|
|
76997
|
+
description: Rows created or updated successfully
|
|
76998
|
+
'400':
|
|
76999
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77000
|
+
'403':
|
|
77001
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
77002
|
+
'404':
|
|
77003
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
77004
|
+
'429':
|
|
77005
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77006
|
+
'500':
|
|
77007
|
+
content:
|
|
77008
|
+
application/json:
|
|
77009
|
+
schema:
|
|
77010
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
77011
|
+
description: Internal Server Error
|
|
77012
|
+
security:
|
|
77013
|
+
- apiKeyAuth: []
|
|
77014
|
+
appKeyAuth: []
|
|
77015
|
+
- AuthZ: []
|
|
77016
|
+
summary: Upsert rows
|
|
77017
|
+
tags:
|
|
77018
|
+
- Reference Tables
|
|
73637
77019
|
/api/v2/reference-tables/uploads:
|
|
73638
77020
|
post:
|
|
73639
77021
|
description: Create a reference table upload for bulk data ingestion
|
|
@@ -76294,6 +79676,208 @@ paths:
|
|
|
76294
79676
|
operator: OR
|
|
76295
79677
|
permissions:
|
|
76296
79678
|
- security_monitoring_cws_agent_rules_read
|
|
79679
|
+
/api/v2/security/findings/cases:
|
|
79680
|
+
delete:
|
|
79681
|
+
description: Detach security findings from their case. This operation dissociates
|
|
79682
|
+
security findings from their associated cases without deleting the cases themselves.
|
|
79683
|
+
You can detach security findings from multiple different cases in a single
|
|
79684
|
+
request, with a limit of 50 security findings per request. Security findings
|
|
79685
|
+
that are not currently attached to any case will be ignored.
|
|
79686
|
+
operationId: DetachCase
|
|
79687
|
+
requestBody:
|
|
79688
|
+
content:
|
|
79689
|
+
application/json:
|
|
79690
|
+
schema:
|
|
79691
|
+
$ref: '#/components/schemas/DetachCaseRequest'
|
|
79692
|
+
required: true
|
|
79693
|
+
responses:
|
|
79694
|
+
'204':
|
|
79695
|
+
description: No Content
|
|
79696
|
+
'400':
|
|
79697
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
79698
|
+
'404':
|
|
79699
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
79700
|
+
'429':
|
|
79701
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
79702
|
+
security:
|
|
79703
|
+
- apiKeyAuth: []
|
|
79704
|
+
appKeyAuth: []
|
|
79705
|
+
- AuthZ: []
|
|
79706
|
+
summary: Detach security findings from their case
|
|
79707
|
+
tags:
|
|
79708
|
+
- Security Monitoring
|
|
79709
|
+
x-codegen-request-body-name: body
|
|
79710
|
+
x-permission:
|
|
79711
|
+
operator: OR
|
|
79712
|
+
permissions:
|
|
79713
|
+
- security_monitoring_findings_write
|
|
79714
|
+
- appsec_vm_write
|
|
79715
|
+
post:
|
|
79716
|
+
description: Create cases for security findings. You can create up to 50 cases
|
|
79717
|
+
per request and associate up to 50 security findings per case. Security findings
|
|
79718
|
+
that are already attached to another case will be detached from their previous
|
|
79719
|
+
case and attached to the newly created case.
|
|
79720
|
+
operationId: CreateCases
|
|
79721
|
+
requestBody:
|
|
79722
|
+
content:
|
|
79723
|
+
application/json:
|
|
79724
|
+
schema:
|
|
79725
|
+
$ref: '#/components/schemas/CreateCaseRequestArray'
|
|
79726
|
+
required: true
|
|
79727
|
+
responses:
|
|
79728
|
+
'201':
|
|
79729
|
+
content:
|
|
79730
|
+
application/json:
|
|
79731
|
+
schema:
|
|
79732
|
+
$ref: '#/components/schemas/FindingCaseResponseArray'
|
|
79733
|
+
description: Created
|
|
79734
|
+
'400':
|
|
79735
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
79736
|
+
'404':
|
|
79737
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
79738
|
+
'429':
|
|
79739
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
79740
|
+
security:
|
|
79741
|
+
- apiKeyAuth: []
|
|
79742
|
+
appKeyAuth: []
|
|
79743
|
+
- AuthZ: []
|
|
79744
|
+
summary: Create cases for security findings
|
|
79745
|
+
tags:
|
|
79746
|
+
- Security Monitoring
|
|
79747
|
+
x-codegen-request-body-name: body
|
|
79748
|
+
x-permission:
|
|
79749
|
+
operator: OR
|
|
79750
|
+
permissions:
|
|
79751
|
+
- security_monitoring_findings_write
|
|
79752
|
+
- appsec_vm_write
|
|
79753
|
+
/api/v2/security/findings/cases/{case_id}:
|
|
79754
|
+
patch:
|
|
79755
|
+
description: Attach security findings to a case. You can attach up to 50 security
|
|
79756
|
+
findings per case. Security findings that are already attached to another
|
|
79757
|
+
case will be detached from their previous case and attached to the specified
|
|
79758
|
+
case.
|
|
79759
|
+
operationId: AttachCase
|
|
79760
|
+
parameters:
|
|
79761
|
+
- description: The unique identifier of the case to attach security findings
|
|
79762
|
+
to
|
|
79763
|
+
in: path
|
|
79764
|
+
name: case_id
|
|
79765
|
+
required: true
|
|
79766
|
+
schema:
|
|
79767
|
+
type: string
|
|
79768
|
+
requestBody:
|
|
79769
|
+
content:
|
|
79770
|
+
application/json:
|
|
79771
|
+
schema:
|
|
79772
|
+
$ref: '#/components/schemas/AttachCaseRequest'
|
|
79773
|
+
required: true
|
|
79774
|
+
responses:
|
|
79775
|
+
'200':
|
|
79776
|
+
content:
|
|
79777
|
+
application/json:
|
|
79778
|
+
schema:
|
|
79779
|
+
$ref: '#/components/schemas/FindingCaseResponse'
|
|
79780
|
+
description: OK
|
|
79781
|
+
'400':
|
|
79782
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
79783
|
+
'404':
|
|
79784
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
79785
|
+
'429':
|
|
79786
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
79787
|
+
security:
|
|
79788
|
+
- apiKeyAuth: []
|
|
79789
|
+
appKeyAuth: []
|
|
79790
|
+
- AuthZ: []
|
|
79791
|
+
summary: Attach security findings to a case
|
|
79792
|
+
tags:
|
|
79793
|
+
- Security Monitoring
|
|
79794
|
+
x-codegen-request-body-name: body
|
|
79795
|
+
x-permission:
|
|
79796
|
+
operator: OR
|
|
79797
|
+
permissions:
|
|
79798
|
+
- security_monitoring_findings_write
|
|
79799
|
+
- appsec_vm_write
|
|
79800
|
+
/api/v2/security/findings/jira_issues:
|
|
79801
|
+
patch:
|
|
79802
|
+
description: Attach security findings to a Jira issue by providing the Jira
|
|
79803
|
+
issue URL. You can attach up to 50 security findings per Jira issue. If the
|
|
79804
|
+
Jira issue is not linked to any case, this operation will create a case for
|
|
79805
|
+
the security findings and link the Jira issue to the newly created case. Security
|
|
79806
|
+
findings that are already attached to another Jira issue will be detached
|
|
79807
|
+
from their previous Jira issue and attached to the specified Jira issue.
|
|
79808
|
+
operationId: AttachJiraIssue
|
|
79809
|
+
requestBody:
|
|
79810
|
+
content:
|
|
79811
|
+
application/json:
|
|
79812
|
+
schema:
|
|
79813
|
+
$ref: '#/components/schemas/AttachJiraIssueRequest'
|
|
79814
|
+
required: true
|
|
79815
|
+
responses:
|
|
79816
|
+
'200':
|
|
79817
|
+
content:
|
|
79818
|
+
application/json:
|
|
79819
|
+
schema:
|
|
79820
|
+
$ref: '#/components/schemas/FindingCaseResponse'
|
|
79821
|
+
description: OK
|
|
79822
|
+
'400':
|
|
79823
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
79824
|
+
'404':
|
|
79825
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
79826
|
+
'429':
|
|
79827
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
79828
|
+
security:
|
|
79829
|
+
- apiKeyAuth: []
|
|
79830
|
+
appKeyAuth: []
|
|
79831
|
+
- AuthZ: []
|
|
79832
|
+
summary: Attach security findings to a Jira issue
|
|
79833
|
+
tags:
|
|
79834
|
+
- Security Monitoring
|
|
79835
|
+
x-codegen-request-body-name: body
|
|
79836
|
+
x-permission:
|
|
79837
|
+
operator: OR
|
|
79838
|
+
permissions:
|
|
79839
|
+
- security_monitoring_findings_write
|
|
79840
|
+
- appsec_vm_write
|
|
79841
|
+
post:
|
|
79842
|
+
description: Create Jira issues for security findings. This operation creates
|
|
79843
|
+
a case in Datadog and a Jira issue linked to that case for bidirectional sync
|
|
79844
|
+
between Datadog and Jira. You can create up to 50 Jira issues per request
|
|
79845
|
+
and associate up to 50 security findings per Jira issue. Security findings
|
|
79846
|
+
that are already attached to another Jira issue will be detached from their
|
|
79847
|
+
previous Jira issue and attached to the newly created Jira issue.
|
|
79848
|
+
operationId: CreateJiraIssues
|
|
79849
|
+
requestBody:
|
|
79850
|
+
content:
|
|
79851
|
+
application/json:
|
|
79852
|
+
schema:
|
|
79853
|
+
$ref: '#/components/schemas/CreateJiraIssueRequestArray'
|
|
79854
|
+
required: true
|
|
79855
|
+
responses:
|
|
79856
|
+
'201':
|
|
79857
|
+
content:
|
|
79858
|
+
application/json:
|
|
79859
|
+
schema:
|
|
79860
|
+
$ref: '#/components/schemas/FindingCaseResponseArray'
|
|
79861
|
+
description: Created
|
|
79862
|
+
'400':
|
|
79863
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
79864
|
+
'404':
|
|
79865
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
79866
|
+
'429':
|
|
79867
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
79868
|
+
security:
|
|
79869
|
+
- apiKeyAuth: []
|
|
79870
|
+
appKeyAuth: []
|
|
79871
|
+
- AuthZ: []
|
|
79872
|
+
summary: Create Jira issues for security findings
|
|
79873
|
+
tags:
|
|
79874
|
+
- Security Monitoring
|
|
79875
|
+
x-codegen-request-body-name: body
|
|
79876
|
+
x-permission:
|
|
79877
|
+
operator: OR
|
|
79878
|
+
permissions:
|
|
79879
|
+
- security_monitoring_findings_write
|
|
79880
|
+
- appsec_vm_write
|
|
76297
79881
|
/api/v2/security/sboms:
|
|
76298
79882
|
get:
|
|
76299
79883
|
description: 'Get a list of assets SBOMs for an organization.
|
|
@@ -78174,9 +81758,20 @@ paths:
|
|
|
78174
81758
|
/api/v2/security_monitoring/rules/convert:
|
|
78175
81759
|
post:
|
|
78176
81760
|
description: 'Convert a rule that doesn''t (yet) exist from JSON to Terraform
|
|
78177
|
-
for
|
|
81761
|
+
for Datadog provider
|
|
81762
|
+
|
|
81763
|
+
resource `datadog_security_monitoring_rule`. You can do so for the following
|
|
81764
|
+
rule types:
|
|
81765
|
+
|
|
81766
|
+
- App and API Protection
|
|
78178
81767
|
|
|
78179
|
-
|
|
81768
|
+
- Cloud SIEM (log detection and signal correlation)
|
|
81769
|
+
|
|
81770
|
+
- Workload Protection
|
|
81771
|
+
|
|
81772
|
+
|
|
81773
|
+
You can convert Cloud Security configuration rules using Terraform''s [Datadog
|
|
81774
|
+
Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).'
|
|
78180
81775
|
operationId: ConvertSecurityMonitoringRuleFromJSONToTerraform
|
|
78181
81776
|
requestBody:
|
|
78182
81777
|
content:
|
|
@@ -78393,9 +81988,20 @@ paths:
|
|
|
78393
81988
|
- security_monitoring_rules_write
|
|
78394
81989
|
/api/v2/security_monitoring/rules/{rule_id}/convert:
|
|
78395
81990
|
get:
|
|
78396
|
-
description: 'Convert an existing rule from JSON to Terraform for
|
|
81991
|
+
description: 'Convert an existing rule from JSON to Terraform for Datadog provider
|
|
81992
|
+
|
|
81993
|
+
resource `datadog_security_monitoring_rule`. You can do so for the following
|
|
81994
|
+
rule types:
|
|
81995
|
+
|
|
81996
|
+
- App and API Protection
|
|
81997
|
+
|
|
81998
|
+
- Cloud SIEM (log detection and signal correlation)
|
|
78397
81999
|
|
|
78398
|
-
|
|
82000
|
+
- Workload Protection
|
|
82001
|
+
|
|
82002
|
+
|
|
82003
|
+
You can convert Cloud Security configuration rules using Terraform''s [Datadog
|
|
82004
|
+
Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).'
|
|
78399
82005
|
operationId: ConvertExistingSecurityMonitoringRule
|
|
78400
82006
|
parameters:
|
|
78401
82007
|
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
|
|
@@ -81018,6 +84624,170 @@ paths:
|
|
|
81018
84624
|
permissions:
|
|
81019
84625
|
- teams_read
|
|
81020
84626
|
- teams_manage
|
|
84627
|
+
/api/v2/team-hierarchy-links:
|
|
84628
|
+
get:
|
|
84629
|
+
description: List all team hierarchy links that match the provided filters.
|
|
84630
|
+
operationId: ListTeamHierarchyLinks
|
|
84631
|
+
parameters:
|
|
84632
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
84633
|
+
- $ref: '#/components/parameters/PageSize'
|
|
84634
|
+
- description: Filter by parent team ID
|
|
84635
|
+
in: query
|
|
84636
|
+
name: filter[parent_team]
|
|
84637
|
+
required: false
|
|
84638
|
+
schema:
|
|
84639
|
+
type: string
|
|
84640
|
+
- description: Filter by sub team ID
|
|
84641
|
+
in: query
|
|
84642
|
+
name: filter[sub_team]
|
|
84643
|
+
required: false
|
|
84644
|
+
schema:
|
|
84645
|
+
type: string
|
|
84646
|
+
responses:
|
|
84647
|
+
'200':
|
|
84648
|
+
content:
|
|
84649
|
+
application/json:
|
|
84650
|
+
schema:
|
|
84651
|
+
$ref: '#/components/schemas/TeamHierarchyLinksResponse'
|
|
84652
|
+
description: OK
|
|
84653
|
+
'403':
|
|
84654
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
84655
|
+
'429':
|
|
84656
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
84657
|
+
security:
|
|
84658
|
+
- apiKeyAuth: []
|
|
84659
|
+
appKeyAuth: []
|
|
84660
|
+
- AuthZ:
|
|
84661
|
+
- teams_read
|
|
84662
|
+
summary: Get team hierarchy links
|
|
84663
|
+
tags:
|
|
84664
|
+
- Teams
|
|
84665
|
+
x-pagination:
|
|
84666
|
+
limitParam: page[size]
|
|
84667
|
+
pageParam: page[number]
|
|
84668
|
+
resultsPath: data
|
|
84669
|
+
x-permission:
|
|
84670
|
+
operator: OR
|
|
84671
|
+
permissions:
|
|
84672
|
+
- teams_read
|
|
84673
|
+
post:
|
|
84674
|
+
description: Create a new team hierarchy link between a parent team and a sub
|
|
84675
|
+
team.
|
|
84676
|
+
operationId: AddTeamHierarchyLink
|
|
84677
|
+
requestBody:
|
|
84678
|
+
content:
|
|
84679
|
+
application/json:
|
|
84680
|
+
schema:
|
|
84681
|
+
$ref: '#/components/schemas/TeamHierarchyLinkCreateRequest'
|
|
84682
|
+
required: true
|
|
84683
|
+
responses:
|
|
84684
|
+
'200':
|
|
84685
|
+
content:
|
|
84686
|
+
application/json:
|
|
84687
|
+
schema:
|
|
84688
|
+
$ref: '#/components/schemas/TeamHierarchyLinkResponse'
|
|
84689
|
+
description: OK
|
|
84690
|
+
'403':
|
|
84691
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
84692
|
+
'409':
|
|
84693
|
+
content:
|
|
84694
|
+
application/json:
|
|
84695
|
+
schema:
|
|
84696
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
84697
|
+
description: Conflict
|
|
84698
|
+
'429':
|
|
84699
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
84700
|
+
security:
|
|
84701
|
+
- apiKeyAuth: []
|
|
84702
|
+
appKeyAuth: []
|
|
84703
|
+
- AuthZ:
|
|
84704
|
+
- teams_read
|
|
84705
|
+
- teams_manage
|
|
84706
|
+
summary: Create a team hierarchy link
|
|
84707
|
+
tags:
|
|
84708
|
+
- Teams
|
|
84709
|
+
x-permission:
|
|
84710
|
+
operator: AND
|
|
84711
|
+
permissions:
|
|
84712
|
+
- teams_read
|
|
84713
|
+
- teams_manage
|
|
84714
|
+
/api/v2/team-hierarchy-links/{link_id}:
|
|
84715
|
+
delete:
|
|
84716
|
+
description: Remove a team hierarchy link by the given link_id.
|
|
84717
|
+
operationId: RemoveTeamHierarchyLink
|
|
84718
|
+
parameters:
|
|
84719
|
+
- description: The team hierarchy link's identifier
|
|
84720
|
+
in: path
|
|
84721
|
+
name: link_id
|
|
84722
|
+
required: true
|
|
84723
|
+
schema:
|
|
84724
|
+
type: string
|
|
84725
|
+
responses:
|
|
84726
|
+
'204':
|
|
84727
|
+
description: No Content
|
|
84728
|
+
'403':
|
|
84729
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
84730
|
+
'404':
|
|
84731
|
+
content:
|
|
84732
|
+
application/json:
|
|
84733
|
+
schema:
|
|
84734
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
84735
|
+
description: API error response.
|
|
84736
|
+
'429':
|
|
84737
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
84738
|
+
security:
|
|
84739
|
+
- apiKeyAuth: []
|
|
84740
|
+
appKeyAuth: []
|
|
84741
|
+
- AuthZ:
|
|
84742
|
+
- teams_read
|
|
84743
|
+
- teams_manage
|
|
84744
|
+
summary: Remove a team hierarchy link
|
|
84745
|
+
tags:
|
|
84746
|
+
- Teams
|
|
84747
|
+
x-permission:
|
|
84748
|
+
operator: AND
|
|
84749
|
+
permissions:
|
|
84750
|
+
- teams_read
|
|
84751
|
+
- teams_manage
|
|
84752
|
+
get:
|
|
84753
|
+
description: Get a single team hierarchy link for the given link_id.
|
|
84754
|
+
operationId: GetTeamHierarchyLink
|
|
84755
|
+
parameters:
|
|
84756
|
+
- description: The team hierarchy link's identifier
|
|
84757
|
+
in: path
|
|
84758
|
+
name: link_id
|
|
84759
|
+
required: true
|
|
84760
|
+
schema:
|
|
84761
|
+
type: string
|
|
84762
|
+
responses:
|
|
84763
|
+
'200':
|
|
84764
|
+
content:
|
|
84765
|
+
application/json:
|
|
84766
|
+
schema:
|
|
84767
|
+
$ref: '#/components/schemas/TeamHierarchyLinkResponse'
|
|
84768
|
+
description: OK
|
|
84769
|
+
'403':
|
|
84770
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
84771
|
+
'404':
|
|
84772
|
+
content:
|
|
84773
|
+
application/json:
|
|
84774
|
+
schema:
|
|
84775
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
84776
|
+
description: API error response.
|
|
84777
|
+
'429':
|
|
84778
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
84779
|
+
security:
|
|
84780
|
+
- apiKeyAuth: []
|
|
84781
|
+
appKeyAuth: []
|
|
84782
|
+
- AuthZ:
|
|
84783
|
+
- teams_read
|
|
84784
|
+
summary: Get a team hierarchy link
|
|
84785
|
+
tags:
|
|
84786
|
+
- Teams
|
|
84787
|
+
x-permission:
|
|
84788
|
+
operator: OR
|
|
84789
|
+
permissions:
|
|
84790
|
+
- teams_read
|
|
81021
84791
|
/api/v2/team/connections:
|
|
81022
84792
|
delete:
|
|
81023
84793
|
description: Delete multiple team connections.
|
|
@@ -81046,7 +84816,7 @@ paths:
|
|
|
81046
84816
|
- teams_read
|
|
81047
84817
|
summary: Delete team connections
|
|
81048
84818
|
tags:
|
|
81049
|
-
-
|
|
84819
|
+
- Teams
|
|
81050
84820
|
x-permission:
|
|
81051
84821
|
operator: OR
|
|
81052
84822
|
permissions:
|
|
@@ -81125,7 +84895,7 @@ paths:
|
|
|
81125
84895
|
- teams_read
|
|
81126
84896
|
summary: List team connections
|
|
81127
84897
|
tags:
|
|
81128
|
-
-
|
|
84898
|
+
- Teams
|
|
81129
84899
|
x-pagination:
|
|
81130
84900
|
limitParam: page[size]
|
|
81131
84901
|
pageParam: page[number]
|
|
@@ -81169,7 +84939,7 @@ paths:
|
|
|
81169
84939
|
- teams_read
|
|
81170
84940
|
summary: Create team connections
|
|
81171
84941
|
tags:
|
|
81172
|
-
-
|
|
84942
|
+
- Teams
|
|
81173
84943
|
x-permission:
|
|
81174
84944
|
operator: OR
|
|
81175
84945
|
permissions:
|
|
@@ -81179,6 +84949,52 @@ paths:
|
|
|
81179
84949
|
|
|
81180
84950
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
81181
84951
|
/api/v2/team/sync:
|
|
84952
|
+
get:
|
|
84953
|
+
description: 'Get all team synchronization configurations.
|
|
84954
|
+
|
|
84955
|
+
Returns a list of configurations used for linking or provisioning teams with
|
|
84956
|
+
external sources like GitHub.'
|
|
84957
|
+
operationId: GetTeamSync
|
|
84958
|
+
parameters:
|
|
84959
|
+
- description: Filter by the external source platform for team synchronization
|
|
84960
|
+
in: query
|
|
84961
|
+
name: filter[source]
|
|
84962
|
+
required: true
|
|
84963
|
+
schema:
|
|
84964
|
+
$ref: '#/components/schemas/TeamSyncAttributesSource'
|
|
84965
|
+
responses:
|
|
84966
|
+
'200':
|
|
84967
|
+
content:
|
|
84968
|
+
application/json:
|
|
84969
|
+
schema:
|
|
84970
|
+
$ref: '#/components/schemas/TeamSyncResponse'
|
|
84971
|
+
description: OK
|
|
84972
|
+
'403':
|
|
84973
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
84974
|
+
'404':
|
|
84975
|
+
content:
|
|
84976
|
+
application/json:
|
|
84977
|
+
schema:
|
|
84978
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
84979
|
+
description: Team sync configurations not found
|
|
84980
|
+
'429':
|
|
84981
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
84982
|
+
security:
|
|
84983
|
+
- apiKeyAuth: []
|
|
84984
|
+
appKeyAuth: []
|
|
84985
|
+
- AuthZ:
|
|
84986
|
+
- teams_read
|
|
84987
|
+
summary: Get team sync configurations
|
|
84988
|
+
tags:
|
|
84989
|
+
- Teams
|
|
84990
|
+
x-permission:
|
|
84991
|
+
operator: OR
|
|
84992
|
+
permissions:
|
|
84993
|
+
- teams_read
|
|
84994
|
+
x-unstable: '**Note**: This endpoint is in Preview. To request access, fill
|
|
84995
|
+
out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).
|
|
84996
|
+
|
|
84997
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
81182
84998
|
post:
|
|
81183
84999
|
description: 'This endpoint attempts to link your existing Datadog teams with
|
|
81184
85000
|
GitHub teams by matching their names.
|
|
@@ -81205,7 +85021,8 @@ paths:
|
|
|
81205
85021
|
using a normalized exact match; case is ignored and spaces are removed. No
|
|
81206
85022
|
modifications are made
|
|
81207
85023
|
|
|
81208
|
-
to teams in GitHub. This
|
|
85024
|
+
to teams in GitHub. This only creates new teams in Datadog when type is set
|
|
85025
|
+
to `provision`.'
|
|
81209
85026
|
operationId: SyncTeams
|
|
81210
85027
|
requestBody:
|
|
81211
85028
|
content:
|
|
@@ -81245,7 +85062,13 @@ paths:
|
|
|
81245
85062
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
81246
85063
|
/api/v2/team/{super_team_id}/member_teams:
|
|
81247
85064
|
get:
|
|
81248
|
-
|
|
85065
|
+
deprecated: true
|
|
85066
|
+
description: 'Get all member teams.
|
|
85067
|
+
|
|
85068
|
+
|
|
85069
|
+
**Note**: This API is deprecated. For team hierarchy relationships (parent-child
|
|
85070
|
+
|
|
85071
|
+
teams), use the team hierarchy links API: `GET /api/v2/team-hierarchy-links`.'
|
|
81249
85072
|
operationId: ListMemberTeams
|
|
81250
85073
|
parameters:
|
|
81251
85074
|
- description: None
|
|
@@ -81298,14 +85121,20 @@ paths:
|
|
|
81298
85121
|
operator: OR
|
|
81299
85122
|
permissions:
|
|
81300
85123
|
- teams_read
|
|
85124
|
+
x-sunset: '2026-06-01'
|
|
81301
85125
|
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
|
81302
85126
|
|
|
81303
85127
|
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
81304
85128
|
post:
|
|
85129
|
+
deprecated: true
|
|
81305
85130
|
description: 'Add a member team.
|
|
81306
85131
|
|
|
81307
85132
|
Adds the team given by the `id` in the body as a member team of the super
|
|
81308
|
-
team.
|
|
85133
|
+
team.
|
|
85134
|
+
|
|
85135
|
+
|
|
85136
|
+
**Note**: This API is deprecated. For creating team hierarchy links, use the
|
|
85137
|
+
team hierarchy links API: `POST /api/v2/team-hierarchy-links`.'
|
|
81309
85138
|
operationId: AddMemberTeam
|
|
81310
85139
|
parameters:
|
|
81311
85140
|
- description: None
|
|
@@ -81345,12 +85174,18 @@ paths:
|
|
|
81345
85174
|
operator: OR
|
|
81346
85175
|
permissions:
|
|
81347
85176
|
- teams_read
|
|
85177
|
+
x-sunset: '2026-06-01'
|
|
81348
85178
|
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
|
81349
85179
|
|
|
81350
85180
|
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
81351
85181
|
/api/v2/team/{super_team_id}/member_teams/{member_team_id}:
|
|
81352
85182
|
delete:
|
|
81353
|
-
|
|
85183
|
+
deprecated: true
|
|
85184
|
+
description: 'Remove a super team''s member team identified by `member_team_id`.
|
|
85185
|
+
|
|
85186
|
+
|
|
85187
|
+
**Note**: This API is deprecated. For deleting team hierarchy links, use the
|
|
85188
|
+
team hierarchy links API: `DELETE /api/v2/team-hierarchy-links/{link_id}`.'
|
|
81354
85189
|
operationId: RemoveMemberTeam
|
|
81355
85190
|
parameters:
|
|
81356
85191
|
- description: None
|
|
@@ -81390,6 +85225,7 @@ paths:
|
|
|
81390
85225
|
operator: OR
|
|
81391
85226
|
permissions:
|
|
81392
85227
|
- teams_read
|
|
85228
|
+
x-sunset: '2026-06-01'
|
|
81393
85229
|
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
|
81394
85230
|
|
|
81395
85231
|
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
@@ -82304,8 +86140,7 @@ paths:
|
|
|
82304
86140
|
operator: OR
|
|
82305
86141
|
permissions:
|
|
82306
86142
|
- test_optimization_read
|
|
82307
|
-
x-unstable: '**Note**: This endpoint is in
|
|
82308
|
-
change.
|
|
86143
|
+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
|
|
82309
86144
|
|
|
82310
86145
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
82311
86146
|
/api/v2/usage/application_security:
|
|
@@ -84039,6 +87874,10 @@ tags:
|
|
|
84039
87874
|
|
|
84040
87875
|
view certain types of telemetry (for example, logs, traces, metrics, and RUM data).'
|
|
84041
87876
|
name: Datasets
|
|
87877
|
+
- description: Manage Deployment Gates using this API to reduce the likelihood and
|
|
87878
|
+
impact of incidents caused by deployments. See the [Deployment Gates documentation](https://docs.datadoghq.com/deployment_gates/)
|
|
87879
|
+
for more information.
|
|
87880
|
+
name: Deployment Gates
|
|
84042
87881
|
- description: 'Configure your Datadog Email Domain Allowlist directly through the
|
|
84043
87882
|
Datadog API.
|
|
84044
87883
|
|
|
@@ -84179,6 +88018,44 @@ tags:
|
|
|
84179
88018
|
description: Find out more at
|
|
84180
88019
|
url: https://docs.datadoghq.com/logs/logs_to_metrics/
|
|
84181
88020
|
name: Logs Metrics
|
|
88021
|
+
- description: '**Note: This endpoint is in public beta. If you have any feedback,
|
|
88022
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).**
|
|
88023
|
+
|
|
88024
|
+
|
|
88025
|
+
A Restriction Query is a logs query that restricts which logs the `logs_read_data`
|
|
88026
|
+
permission grants read access to.
|
|
88027
|
+
|
|
88028
|
+
For users whose roles have Restriction Queries, any log query they make only returns
|
|
88029
|
+
those log events that also match
|
|
88030
|
+
|
|
88031
|
+
one of their Restriction Queries. This is true whether the user queries log events
|
|
88032
|
+
from any log-related feature, including
|
|
88033
|
+
|
|
88034
|
+
the log explorer, Live Tail, re-hydration, or a dashboard widget.
|
|
88035
|
+
|
|
88036
|
+
|
|
88037
|
+
Restriction Queries currently only support use of the following components of
|
|
88038
|
+
log events:
|
|
88039
|
+
|
|
88040
|
+
|
|
88041
|
+
- Reserved attributes
|
|
88042
|
+
|
|
88043
|
+
- The log message
|
|
88044
|
+
|
|
88045
|
+
- Tags
|
|
88046
|
+
|
|
88047
|
+
|
|
88048
|
+
To restrict read access on log data, add a team tag to log events to indicate
|
|
88049
|
+
which teams own them, and then scope Restriction Queries to the relevant values
|
|
88050
|
+
of the team tag. Tags can be applied to log events in many ways, and a log event
|
|
88051
|
+
can have multiple tags with the same key (like team) and different values. This
|
|
88052
|
+
means the same log event can be visible to roles whose restriction queries are
|
|
88053
|
+
scoped to different team values.
|
|
88054
|
+
|
|
88055
|
+
|
|
88056
|
+
See [How to Set Up RBAC for Logs](https://docs.datadoghq.com/logs/guide/logs-rbac/?tab=api#restrict-access-to-logs)
|
|
88057
|
+
for details on how to add restriction queries.'
|
|
88058
|
+
name: Logs Restriction Queries
|
|
84182
88059
|
- description: "The metrics endpoint allows you to:\n\n- Post metrics data so it can
|
|
84183
88060
|
be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period
|
|
84184
88061
|
(timeseries and scalar)\n- Modify tag configurations for metrics\n- View tags
|
|
@@ -84383,9 +88260,6 @@ tags:
|
|
|
84383
88260
|
use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more
|
|
84384
88261
|
information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)."
|
|
84385
88262
|
name: Synthetics
|
|
84386
|
-
- description: View and manage relationships between Datadog teams and teams from
|
|
84387
|
-
external sources, such as GitHub.
|
|
84388
|
-
name: Team Connections
|
|
84389
88263
|
- description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/)
|
|
84390
88264
|
for more information.
|
|
84391
88265
|
name: Teams
|