datadog_api_client 2.19.0 → 2.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/conftest.py +5 -0
- data/.generator/schemas/v1/openapi.yaml +430 -172
- data/.generator/schemas/v2/openapi.yaml +3146 -165
- data/.generator/src/generator/templates/api.j2 +5 -5
- data/CHANGELOG.md +48 -0
- data/examples/v1/gcp-integration/CreateGCPIntegration.rb +3 -0
- data/examples/v1/gcp-integration/UpdateGCPIntegration_3544259255.rb +25 -0
- data/examples/v1/logs-indexes/CreateLogsIndex.rb +5 -0
- data/examples/v1/logs-indexes/UpdateLogsIndex.rb +5 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +29 -0
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest.rb +1 -1
- data/examples/v1/synthetics/TriggerCITests.rb +1 -1
- data/examples/v1/synthetics/UpdateBrowserTest.rb +2 -1
- data/examples/v1/usage-metering/GetUsageLambda.rb +5 -2
- data/examples/v2/api-management/CreateOpenAPI.rb +11 -0
- data/examples/v2/api-management/DeleteOpenAPI.rb +11 -0
- data/examples/v2/api-management/GetOpenAPI.rb +11 -0
- data/examples/v2/api-management/UpdateOpenAPI.rb +14 -0
- data/examples/v2/case-management/ArchiveCase.rb +14 -0
- data/examples/v2/case-management/AssignCase.rb +20 -0
- data/examples/v2/case-management/CreateCase.rb +33 -0
- data/examples/v2/case-management/CreateProject.rb +15 -0
- data/examples/v2/case-management/DeleteProject.rb +5 -0
- data/examples/v2/case-management/GetCase.rb +8 -0
- data/examples/v2/case-management/GetProject.rb +5 -0
- data/examples/v2/case-management/GetProjects.rb +5 -0
- data/examples/v2/case-management/SearchCases.rb +5 -0
- data/examples/v2/case-management/SearchCases_3433960044.rb +5 -0
- data/examples/v2/case-management/UnarchiveCase.rb +14 -0
- data/examples/v2/case-management/UnassignCase.rb +14 -0
- data/examples/v2/case-management/UpdatePriority.rb +17 -0
- data/examples/v2/case-management/UpdateStatus.rb +17 -0
- data/examples/v2/cloud-workload-security/CreateCSMThreatsAgentRule.rb +17 -0
- data/examples/v2/cloud-workload-security/DeleteCSMThreatsAgentRule.rb +8 -0
- data/examples/v2/cloud-workload-security/DownloadCSMThreatsPolicy.rb +5 -0
- data/examples/v2/cloud-workload-security/GetCSMThreatsAgentRule.rb +8 -0
- data/examples/v2/cloud-workload-security/ListCSMThreatsAgentRules.rb +5 -0
- data/examples/v2/cloud-workload-security/UpdateCSMThreatsAgentRule.rb +20 -0
- data/examples/v2/dora-metrics/CreateDORAIncident.rb +6 -3
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_194782945.rb +18 -0
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount_2241994060.rb +21 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination.rb +31 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_1091442807.rb +31 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_1288180912.rb +27 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_141236188.rb +32 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_2184123765.rb +31 -0
- data/examples/v2/logs-custom-destinations/DeleteLogsCustomDestination.rb +8 -0
- data/examples/v2/logs-custom-destinations/GetLogsCustomDestination.rb +8 -0
- data/examples/v2/logs-custom-destinations/ListLogsCustomDestinations.rb +5 -0
- data/examples/v2/logs-custom-destinations/UpdateLogsCustomDestination.rb +18 -0
- data/examples/v2/metrics/ListMetricAssets.rb +5 -0
- data/examples/v2/okta-integration/CreateOktaAccount.rb +1 -1
- data/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression.rb +19 -0
- data/examples/v2/security-monitoring/DeleteSecurityMonitoringSuppression.rb +8 -0
- data/examples/v2/security-monitoring/GetSecurityMonitoringSuppression.rb +8 -0
- data/examples/v2/security-monitoring/ListSecurityMonitoringSuppressions.rb +5 -0
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringSuppression.rb +17 -0
- data/examples/v2/teams/GetTeamMemberships_3799131168.rb +8 -0
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb +1 -1
- data/lib/datadog_api_client/configuration.rb +4 -0
- data/lib/datadog_api_client/inflector.rb +134 -0
- data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -3
- data/lib/datadog_api_client/v1/api/organizations_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +8 -8
- data/lib/datadog_api_client/v1/models/dashboard.rb +5 -1
- data/lib/datadog_api_client/v1/models/dashboard_summary_definition.rb +2 -0
- data/lib/datadog_api_client/v1/models/gcp_account.rb +14 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +6 -0
- data/lib/datadog_api_client/v1/models/log.rb +1 -1
- data/lib/datadog_api_client/v1/models/logs_daily_limit_reset.rb +90 -0
- data/lib/datadog_api_client/v1/models/logs_index.rb +36 -1
- data/lib/datadog_api_client/v1/models/logs_index_update_request.rb +36 -1
- data/lib/datadog_api_client/v1/models/metrics_payload.rb +1 -1
- data/lib/datadog_api_client/v1/models/metrics_query_metadata.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_events_data_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +8 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +84 -4
- data/lib/datadog_api_client/v1/models/slo_correction_create_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_response_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_update_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_history_metrics.rb +2 -2
- data/lib/datadog_api_client/v1/models/slo_history_metrics_series.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_history_monitor.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_history_sli_data.rb +1 -1
- data/lib/datadog_api_client/v1/models/split_config.rb +6 -6
- data/lib/datadog_api_client/v1/models/synthetics_api_step_subtype.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +21 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +2 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +2 -0
- data/lib/datadog_api_client/v1/models/usage_lambda_hour.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_lambda_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +81 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +83 -3
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +182 -102
- data/lib/datadog_api_client/v2/api/api_management_api.rb +319 -0
- data/lib/datadog_api_client/v2/api/case_management_api.rb +942 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/cloud_workload_security_api.rb +392 -0
- data/lib/datadog_api_client/v2/api/incident_services_api.rb +15 -0
- data/lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb +355 -0
- data/lib/datadog_api_client/v2/api/metrics_api.rb +69 -1
- data/lib/datadog_api_client/v2/api/organizations_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +329 -0
- data/lib/datadog_api_client/v2/api/service_definition_api.rb +2 -1
- data/lib/datadog_api_client/v2/api/teams_api.rb +22 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +6 -6
- data/lib/datadog_api_client/v2/models/case.rb +150 -0
- data/lib/datadog_api_client/v2/models/case3rd_party_ticket_status.rb +28 -0
- data/lib/datadog_api_client/v2/models/case_assign.rb +119 -0
- data/lib/datadog_api_client/v2/models/case_assign_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_assign_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_attributes.rb +202 -0
- data/lib/datadog_api_client/v2/models/case_create.rb +129 -0
- data/lib/datadog_api_client/v2/models/case_create_attributes.rb +139 -0
- data/lib/datadog_api_client/v2/models/case_create_relationships.rb +116 -0
- data/lib/datadog_api_client/v2/models/case_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_empty.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_empty_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_priority.rb +31 -0
- data/lib/datadog_api_client/v2/models/case_relationships.rb +120 -0
- data/lib/datadog_api_client/v2/models/case_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/case_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/case_sortable_field.rb +28 -0
- data/lib/datadog_api_client/v2/models/case_status.rb +28 -0
- data/lib/datadog_api_client/v2/models/case_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/case_update_priority.rb +119 -0
- data/lib/datadog_api_client/v2/models/case_update_priority_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_update_priority_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_update_status.rb +119 -0
- data/lib/datadog_api_client/v2/models/case_update_status_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_update_status_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/cases_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/cases_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/cases_response_meta_pagination.rb +100 -0
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_sort.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_group_by.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_tests_group_by.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action.rb +90 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_kill.rb +80 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_update_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/create_open_api_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/create_open_api_response_attributes.rb +82 -0
- data/lib/datadog_api_client/v2/models/create_open_api_response_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/custom_destination_attribute_tags_restriction_list_type.rb +31 -0
- data/lib/datadog_api_client/v2/models/custom_destination_create_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_destination_create_request_attributes.rb +193 -0
- data/lib/datadog_api_client/v2/models/custom_destination_create_request_definition.rb +119 -0
- data/lib/datadog_api_client/v2/models/custom_destination_elasticsearch_destination_auth.rb +119 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination.rb +64 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_elasticsearch.rb +181 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_elasticsearch_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_http.rb +141 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_http_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_splunk.rb +141 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_splunk_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth.rb +63 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_basic.rb +140 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_basic_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_custom_header.rb +140 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_custom_header_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_attributes.rb +171 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_definition.rb +100 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination.rb +64 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch.rb +181 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_http.rb +141 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_http_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_splunk.rb +120 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_splunk_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth.rb +63 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_basic.rb +98 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_basic_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_custom_header.rb +119 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_custom_header_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_update_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_destination_update_request_attributes.rb +169 -0
- data/lib/datadog_api_client/v2/models/custom_destination_update_request_definition.rb +129 -0
- data/lib/datadog_api_client/v2/models/custom_destinations_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +31 -20
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +14 -1
- data/lib/datadog_api_client/v2/models/jira_issue.rb +90 -0
- data/lib/datadog_api_client/v2/models/jira_issue_result.rb +110 -0
- data/lib/datadog_api_client/v2/models/logs_archive_integration_gcs.rb +1 -12
- data/lib/datadog_api_client/v2/models/metric_asset_attributes.rb +80 -0
- data/lib/datadog_api_client/v2/models/metric_asset_dashboard_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_dashboard_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_asset_monitor_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_monitor_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_asset_notebook_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_notebook_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_asset_response_data.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_asset_response_included.rb +65 -0
- data/lib/datadog_api_client/v2/models/metric_asset_response_relationships.rb +110 -0
- data/lib/datadog_api_client/v2/models/metric_asset_slo_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_slo_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_assets_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/metric_dashboard_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_dashboard_attributes.rb +112 -0
- data/lib/datadog_api_client/v2/models/metric_dashboard_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_monitor_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_monitor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_notebook_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_notebook_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_payload.rb +1 -1
- data/lib/datadog_api_client/v2/models/metric_slo_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_slo_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/nullable_user_relationship.rb +88 -0
- data/lib/datadog_api_client/v2/models/nullable_user_relationship_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/open_api_endpoint.rb +90 -0
- data/lib/datadog_api_client/v2/models/open_api_file.rb +80 -0
- data/lib/datadog_api_client/v2/models/project.rb +150 -0
- data/lib/datadog_api_client/v2/models/project_attributes.rb +90 -0
- data/lib/datadog_api_client/v2/models/project_create.rb +119 -0
- data/lib/datadog_api_client/v2/models/project_create_attributes.rb +119 -0
- data/lib/datadog_api_client/v2/models/project_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/project_relationship.rb +98 -0
- data/lib/datadog_api_client/v2/models/project_relationship_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/project_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/project_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/project_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/projects_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression.rb +100 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_attributes.rb +198 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_attributes.rb +181 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_attributes.rb +166 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppressions_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_user.rb +98 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_included_keyword_configuration.rb +1 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/service_now_ticket.rb +90 -0
- data/lib/datadog_api_client/v2/models/service_now_ticket_result.rb +80 -0
- data/lib/datadog_api_client/v2/models/update_open_api_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/update_open_api_response_attributes.rb +82 -0
- data/lib/datadog_api_client/v2/models/update_open_api_response_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/user_relationship_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/user_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/user_team_included.rb +62 -0
- data/lib/datadog_api_client/v2/models/user_team_response.rb +16 -4
- data/lib/datadog_api_client/v2/models/users_relationship.rb +100 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +179 -3
- data/examples/v1/usage-metering/GetUsageLambda_3132428705.rb +0 -8
|
@@ -151,6 +151,21 @@ components:
|
|
|
151
151
|
required: true
|
|
152
152
|
schema:
|
|
153
153
|
type: string
|
|
154
|
+
CaseIDPathParameter:
|
|
155
|
+
description: Case's UUID or key
|
|
156
|
+
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
|
|
157
|
+
in: path
|
|
158
|
+
name: case_id
|
|
159
|
+
required: true
|
|
160
|
+
schema:
|
|
161
|
+
type: string
|
|
162
|
+
CaseSortableFieldParameter:
|
|
163
|
+
description: Specify which field to sort
|
|
164
|
+
in: query
|
|
165
|
+
name: sort[field]
|
|
166
|
+
required: false
|
|
167
|
+
schema:
|
|
168
|
+
$ref: '#/components/schemas/CaseSortableField'
|
|
154
169
|
CloudAccountID:
|
|
155
170
|
description: Cloud Account id.
|
|
156
171
|
in: path
|
|
@@ -180,6 +195,13 @@ components:
|
|
|
180
195
|
required: true
|
|
181
196
|
schema:
|
|
182
197
|
type: string
|
|
198
|
+
CustomDestinationId:
|
|
199
|
+
description: The ID of the custom destination.
|
|
200
|
+
in: path
|
|
201
|
+
name: custom_destination_id
|
|
202
|
+
required: true
|
|
203
|
+
schema:
|
|
204
|
+
type: string
|
|
183
205
|
FastlyAccountID:
|
|
184
206
|
description: Fastly Account id.
|
|
185
207
|
in: path
|
|
@@ -381,6 +403,14 @@ components:
|
|
|
381
403
|
example: 10
|
|
382
404
|
format: int64
|
|
383
405
|
type: integer
|
|
406
|
+
ProjectIDPathParameter:
|
|
407
|
+
description: Project UUID
|
|
408
|
+
example: e555e290-ed65-49bd-ae18-8acbfcf18db7
|
|
409
|
+
in: path
|
|
410
|
+
name: project_id
|
|
411
|
+
required: true
|
|
412
|
+
schema:
|
|
413
|
+
type: string
|
|
384
414
|
ResourceID:
|
|
385
415
|
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
|
|
386
416
|
`dashboard`, `notebook`, `security-rule`, `slo`.'
|
|
@@ -432,6 +462,13 @@ components:
|
|
|
432
462
|
required: true
|
|
433
463
|
schema:
|
|
434
464
|
type: string
|
|
465
|
+
SecurityMonitoringSuppressionID:
|
|
466
|
+
description: The ID of the suppression rule
|
|
467
|
+
in: path
|
|
468
|
+
name: suppression_id
|
|
469
|
+
required: true
|
|
470
|
+
schema:
|
|
471
|
+
type: string
|
|
435
472
|
SensitiveDataScannerGroupID:
|
|
436
473
|
description: The ID of a group of rules.
|
|
437
474
|
in: path
|
|
@@ -832,6 +869,11 @@ components:
|
|
|
832
869
|
type: string
|
|
833
870
|
x-enum-varnames:
|
|
834
871
|
- BILLING_DIMENSIONS
|
|
872
|
+
ApiID:
|
|
873
|
+
description: API identifier.
|
|
874
|
+
example: 90646597-5fdb-4a17-a240-647003f8c028
|
|
875
|
+
format: uuid
|
|
876
|
+
type: string
|
|
835
877
|
ApmRetentionFilterType:
|
|
836
878
|
default: apm_retention_filter
|
|
837
879
|
description: The type of the resource.
|
|
@@ -2004,7 +2046,8 @@ components:
|
|
|
2004
2046
|
type: number
|
|
2005
2047
|
type: object
|
|
2006
2048
|
CIAppAggregateSort:
|
|
2007
|
-
description: A sort rule.
|
|
2049
|
+
description: A sort rule. The `aggregation` field is required when `type` is
|
|
2050
|
+
`measure`.
|
|
2008
2051
|
example:
|
|
2009
2052
|
aggregation: count
|
|
2010
2053
|
order: asc
|
|
@@ -3320,6 +3363,345 @@ components:
|
|
|
3320
3363
|
from the other indexes
|
|
3321
3364
|
type: string
|
|
3322
3365
|
type: object
|
|
3366
|
+
Case:
|
|
3367
|
+
description: A case
|
|
3368
|
+
properties:
|
|
3369
|
+
attributes:
|
|
3370
|
+
$ref: '#/components/schemas/CaseAttributes'
|
|
3371
|
+
id:
|
|
3372
|
+
description: Case's identifier
|
|
3373
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
3374
|
+
type: string
|
|
3375
|
+
relationships:
|
|
3376
|
+
$ref: '#/components/schemas/CaseRelationships'
|
|
3377
|
+
type:
|
|
3378
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3379
|
+
required:
|
|
3380
|
+
- id
|
|
3381
|
+
- type
|
|
3382
|
+
- attributes
|
|
3383
|
+
type: object
|
|
3384
|
+
Case3rdPartyTicketStatus:
|
|
3385
|
+
default: IN_PROGRESS
|
|
3386
|
+
description: Case status
|
|
3387
|
+
enum:
|
|
3388
|
+
- IN_PROGRESS
|
|
3389
|
+
- COMPLETED
|
|
3390
|
+
- FAILED
|
|
3391
|
+
example: COMPLETED
|
|
3392
|
+
readOnly: true
|
|
3393
|
+
type: string
|
|
3394
|
+
x-enum-varnames:
|
|
3395
|
+
- IN_PROGRESS
|
|
3396
|
+
- COMPLETED
|
|
3397
|
+
- FAILED
|
|
3398
|
+
CaseAssign:
|
|
3399
|
+
description: Case assign
|
|
3400
|
+
properties:
|
|
3401
|
+
attributes:
|
|
3402
|
+
$ref: '#/components/schemas/CaseAssignAttributes'
|
|
3403
|
+
type:
|
|
3404
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3405
|
+
required:
|
|
3406
|
+
- attributes
|
|
3407
|
+
- type
|
|
3408
|
+
type: object
|
|
3409
|
+
CaseAssignAttributes:
|
|
3410
|
+
description: Case assign attributes
|
|
3411
|
+
properties:
|
|
3412
|
+
assignee_id:
|
|
3413
|
+
description: Assignee's UUID
|
|
3414
|
+
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
|
|
3415
|
+
type: string
|
|
3416
|
+
required:
|
|
3417
|
+
- assignee_id
|
|
3418
|
+
type: object
|
|
3419
|
+
CaseAssignRequest:
|
|
3420
|
+
description: Case assign request
|
|
3421
|
+
properties:
|
|
3422
|
+
data:
|
|
3423
|
+
$ref: '#/components/schemas/CaseAssign'
|
|
3424
|
+
required:
|
|
3425
|
+
- data
|
|
3426
|
+
type: object
|
|
3427
|
+
CaseAttributes:
|
|
3428
|
+
description: Case attributes
|
|
3429
|
+
properties:
|
|
3430
|
+
archived_at:
|
|
3431
|
+
description: Timestamp of when the case was archived
|
|
3432
|
+
format: date-time
|
|
3433
|
+
nullable: true
|
|
3434
|
+
readOnly: true
|
|
3435
|
+
type: string
|
|
3436
|
+
closed_at:
|
|
3437
|
+
description: Timestamp of when the case was closed
|
|
3438
|
+
format: date-time
|
|
3439
|
+
nullable: true
|
|
3440
|
+
readOnly: true
|
|
3441
|
+
type: string
|
|
3442
|
+
created_at:
|
|
3443
|
+
description: Timestamp of when the case was created
|
|
3444
|
+
format: date-time
|
|
3445
|
+
readOnly: true
|
|
3446
|
+
type: string
|
|
3447
|
+
description:
|
|
3448
|
+
description: Description
|
|
3449
|
+
type: string
|
|
3450
|
+
jira_issue:
|
|
3451
|
+
$ref: '#/components/schemas/JiraIssue'
|
|
3452
|
+
key:
|
|
3453
|
+
description: Key
|
|
3454
|
+
example: CASEM-4523
|
|
3455
|
+
type: string
|
|
3456
|
+
modified_at:
|
|
3457
|
+
description: Timestamp of when the case was last modified
|
|
3458
|
+
format: date-time
|
|
3459
|
+
nullable: true
|
|
3460
|
+
readOnly: true
|
|
3461
|
+
type: string
|
|
3462
|
+
priority:
|
|
3463
|
+
$ref: '#/components/schemas/CasePriority'
|
|
3464
|
+
service_now_ticket:
|
|
3465
|
+
$ref: '#/components/schemas/ServiceNowTicket'
|
|
3466
|
+
status:
|
|
3467
|
+
$ref: '#/components/schemas/CaseStatus'
|
|
3468
|
+
title:
|
|
3469
|
+
description: Title
|
|
3470
|
+
example: Memory leak investigation on API
|
|
3471
|
+
type: string
|
|
3472
|
+
type:
|
|
3473
|
+
$ref: '#/components/schemas/CaseType'
|
|
3474
|
+
type: object
|
|
3475
|
+
CaseCreate:
|
|
3476
|
+
description: Case creation data
|
|
3477
|
+
properties:
|
|
3478
|
+
attributes:
|
|
3479
|
+
$ref: '#/components/schemas/CaseCreateAttributes'
|
|
3480
|
+
relationships:
|
|
3481
|
+
$ref: '#/components/schemas/CaseCreateRelationships'
|
|
3482
|
+
type:
|
|
3483
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3484
|
+
required:
|
|
3485
|
+
- attributes
|
|
3486
|
+
- type
|
|
3487
|
+
type: object
|
|
3488
|
+
CaseCreateAttributes:
|
|
3489
|
+
description: Case creation attributes
|
|
3490
|
+
properties:
|
|
3491
|
+
description:
|
|
3492
|
+
description: Description
|
|
3493
|
+
type: string
|
|
3494
|
+
priority:
|
|
3495
|
+
$ref: '#/components/schemas/CasePriority'
|
|
3496
|
+
title:
|
|
3497
|
+
description: Title
|
|
3498
|
+
example: Security breach investigation
|
|
3499
|
+
type: string
|
|
3500
|
+
type:
|
|
3501
|
+
$ref: '#/components/schemas/CaseType'
|
|
3502
|
+
required:
|
|
3503
|
+
- title
|
|
3504
|
+
- type
|
|
3505
|
+
type: object
|
|
3506
|
+
CaseCreateRelationships:
|
|
3507
|
+
description: Relationships formed with the case on creation
|
|
3508
|
+
properties:
|
|
3509
|
+
assignee:
|
|
3510
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3511
|
+
project:
|
|
3512
|
+
$ref: '#/components/schemas/ProjectRelationship'
|
|
3513
|
+
required:
|
|
3514
|
+
- project
|
|
3515
|
+
type: object
|
|
3516
|
+
CaseCreateRequest:
|
|
3517
|
+
description: Case create request
|
|
3518
|
+
properties:
|
|
3519
|
+
data:
|
|
3520
|
+
$ref: '#/components/schemas/CaseCreate'
|
|
3521
|
+
required:
|
|
3522
|
+
- data
|
|
3523
|
+
type: object
|
|
3524
|
+
CaseEmpty:
|
|
3525
|
+
description: Case empty request data
|
|
3526
|
+
properties:
|
|
3527
|
+
type:
|
|
3528
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3529
|
+
required:
|
|
3530
|
+
- type
|
|
3531
|
+
type: object
|
|
3532
|
+
CaseEmptyRequest:
|
|
3533
|
+
description: Case empty request
|
|
3534
|
+
properties:
|
|
3535
|
+
data:
|
|
3536
|
+
$ref: '#/components/schemas/CaseEmpty'
|
|
3537
|
+
required:
|
|
3538
|
+
- data
|
|
3539
|
+
type: object
|
|
3540
|
+
CasePriority:
|
|
3541
|
+
default: NOT_DEFINED
|
|
3542
|
+
description: Case priority
|
|
3543
|
+
enum:
|
|
3544
|
+
- NOT_DEFINED
|
|
3545
|
+
- P1
|
|
3546
|
+
- P2
|
|
3547
|
+
- P3
|
|
3548
|
+
- P4
|
|
3549
|
+
- P5
|
|
3550
|
+
example: NOT_DEFINED
|
|
3551
|
+
type: string
|
|
3552
|
+
x-enum-varnames:
|
|
3553
|
+
- NOT_DEFINED
|
|
3554
|
+
- P1
|
|
3555
|
+
- P2
|
|
3556
|
+
- P3
|
|
3557
|
+
- P4
|
|
3558
|
+
- P5
|
|
3559
|
+
CaseRelationships:
|
|
3560
|
+
description: Resources related to a case
|
|
3561
|
+
properties:
|
|
3562
|
+
assignee:
|
|
3563
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3564
|
+
created_by:
|
|
3565
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3566
|
+
modified_by:
|
|
3567
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3568
|
+
project:
|
|
3569
|
+
$ref: '#/components/schemas/ProjectRelationship'
|
|
3570
|
+
type: object
|
|
3571
|
+
CaseResourceType:
|
|
3572
|
+
default: case
|
|
3573
|
+
description: Case resource type
|
|
3574
|
+
enum:
|
|
3575
|
+
- case
|
|
3576
|
+
example: case
|
|
3577
|
+
type: string
|
|
3578
|
+
x-enum-varnames:
|
|
3579
|
+
- CASE
|
|
3580
|
+
CaseResponse:
|
|
3581
|
+
description: Case response
|
|
3582
|
+
properties:
|
|
3583
|
+
data:
|
|
3584
|
+
$ref: '#/components/schemas/Case'
|
|
3585
|
+
type: object
|
|
3586
|
+
CaseSortableField:
|
|
3587
|
+
description: Case field that can be sorted on
|
|
3588
|
+
enum:
|
|
3589
|
+
- created_at
|
|
3590
|
+
- priority
|
|
3591
|
+
- status
|
|
3592
|
+
example: created_at
|
|
3593
|
+
type: string
|
|
3594
|
+
x-enum-varnames:
|
|
3595
|
+
- CREATED_AT
|
|
3596
|
+
- PRIORITY
|
|
3597
|
+
- STATUS
|
|
3598
|
+
CaseStatus:
|
|
3599
|
+
description: Case status
|
|
3600
|
+
enum:
|
|
3601
|
+
- OPEN
|
|
3602
|
+
- IN_PROGRESS
|
|
3603
|
+
- CLOSED
|
|
3604
|
+
example: OPEN
|
|
3605
|
+
type: string
|
|
3606
|
+
x-enum-varnames:
|
|
3607
|
+
- OPEN
|
|
3608
|
+
- IN_PROGRESS
|
|
3609
|
+
- CLOSED
|
|
3610
|
+
CaseType:
|
|
3611
|
+
description: Case type
|
|
3612
|
+
enum:
|
|
3613
|
+
- STANDARD
|
|
3614
|
+
example: STANDARD
|
|
3615
|
+
type: string
|
|
3616
|
+
x-enum-varnames:
|
|
3617
|
+
- STANDARD
|
|
3618
|
+
CaseUpdatePriority:
|
|
3619
|
+
description: Case priority status
|
|
3620
|
+
properties:
|
|
3621
|
+
attributes:
|
|
3622
|
+
$ref: '#/components/schemas/CaseUpdatePriorityAttributes'
|
|
3623
|
+
type:
|
|
3624
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3625
|
+
required:
|
|
3626
|
+
- attributes
|
|
3627
|
+
- type
|
|
3628
|
+
type: object
|
|
3629
|
+
CaseUpdatePriorityAttributes:
|
|
3630
|
+
description: Case update priority attributes
|
|
3631
|
+
properties:
|
|
3632
|
+
priority:
|
|
3633
|
+
$ref: '#/components/schemas/CasePriority'
|
|
3634
|
+
required:
|
|
3635
|
+
- priority
|
|
3636
|
+
type: object
|
|
3637
|
+
CaseUpdatePriorityRequest:
|
|
3638
|
+
description: Case update priority request
|
|
3639
|
+
properties:
|
|
3640
|
+
data:
|
|
3641
|
+
$ref: '#/components/schemas/CaseUpdatePriority'
|
|
3642
|
+
required:
|
|
3643
|
+
- data
|
|
3644
|
+
type: object
|
|
3645
|
+
CaseUpdateStatus:
|
|
3646
|
+
description: Case update status
|
|
3647
|
+
properties:
|
|
3648
|
+
attributes:
|
|
3649
|
+
$ref: '#/components/schemas/CaseUpdateStatusAttributes'
|
|
3650
|
+
type:
|
|
3651
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3652
|
+
required:
|
|
3653
|
+
- attributes
|
|
3654
|
+
- type
|
|
3655
|
+
type: object
|
|
3656
|
+
CaseUpdateStatusAttributes:
|
|
3657
|
+
description: Case update status attributes
|
|
3658
|
+
properties:
|
|
3659
|
+
status:
|
|
3660
|
+
$ref: '#/components/schemas/CaseStatus'
|
|
3661
|
+
required:
|
|
3662
|
+
- status
|
|
3663
|
+
type: object
|
|
3664
|
+
CaseUpdateStatusRequest:
|
|
3665
|
+
description: Case update status request
|
|
3666
|
+
properties:
|
|
3667
|
+
data:
|
|
3668
|
+
$ref: '#/components/schemas/CaseUpdateStatus'
|
|
3669
|
+
required:
|
|
3670
|
+
- data
|
|
3671
|
+
type: object
|
|
3672
|
+
CasesResponse:
|
|
3673
|
+
description: Response with cases
|
|
3674
|
+
properties:
|
|
3675
|
+
data:
|
|
3676
|
+
description: Cases response data
|
|
3677
|
+
items:
|
|
3678
|
+
$ref: '#/components/schemas/Case'
|
|
3679
|
+
type: array
|
|
3680
|
+
meta:
|
|
3681
|
+
$ref: '#/components/schemas/CasesResponseMeta'
|
|
3682
|
+
type: object
|
|
3683
|
+
CasesResponseMeta:
|
|
3684
|
+
description: Cases response metadata
|
|
3685
|
+
properties:
|
|
3686
|
+
page:
|
|
3687
|
+
$ref: '#/components/schemas/CasesResponseMetaPagination'
|
|
3688
|
+
type: object
|
|
3689
|
+
CasesResponseMetaPagination:
|
|
3690
|
+
description: Pagination metadata
|
|
3691
|
+
properties:
|
|
3692
|
+
current:
|
|
3693
|
+
description: Current page number
|
|
3694
|
+
format: int64
|
|
3695
|
+
type: integer
|
|
3696
|
+
size:
|
|
3697
|
+
description: Number of cases in current page
|
|
3698
|
+
format: int64
|
|
3699
|
+
type: integer
|
|
3700
|
+
total:
|
|
3701
|
+
description: Total number of pages
|
|
3702
|
+
format: int64
|
|
3703
|
+
type: integer
|
|
3704
|
+
type: object
|
|
3323
3705
|
ChargebackBreakdown:
|
|
3324
3706
|
description: Charges breakdown.
|
|
3325
3707
|
properties:
|
|
@@ -3544,9 +3926,27 @@ components:
|
|
|
3544
3926
|
type: string
|
|
3545
3927
|
x-enum-varnames:
|
|
3546
3928
|
- CLOUD_COST_ACTIVITY
|
|
3929
|
+
CloudWorkloadSecurityAgentRuleAction:
|
|
3930
|
+
description: The action the rule can perform if triggered.
|
|
3931
|
+
properties:
|
|
3932
|
+
filter:
|
|
3933
|
+
description: SECL expression used to target the container to apply the action
|
|
3934
|
+
on
|
|
3935
|
+
type: string
|
|
3936
|
+
kill:
|
|
3937
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
|
|
3938
|
+
type: object
|
|
3939
|
+
CloudWorkloadSecurityAgentRuleActions:
|
|
3940
|
+
description: The array of actions the rule can perform if triggered.
|
|
3941
|
+
items:
|
|
3942
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAction'
|
|
3943
|
+
nullable: true
|
|
3944
|
+
type: array
|
|
3547
3945
|
CloudWorkloadSecurityAgentRuleAttributes:
|
|
3548
3946
|
description: A Cloud Workload Security Agent rule returned by the API.
|
|
3549
3947
|
properties:
|
|
3948
|
+
actions:
|
|
3949
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
|
3550
3950
|
agentConstraint:
|
|
3551
3951
|
description: The version of the agent.
|
|
3552
3952
|
type: string
|
|
@@ -3679,6 +4079,17 @@ components:
|
|
|
3679
4079
|
type:
|
|
3680
4080
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
|
|
3681
4081
|
type: object
|
|
4082
|
+
CloudWorkloadSecurityAgentRuleID:
|
|
4083
|
+
description: The ID of the agent rule.
|
|
4084
|
+
example: 3dd-0uc-h1s
|
|
4085
|
+
type: string
|
|
4086
|
+
CloudWorkloadSecurityAgentRuleKill:
|
|
4087
|
+
description: Kill system call applied on the container matching the rule
|
|
4088
|
+
properties:
|
|
4089
|
+
signal:
|
|
4090
|
+
description: Supported signals for the kill system call.
|
|
4091
|
+
type: string
|
|
4092
|
+
type: object
|
|
3682
4093
|
CloudWorkloadSecurityAgentRuleResponse:
|
|
3683
4094
|
description: Response object that includes an Agent rule.
|
|
3684
4095
|
properties:
|
|
@@ -3715,6 +4126,8 @@ components:
|
|
|
3715
4126
|
properties:
|
|
3716
4127
|
attributes:
|
|
3717
4128
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes'
|
|
4129
|
+
id:
|
|
4130
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleID'
|
|
3718
4131
|
type:
|
|
3719
4132
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
|
|
3720
4133
|
required:
|
|
@@ -4866,6 +5279,29 @@ components:
|
|
|
4866
5279
|
type: string
|
|
4867
5280
|
x-enum-varnames:
|
|
4868
5281
|
- COST_BY_ORG
|
|
5282
|
+
CreateOpenAPIResponse:
|
|
5283
|
+
description: Response for `CreateOpenAPI` operation.
|
|
5284
|
+
properties:
|
|
5285
|
+
data:
|
|
5286
|
+
$ref: '#/components/schemas/CreateOpenAPIResponseData'
|
|
5287
|
+
type: object
|
|
5288
|
+
CreateOpenAPIResponseAttributes:
|
|
5289
|
+
description: Attributes for `CreateOpenAPI`.
|
|
5290
|
+
properties:
|
|
5291
|
+
failed_endpoints:
|
|
5292
|
+
description: List of endpoints which couldn't be parsed.
|
|
5293
|
+
items:
|
|
5294
|
+
$ref: '#/components/schemas/OpenAPIEndpoint'
|
|
5295
|
+
type: array
|
|
5296
|
+
type: object
|
|
5297
|
+
CreateOpenAPIResponseData:
|
|
5298
|
+
description: Data envelope for `CreateOpenAPIResponse`.
|
|
5299
|
+
properties:
|
|
5300
|
+
attributes:
|
|
5301
|
+
$ref: '#/components/schemas/CreateOpenAPIResponseAttributes'
|
|
5302
|
+
id:
|
|
5303
|
+
$ref: '#/components/schemas/ApiID'
|
|
5304
|
+
type: object
|
|
4869
5305
|
CreateRuleRequest:
|
|
4870
5306
|
description: Scorecard create rule request.
|
|
4871
5307
|
properties:
|
|
@@ -4912,6 +5348,621 @@ components:
|
|
|
4912
5348
|
nullable: true
|
|
4913
5349
|
type: string
|
|
4914
5350
|
type: object
|
|
5351
|
+
CustomDestinationAttributeTagsRestrictionListType:
|
|
5352
|
+
default: ALLOW_LIST
|
|
5353
|
+
description: 'How `forward_tags_restriction_list` parameter should be interpreted.
|
|
5354
|
+
|
|
5355
|
+
If `ALLOW_LIST`, then only tags whose keys on the forwarded logs match the
|
|
5356
|
+
ones on the restriction list
|
|
5357
|
+
|
|
5358
|
+
are forwarded.
|
|
5359
|
+
|
|
5360
|
+
|
|
5361
|
+
`BLOCK_LIST` works the opposite way. It does not forward the tags matching
|
|
5362
|
+
the ones on the list.'
|
|
5363
|
+
enum:
|
|
5364
|
+
- ALLOW_LIST
|
|
5365
|
+
- BLOCK_LIST
|
|
5366
|
+
example: ALLOW_LIST
|
|
5367
|
+
type: string
|
|
5368
|
+
x-enum-varnames:
|
|
5369
|
+
- ALLOW_LIST
|
|
5370
|
+
- BLOCK_LIST
|
|
5371
|
+
CustomDestinationCreateRequest:
|
|
5372
|
+
description: The custom destination.
|
|
5373
|
+
properties:
|
|
5374
|
+
data:
|
|
5375
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequestDefinition'
|
|
5376
|
+
type: object
|
|
5377
|
+
CustomDestinationCreateRequestAttributes:
|
|
5378
|
+
description: The attributes associated with the custom destination.
|
|
5379
|
+
properties:
|
|
5380
|
+
enabled:
|
|
5381
|
+
default: true
|
|
5382
|
+
description: Whether logs matching this custom destination should be forwarded
|
|
5383
|
+
or not.
|
|
5384
|
+
example: true
|
|
5385
|
+
type: boolean
|
|
5386
|
+
forward_tags:
|
|
5387
|
+
default: true
|
|
5388
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
|
5389
|
+
not.
|
|
5390
|
+
example: true
|
|
5391
|
+
type: boolean
|
|
5392
|
+
forward_tags_restriction_list:
|
|
5393
|
+
default: []
|
|
5394
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
|
5395
|
+
to be filtered.
|
|
5396
|
+
|
|
5397
|
+
|
|
5398
|
+
An empty list represents no restriction is in place and either all or
|
|
5399
|
+
no tags will be
|
|
5400
|
+
|
|
5401
|
+
forwarded depending on `forward_tags_restriction_list_type` parameter.'
|
|
5402
|
+
example:
|
|
5403
|
+
- datacenter
|
|
5404
|
+
- host
|
|
5405
|
+
items:
|
|
5406
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
|
5407
|
+
type: string
|
|
5408
|
+
maxItems: 10
|
|
5409
|
+
minItems: 0
|
|
5410
|
+
type: array
|
|
5411
|
+
forward_tags_restriction_list_type:
|
|
5412
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
|
5413
|
+
forwarder_destination:
|
|
5414
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestination'
|
|
5415
|
+
name:
|
|
5416
|
+
description: The custom destination name.
|
|
5417
|
+
example: Nginx logs
|
|
5418
|
+
type: string
|
|
5419
|
+
query:
|
|
5420
|
+
default: ''
|
|
5421
|
+
description: The custom destination query and filter. Logs matching this
|
|
5422
|
+
query are forwarded to the destination.
|
|
5423
|
+
example: source:nginx
|
|
5424
|
+
type: string
|
|
5425
|
+
required:
|
|
5426
|
+
- name
|
|
5427
|
+
- forwarder_destination
|
|
5428
|
+
type: object
|
|
5429
|
+
CustomDestinationCreateRequestDefinition:
|
|
5430
|
+
description: The definition of a custom destination.
|
|
5431
|
+
properties:
|
|
5432
|
+
attributes:
|
|
5433
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequestAttributes'
|
|
5434
|
+
type:
|
|
5435
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
|
5436
|
+
required:
|
|
5437
|
+
- type
|
|
5438
|
+
- attributes
|
|
5439
|
+
type: object
|
|
5440
|
+
CustomDestinationElasticsearchDestinationAuth:
|
|
5441
|
+
description: Basic access authentication.
|
|
5442
|
+
properties:
|
|
5443
|
+
password:
|
|
5444
|
+
description: The password of the authentication. This field is not returned
|
|
5445
|
+
by the API.
|
|
5446
|
+
example: datadog-custom-destination-password
|
|
5447
|
+
type: string
|
|
5448
|
+
writeOnly: true
|
|
5449
|
+
username:
|
|
5450
|
+
description: The username of the authentication. This field is not returned
|
|
5451
|
+
by the API.
|
|
5452
|
+
example: datadog-custom-destination-username
|
|
5453
|
+
type: string
|
|
5454
|
+
writeOnly: true
|
|
5455
|
+
required:
|
|
5456
|
+
- username
|
|
5457
|
+
- password
|
|
5458
|
+
type: object
|
|
5459
|
+
CustomDestinationForwardDestination:
|
|
5460
|
+
description: A custom destination's location to forward logs.
|
|
5461
|
+
oneOf:
|
|
5462
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp'
|
|
5463
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk'
|
|
5464
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch'
|
|
5465
|
+
type: object
|
|
5466
|
+
CustomDestinationForwardDestinationElasticsearch:
|
|
5467
|
+
description: The Elasticsearch destination.
|
|
5468
|
+
properties:
|
|
5469
|
+
auth:
|
|
5470
|
+
$ref: '#/components/schemas/CustomDestinationElasticsearchDestinationAuth'
|
|
5471
|
+
endpoint:
|
|
5472
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5473
|
+
|
|
5474
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5475
|
+
example: https://example.com
|
|
5476
|
+
type: string
|
|
5477
|
+
index_name:
|
|
5478
|
+
description: Name of the Elasticsearch index (must follow [Elasticsearch's
|
|
5479
|
+
criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
|
|
5480
|
+
example: nginx-logs
|
|
5481
|
+
type: string
|
|
5482
|
+
index_rotation:
|
|
5483
|
+
description: 'Date pattern with US locale and UTC timezone to be appended
|
|
5484
|
+
to the index name after adding `-`
|
|
5485
|
+
|
|
5486
|
+
(that is, `${index_name}-${indexPattern}`).
|
|
5487
|
+
|
|
5488
|
+
You can customize the index rotation naming pattern by choosing one of
|
|
5489
|
+
these options:
|
|
5490
|
+
|
|
5491
|
+
- Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
|
|
5492
|
+
|
|
5493
|
+
- Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
|
|
5494
|
+
|
|
5495
|
+
- Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`)
|
|
5496
|
+
|
|
5497
|
+
- Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
|
|
5498
|
+
|
|
5499
|
+
|
|
5500
|
+
If this field is missing or is blank, it means that the index name will
|
|
5501
|
+
always be the same
|
|
5502
|
+
|
|
5503
|
+
(that is, no rotation).'
|
|
5504
|
+
example: yyyy-MM-dd
|
|
5505
|
+
type: string
|
|
5506
|
+
type:
|
|
5507
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearchType'
|
|
5508
|
+
required:
|
|
5509
|
+
- type
|
|
5510
|
+
- endpoint
|
|
5511
|
+
- auth
|
|
5512
|
+
- index_name
|
|
5513
|
+
type: object
|
|
5514
|
+
CustomDestinationForwardDestinationElasticsearchType:
|
|
5515
|
+
default: elasticsearch
|
|
5516
|
+
description: Type of the Elasticsearch destination.
|
|
5517
|
+
enum:
|
|
5518
|
+
- elasticsearch
|
|
5519
|
+
example: elasticsearch
|
|
5520
|
+
type: string
|
|
5521
|
+
x-enum-varnames:
|
|
5522
|
+
- ELASTICSEARCH
|
|
5523
|
+
CustomDestinationForwardDestinationHttp:
|
|
5524
|
+
description: The HTTP destination.
|
|
5525
|
+
properties:
|
|
5526
|
+
auth:
|
|
5527
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuth'
|
|
5528
|
+
endpoint:
|
|
5529
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5530
|
+
|
|
5531
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5532
|
+
example: https://example.com
|
|
5533
|
+
type: string
|
|
5534
|
+
type:
|
|
5535
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationHttpType'
|
|
5536
|
+
required:
|
|
5537
|
+
- type
|
|
5538
|
+
- endpoint
|
|
5539
|
+
- auth
|
|
5540
|
+
type: object
|
|
5541
|
+
CustomDestinationForwardDestinationHttpType:
|
|
5542
|
+
default: http
|
|
5543
|
+
description: Type of the HTTP destination.
|
|
5544
|
+
enum:
|
|
5545
|
+
- http
|
|
5546
|
+
example: http
|
|
5547
|
+
type: string
|
|
5548
|
+
x-enum-varnames:
|
|
5549
|
+
- HTTP
|
|
5550
|
+
CustomDestinationForwardDestinationSplunk:
|
|
5551
|
+
description: The Splunk HTTP Event Collector (HEC) destination.
|
|
5552
|
+
properties:
|
|
5553
|
+
access_token:
|
|
5554
|
+
description: Access token of the Splunk HTTP Event Collector. This field
|
|
5555
|
+
is not returned by the API.
|
|
5556
|
+
example: splunk_access_token
|
|
5557
|
+
type: string
|
|
5558
|
+
writeOnly: true
|
|
5559
|
+
endpoint:
|
|
5560
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5561
|
+
|
|
5562
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5563
|
+
example: https://example.com
|
|
5564
|
+
type: string
|
|
5565
|
+
type:
|
|
5566
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationSplunkType'
|
|
5567
|
+
required:
|
|
5568
|
+
- type
|
|
5569
|
+
- endpoint
|
|
5570
|
+
- access_token
|
|
5571
|
+
type: object
|
|
5572
|
+
CustomDestinationForwardDestinationSplunkType:
|
|
5573
|
+
default: splunk_hec
|
|
5574
|
+
description: Type of the Splunk HTTP Event Collector (HEC) destination.
|
|
5575
|
+
enum:
|
|
5576
|
+
- splunk_hec
|
|
5577
|
+
example: splunk_hec
|
|
5578
|
+
type: string
|
|
5579
|
+
x-enum-varnames:
|
|
5580
|
+
- SPLUNK_HEC
|
|
5581
|
+
CustomDestinationHttpDestinationAuth:
|
|
5582
|
+
description: Authentication method of the HTTP requests.
|
|
5583
|
+
oneOf:
|
|
5584
|
+
- $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasic'
|
|
5585
|
+
- $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader'
|
|
5586
|
+
type: object
|
|
5587
|
+
CustomDestinationHttpDestinationAuthBasic:
|
|
5588
|
+
description: Basic access authentication.
|
|
5589
|
+
properties:
|
|
5590
|
+
password:
|
|
5591
|
+
description: The password of the authentication. This field is not returned
|
|
5592
|
+
by the API.
|
|
5593
|
+
example: datadog-custom-destination-password
|
|
5594
|
+
type: string
|
|
5595
|
+
writeOnly: true
|
|
5596
|
+
type:
|
|
5597
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasicType'
|
|
5598
|
+
username:
|
|
5599
|
+
description: The username of the authentication. This field is not returned
|
|
5600
|
+
by the API.
|
|
5601
|
+
example: datadog-custom-destination-username
|
|
5602
|
+
type: string
|
|
5603
|
+
writeOnly: true
|
|
5604
|
+
required:
|
|
5605
|
+
- type
|
|
5606
|
+
- username
|
|
5607
|
+
- password
|
|
5608
|
+
type: object
|
|
5609
|
+
CustomDestinationHttpDestinationAuthBasicType:
|
|
5610
|
+
default: basic
|
|
5611
|
+
description: Type of the basic access authentication.
|
|
5612
|
+
enum:
|
|
5613
|
+
- basic
|
|
5614
|
+
example: basic
|
|
5615
|
+
type: string
|
|
5616
|
+
x-enum-varnames:
|
|
5617
|
+
- BASIC
|
|
5618
|
+
CustomDestinationHttpDestinationAuthCustomHeader:
|
|
5619
|
+
description: Custom header access authentication.
|
|
5620
|
+
properties:
|
|
5621
|
+
header_name:
|
|
5622
|
+
description: The header name of the authentication.
|
|
5623
|
+
example: CUSTOM-HEADER-NAME
|
|
5624
|
+
type: string
|
|
5625
|
+
header_value:
|
|
5626
|
+
description: The header value of the authentication. This field is not returned
|
|
5627
|
+
by the API.
|
|
5628
|
+
example: CUSTOM-HEADER-AUTHENTICATION-VALUE
|
|
5629
|
+
type: string
|
|
5630
|
+
writeOnly: true
|
|
5631
|
+
type:
|
|
5632
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeaderType'
|
|
5633
|
+
required:
|
|
5634
|
+
- type
|
|
5635
|
+
- header_name
|
|
5636
|
+
- header_value
|
|
5637
|
+
type: object
|
|
5638
|
+
CustomDestinationHttpDestinationAuthCustomHeaderType:
|
|
5639
|
+
default: custom_header
|
|
5640
|
+
description: Type of the custom header access authentication.
|
|
5641
|
+
enum:
|
|
5642
|
+
- custom_header
|
|
5643
|
+
example: custom_header
|
|
5644
|
+
type: string
|
|
5645
|
+
x-enum-varnames:
|
|
5646
|
+
- CUSTOM_HEADER
|
|
5647
|
+
CustomDestinationResponse:
|
|
5648
|
+
description: The custom destination.
|
|
5649
|
+
properties:
|
|
5650
|
+
data:
|
|
5651
|
+
$ref: '#/components/schemas/CustomDestinationResponseDefinition'
|
|
5652
|
+
type: object
|
|
5653
|
+
CustomDestinationResponseAttributes:
|
|
5654
|
+
description: The attributes associated with the custom destination.
|
|
5655
|
+
properties:
|
|
5656
|
+
enabled:
|
|
5657
|
+
default: true
|
|
5658
|
+
description: Whether logs matching this custom destination should be forwarded
|
|
5659
|
+
or not.
|
|
5660
|
+
example: true
|
|
5661
|
+
type: boolean
|
|
5662
|
+
forward_tags:
|
|
5663
|
+
default: true
|
|
5664
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
|
5665
|
+
not.
|
|
5666
|
+
example: true
|
|
5667
|
+
type: boolean
|
|
5668
|
+
forward_tags_restriction_list:
|
|
5669
|
+
default: []
|
|
5670
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
|
5671
|
+
to be filtered.
|
|
5672
|
+
|
|
5673
|
+
|
|
5674
|
+
An empty list represents no restriction is in place and either all or
|
|
5675
|
+
no tags will be
|
|
5676
|
+
|
|
5677
|
+
forwarded depending on `forward_tags_restriction_list_type` parameter.'
|
|
5678
|
+
example:
|
|
5679
|
+
- datacenter
|
|
5680
|
+
- host
|
|
5681
|
+
items:
|
|
5682
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
|
5683
|
+
type: string
|
|
5684
|
+
maxItems: 10
|
|
5685
|
+
minItems: 0
|
|
5686
|
+
type: array
|
|
5687
|
+
forward_tags_restriction_list_type:
|
|
5688
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
|
5689
|
+
forwarder_destination:
|
|
5690
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestination'
|
|
5691
|
+
name:
|
|
5692
|
+
description: The custom destination name.
|
|
5693
|
+
example: Nginx logs
|
|
5694
|
+
type: string
|
|
5695
|
+
query:
|
|
5696
|
+
default: ''
|
|
5697
|
+
description: The custom destination query filter. Logs matching this query
|
|
5698
|
+
are forwarded to the destination.
|
|
5699
|
+
example: source:nginx
|
|
5700
|
+
type: string
|
|
5701
|
+
type: object
|
|
5702
|
+
CustomDestinationResponseDefinition:
|
|
5703
|
+
description: The definition of a custom destination.
|
|
5704
|
+
properties:
|
|
5705
|
+
attributes:
|
|
5706
|
+
$ref: '#/components/schemas/CustomDestinationResponseAttributes'
|
|
5707
|
+
id:
|
|
5708
|
+
description: The custom destination ID.
|
|
5709
|
+
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
|
|
5710
|
+
readOnly: true
|
|
5711
|
+
type: string
|
|
5712
|
+
type:
|
|
5713
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
|
5714
|
+
type: object
|
|
5715
|
+
CustomDestinationResponseElasticsearchDestinationAuth:
|
|
5716
|
+
additionalProperties:
|
|
5717
|
+
description: Basic access authentication.
|
|
5718
|
+
description: Basic access authentication.
|
|
5719
|
+
type: object
|
|
5720
|
+
CustomDestinationResponseForwardDestination:
|
|
5721
|
+
description: A custom destination's location to forward logs.
|
|
5722
|
+
oneOf:
|
|
5723
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp'
|
|
5724
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk'
|
|
5725
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch'
|
|
5726
|
+
type: object
|
|
5727
|
+
CustomDestinationResponseForwardDestinationElasticsearch:
|
|
5728
|
+
description: The Elasticsearch destination.
|
|
5729
|
+
properties:
|
|
5730
|
+
auth:
|
|
5731
|
+
$ref: '#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth'
|
|
5732
|
+
endpoint:
|
|
5733
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5734
|
+
|
|
5735
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5736
|
+
example: https://example.com
|
|
5737
|
+
type: string
|
|
5738
|
+
index_name:
|
|
5739
|
+
description: Name of the Elasticsearch index (must follow [Elasticsearch's
|
|
5740
|
+
criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
|
|
5741
|
+
example: nginx-logs
|
|
5742
|
+
type: string
|
|
5743
|
+
index_rotation:
|
|
5744
|
+
description: 'Date pattern with US locale and UTC timezone to be appended
|
|
5745
|
+
to the index name after adding `-`
|
|
5746
|
+
|
|
5747
|
+
(that is, `${index_name}-${indexPattern}`).
|
|
5748
|
+
|
|
5749
|
+
You can customize the index rotation naming pattern by choosing one of
|
|
5750
|
+
these options:
|
|
5751
|
+
|
|
5752
|
+
- Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
|
|
5753
|
+
|
|
5754
|
+
- Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
|
|
5755
|
+
|
|
5756
|
+
- Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`)
|
|
5757
|
+
|
|
5758
|
+
- Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
|
|
5759
|
+
|
|
5760
|
+
|
|
5761
|
+
If this field is missing or is blank, it means that the index name will
|
|
5762
|
+
always be the same
|
|
5763
|
+
|
|
5764
|
+
(that is, no rotation).'
|
|
5765
|
+
example: yyyy-MM-dd
|
|
5766
|
+
type: string
|
|
5767
|
+
type:
|
|
5768
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType'
|
|
5769
|
+
required:
|
|
5770
|
+
- type
|
|
5771
|
+
- endpoint
|
|
5772
|
+
- auth
|
|
5773
|
+
- index_name
|
|
5774
|
+
type: object
|
|
5775
|
+
CustomDestinationResponseForwardDestinationElasticsearchType:
|
|
5776
|
+
default: elasticsearch
|
|
5777
|
+
description: Type of the Elasticsearch destination.
|
|
5778
|
+
enum:
|
|
5779
|
+
- elasticsearch
|
|
5780
|
+
example: elasticsearch
|
|
5781
|
+
type: string
|
|
5782
|
+
x-enum-varnames:
|
|
5783
|
+
- ELASTICSEARCH
|
|
5784
|
+
CustomDestinationResponseForwardDestinationHttp:
|
|
5785
|
+
description: The HTTP destination.
|
|
5786
|
+
properties:
|
|
5787
|
+
auth:
|
|
5788
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuth'
|
|
5789
|
+
endpoint:
|
|
5790
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5791
|
+
|
|
5792
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5793
|
+
example: https://example.com
|
|
5794
|
+
type: string
|
|
5795
|
+
type:
|
|
5796
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttpType'
|
|
5797
|
+
required:
|
|
5798
|
+
- type
|
|
5799
|
+
- endpoint
|
|
5800
|
+
- auth
|
|
5801
|
+
type: object
|
|
5802
|
+
CustomDestinationResponseForwardDestinationHttpType:
|
|
5803
|
+
default: http
|
|
5804
|
+
description: Type of the HTTP destination.
|
|
5805
|
+
enum:
|
|
5806
|
+
- http
|
|
5807
|
+
example: http
|
|
5808
|
+
type: string
|
|
5809
|
+
x-enum-varnames:
|
|
5810
|
+
- HTTP
|
|
5811
|
+
CustomDestinationResponseForwardDestinationSplunk:
|
|
5812
|
+
description: The Splunk HTTP Event Collector (HEC) destination.
|
|
5813
|
+
properties:
|
|
5814
|
+
endpoint:
|
|
5815
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5816
|
+
|
|
5817
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5818
|
+
example: https://example.com
|
|
5819
|
+
type: string
|
|
5820
|
+
type:
|
|
5821
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType'
|
|
5822
|
+
required:
|
|
5823
|
+
- type
|
|
5824
|
+
- endpoint
|
|
5825
|
+
type: object
|
|
5826
|
+
CustomDestinationResponseForwardDestinationSplunkType:
|
|
5827
|
+
default: splunk_hec
|
|
5828
|
+
description: Type of the Splunk HTTP Event Collector (HEC) destination.
|
|
5829
|
+
enum:
|
|
5830
|
+
- splunk_hec
|
|
5831
|
+
example: splunk_hec
|
|
5832
|
+
type: string
|
|
5833
|
+
x-enum-varnames:
|
|
5834
|
+
- SPLUNK_HEC
|
|
5835
|
+
CustomDestinationResponseHttpDestinationAuth:
|
|
5836
|
+
description: Authentication method of the HTTP requests.
|
|
5837
|
+
oneOf:
|
|
5838
|
+
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic'
|
|
5839
|
+
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader'
|
|
5840
|
+
type: object
|
|
5841
|
+
CustomDestinationResponseHttpDestinationAuthBasic:
|
|
5842
|
+
description: Basic access authentication.
|
|
5843
|
+
properties:
|
|
5844
|
+
type:
|
|
5845
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType'
|
|
5846
|
+
required:
|
|
5847
|
+
- type
|
|
5848
|
+
type: object
|
|
5849
|
+
CustomDestinationResponseHttpDestinationAuthBasicType:
|
|
5850
|
+
default: basic
|
|
5851
|
+
description: Type of the basic access authentication.
|
|
5852
|
+
enum:
|
|
5853
|
+
- basic
|
|
5854
|
+
example: basic
|
|
5855
|
+
type: string
|
|
5856
|
+
x-enum-varnames:
|
|
5857
|
+
- BASIC
|
|
5858
|
+
CustomDestinationResponseHttpDestinationAuthCustomHeader:
|
|
5859
|
+
description: Custom header access authentication.
|
|
5860
|
+
properties:
|
|
5861
|
+
header_name:
|
|
5862
|
+
description: The header name of the authentication.
|
|
5863
|
+
example: CUSTOM-HEADER-NAME
|
|
5864
|
+
type: string
|
|
5865
|
+
type:
|
|
5866
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType'
|
|
5867
|
+
required:
|
|
5868
|
+
- type
|
|
5869
|
+
- header_name
|
|
5870
|
+
type: object
|
|
5871
|
+
CustomDestinationResponseHttpDestinationAuthCustomHeaderType:
|
|
5872
|
+
default: custom_header
|
|
5873
|
+
description: Type of the custom header access authentication.
|
|
5874
|
+
enum:
|
|
5875
|
+
- custom_header
|
|
5876
|
+
example: custom_header
|
|
5877
|
+
type: string
|
|
5878
|
+
x-enum-varnames:
|
|
5879
|
+
- CUSTOM_HEADER
|
|
5880
|
+
CustomDestinationType:
|
|
5881
|
+
default: custom_destination
|
|
5882
|
+
description: The type of the resource. The value should always be `custom_destination`.
|
|
5883
|
+
enum:
|
|
5884
|
+
- custom_destination
|
|
5885
|
+
example: custom_destination
|
|
5886
|
+
type: string
|
|
5887
|
+
x-enum-varnames:
|
|
5888
|
+
- custom_destination
|
|
5889
|
+
CustomDestinationUpdateRequest:
|
|
5890
|
+
description: The custom destination.
|
|
5891
|
+
properties:
|
|
5892
|
+
data:
|
|
5893
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequestDefinition'
|
|
5894
|
+
type: object
|
|
5895
|
+
CustomDestinationUpdateRequestAttributes:
|
|
5896
|
+
description: The attributes associated with the custom destination.
|
|
5897
|
+
properties:
|
|
5898
|
+
enabled:
|
|
5899
|
+
default: true
|
|
5900
|
+
description: Whether logs matching this custom destination should be forwarded
|
|
5901
|
+
or not.
|
|
5902
|
+
example: true
|
|
5903
|
+
type: boolean
|
|
5904
|
+
forward_tags:
|
|
5905
|
+
default: true
|
|
5906
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
|
5907
|
+
not.
|
|
5908
|
+
example: true
|
|
5909
|
+
type: boolean
|
|
5910
|
+
forward_tags_restriction_list:
|
|
5911
|
+
default: []
|
|
5912
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
|
5913
|
+
to be restricted from being forwarded.
|
|
5914
|
+
|
|
5915
|
+
An empty list represents no restriction is in place and either all or
|
|
5916
|
+
no tags will be forwarded depending on `forward_tags_restriction_list_type`
|
|
5917
|
+
parameter.'
|
|
5918
|
+
example:
|
|
5919
|
+
- datacenter
|
|
5920
|
+
- host
|
|
5921
|
+
items:
|
|
5922
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
|
5923
|
+
type: string
|
|
5924
|
+
maxItems: 10
|
|
5925
|
+
minItems: 0
|
|
5926
|
+
type: array
|
|
5927
|
+
forward_tags_restriction_list_type:
|
|
5928
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
|
5929
|
+
forwarder_destination:
|
|
5930
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestination'
|
|
5931
|
+
name:
|
|
5932
|
+
description: The custom destination name.
|
|
5933
|
+
example: Nginx logs
|
|
5934
|
+
type: string
|
|
5935
|
+
query:
|
|
5936
|
+
default: ''
|
|
5937
|
+
description: The custom destination query and filter. Logs matching this
|
|
5938
|
+
query are forwarded to the destination.
|
|
5939
|
+
example: source:nginx
|
|
5940
|
+
type: string
|
|
5941
|
+
type: object
|
|
5942
|
+
CustomDestinationUpdateRequestDefinition:
|
|
5943
|
+
description: The definition of a custom destination.
|
|
5944
|
+
properties:
|
|
5945
|
+
attributes:
|
|
5946
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequestAttributes'
|
|
5947
|
+
id:
|
|
5948
|
+
description: The custom destination ID.
|
|
5949
|
+
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
|
|
5950
|
+
type: string
|
|
5951
|
+
type:
|
|
5952
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
|
5953
|
+
required:
|
|
5954
|
+
- type
|
|
5955
|
+
- id
|
|
5956
|
+
type: object
|
|
5957
|
+
CustomDestinationsResponse:
|
|
5958
|
+
description: The available custom destinations.
|
|
5959
|
+
properties:
|
|
5960
|
+
data:
|
|
5961
|
+
description: A list of custom destinations.
|
|
5962
|
+
items:
|
|
5963
|
+
$ref: '#/components/schemas/CustomDestinationResponseDefinition'
|
|
5964
|
+
type: array
|
|
5965
|
+
type: object
|
|
4915
5966
|
DORADeploymentRequest:
|
|
4916
5967
|
description: Request to create a DORA deployment event.
|
|
4917
5968
|
properties:
|
|
@@ -4923,6 +5974,10 @@ components:
|
|
|
4923
5974
|
DORADeploymentRequestAttributes:
|
|
4924
5975
|
description: Attributes to create a DORA deployment event.
|
|
4925
5976
|
properties:
|
|
5977
|
+
env:
|
|
5978
|
+
description: Environment name to where the service was deployed.
|
|
5979
|
+
example: staging
|
|
5980
|
+
type: string
|
|
4926
5981
|
finished_at:
|
|
4927
5982
|
description: Unix timestamp in nanoseconds when the deployment finished.
|
|
4928
5983
|
It should not be older than 3 hours.
|
|
@@ -5011,6 +6066,10 @@ components:
|
|
|
5011
6066
|
DORAIncidentRequestAttributes:
|
|
5012
6067
|
description: Attributes to create a DORA incident event.
|
|
5013
6068
|
properties:
|
|
6069
|
+
env:
|
|
6070
|
+
description: Environment name that was impacted by the incident.
|
|
6071
|
+
example: staging
|
|
6072
|
+
type: string
|
|
5014
6073
|
finished_at:
|
|
5015
6074
|
description: Unix timestamp in nanoseconds when the incident finished. It
|
|
5016
6075
|
should not be older than 3 hours.
|
|
@@ -5020,16 +6079,21 @@ components:
|
|
|
5020
6079
|
git:
|
|
5021
6080
|
$ref: '#/components/schemas/DORAGitInfo'
|
|
5022
6081
|
id:
|
|
5023
|
-
description: Incident ID
|
|
6082
|
+
description: Incident ID. Required to update a previously sent incident.
|
|
5024
6083
|
type: string
|
|
5025
6084
|
name:
|
|
5026
6085
|
description: Incident name.
|
|
5027
|
-
example: Webserver is down failing all requests
|
|
5028
|
-
type: string
|
|
5029
|
-
service:
|
|
5030
|
-
description: Service name from a service available in the Service Catalog.
|
|
5031
|
-
example: shopist
|
|
6086
|
+
example: Webserver is down failing all requests.
|
|
5032
6087
|
type: string
|
|
6088
|
+
services:
|
|
6089
|
+
description: Service names impacted by the incident. If possible, use names
|
|
6090
|
+
registered in the Service Catalog. Required when the team field is not
|
|
6091
|
+
provided.
|
|
6092
|
+
example:
|
|
6093
|
+
- shopist
|
|
6094
|
+
items:
|
|
6095
|
+
type: string
|
|
6096
|
+
type: array
|
|
5033
6097
|
severity:
|
|
5034
6098
|
description: Incident severity.
|
|
5035
6099
|
example: High
|
|
@@ -5039,12 +6103,17 @@ components:
|
|
|
5039
6103
|
example: 1693491974000000000
|
|
5040
6104
|
format: int64
|
|
5041
6105
|
type: integer
|
|
6106
|
+
team:
|
|
6107
|
+
description: Name of the team owning the services impacted. If possible,
|
|
6108
|
+
use team handles registered in Datadog. Required when the services field
|
|
6109
|
+
is not provided.
|
|
6110
|
+
example: backend
|
|
6111
|
+
type: string
|
|
5042
6112
|
version:
|
|
5043
6113
|
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
|
5044
6114
|
example: v1.12.07
|
|
5045
6115
|
type: string
|
|
5046
6116
|
required:
|
|
5047
|
-
- service
|
|
5048
6117
|
- started_at
|
|
5049
6118
|
type: object
|
|
5050
6119
|
DORAIncidentRequestData:
|
|
@@ -5698,7 +6767,7 @@ components:
|
|
|
5698
6767
|
type: string
|
|
5699
6768
|
type: object
|
|
5700
6769
|
DowntimeScheduleOneTimeCreateUpdateRequest:
|
|
5701
|
-
additionalProperties:
|
|
6770
|
+
additionalProperties: false
|
|
5702
6771
|
description: A one-time downtime definition.
|
|
5703
6772
|
properties:
|
|
5704
6773
|
end:
|
|
@@ -5833,6 +6902,7 @@ components:
|
|
|
5833
6902
|
- recurrences
|
|
5834
6903
|
type: object
|
|
5835
6904
|
DowntimeScheduleRecurrencesUpdateRequest:
|
|
6905
|
+
additionalProperties: false
|
|
5836
6906
|
description: A recurring downtime schedule definition.
|
|
5837
6907
|
properties:
|
|
5838
6908
|
recurrences:
|
|
@@ -6973,6 +8043,18 @@ components:
|
|
|
6973
8043
|
description: Your service account email address.
|
|
6974
8044
|
example: datadog-service-account@test-project.iam.gserviceaccount.com
|
|
6975
8045
|
type: string
|
|
8046
|
+
cloud_run_revision_filters:
|
|
8047
|
+
description: 'List of filters to limit the Cloud Run revisions that are
|
|
8048
|
+
pulled into Datadog by using tags.
|
|
8049
|
+
|
|
8050
|
+
Only Cloud Run revision resources that apply to specified filters are
|
|
8051
|
+
imported into Datadog.'
|
|
8052
|
+
example:
|
|
8053
|
+
- $KEY:$VALUE
|
|
8054
|
+
items:
|
|
8055
|
+
description: Cloud Run Filters
|
|
8056
|
+
type: string
|
|
8057
|
+
type: array
|
|
6976
8058
|
host_filters:
|
|
6977
8059
|
description: Your Host Filters.
|
|
6978
8060
|
items:
|
|
@@ -9301,6 +10383,32 @@ components:
|
|
|
9301
10383
|
- project_key
|
|
9302
10384
|
- account
|
|
9303
10385
|
type: object
|
|
10386
|
+
JiraIssue:
|
|
10387
|
+
description: Jira issue attached to case
|
|
10388
|
+
nullable: true
|
|
10389
|
+
properties:
|
|
10390
|
+
result:
|
|
10391
|
+
$ref: '#/components/schemas/JiraIssueResult'
|
|
10392
|
+
status:
|
|
10393
|
+
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
|
|
10394
|
+
readOnly: true
|
|
10395
|
+
type: object
|
|
10396
|
+
JiraIssueResult:
|
|
10397
|
+
description: Jira issue information
|
|
10398
|
+
properties:
|
|
10399
|
+
issue_id:
|
|
10400
|
+
description: Jira issue ID
|
|
10401
|
+
type: string
|
|
10402
|
+
issue_key:
|
|
10403
|
+
description: Jira issue key
|
|
10404
|
+
type: string
|
|
10405
|
+
issue_url:
|
|
10406
|
+
description: Jira issue URL
|
|
10407
|
+
type: string
|
|
10408
|
+
project_key:
|
|
10409
|
+
description: Jira project key
|
|
10410
|
+
type: string
|
|
10411
|
+
type: object
|
|
9304
10412
|
ListApplicationKeysResponse:
|
|
9305
10413
|
description: Response for a list of application keys.
|
|
9306
10414
|
properties:
|
|
@@ -9956,7 +11064,6 @@ components:
|
|
|
9956
11064
|
example: project-id
|
|
9957
11065
|
type: string
|
|
9958
11066
|
required:
|
|
9959
|
-
- project_id
|
|
9960
11067
|
- client_email
|
|
9961
11068
|
type: object
|
|
9962
11069
|
LogsArchiveIntegrationS3:
|
|
@@ -10629,6 +11736,136 @@ components:
|
|
|
10629
11736
|
$ref: '#/components/schemas/MetricAllTags'
|
|
10630
11737
|
readOnly: true
|
|
10631
11738
|
type: object
|
|
11739
|
+
MetricAssetAttributes:
|
|
11740
|
+
description: Assets where only included attribute is its title
|
|
11741
|
+
properties:
|
|
11742
|
+
title:
|
|
11743
|
+
description: Title of the asset.
|
|
11744
|
+
type: string
|
|
11745
|
+
type: object
|
|
11746
|
+
MetricAssetDashboardRelationship:
|
|
11747
|
+
description: An object of type `dashboard` that can be referenced in the `included`
|
|
11748
|
+
data.
|
|
11749
|
+
properties:
|
|
11750
|
+
id:
|
|
11751
|
+
$ref: '#/components/schemas/MetricDashboardID'
|
|
11752
|
+
type:
|
|
11753
|
+
$ref: '#/components/schemas/MetricDashboardType'
|
|
11754
|
+
type: object
|
|
11755
|
+
MetricAssetDashboardRelationships:
|
|
11756
|
+
description: An object containing the list of dashboards that can be referenced
|
|
11757
|
+
in the `included` data.
|
|
11758
|
+
properties:
|
|
11759
|
+
data:
|
|
11760
|
+
description: A list of dashboards that can be referenced in the `included`
|
|
11761
|
+
data.
|
|
11762
|
+
items:
|
|
11763
|
+
$ref: '#/components/schemas/MetricAssetDashboardRelationship'
|
|
11764
|
+
type: array
|
|
11765
|
+
type: object
|
|
11766
|
+
MetricAssetMonitorRelationship:
|
|
11767
|
+
description: An object of type `monitor` that can be referenced in the `included`
|
|
11768
|
+
data.
|
|
11769
|
+
properties:
|
|
11770
|
+
id:
|
|
11771
|
+
$ref: '#/components/schemas/MetricMonitorID'
|
|
11772
|
+
type:
|
|
11773
|
+
$ref: '#/components/schemas/MetricMonitorType'
|
|
11774
|
+
type: object
|
|
11775
|
+
MetricAssetMonitorRelationships:
|
|
11776
|
+
description: A object containing the list of monitors that can be referenced
|
|
11777
|
+
in the `included` data.
|
|
11778
|
+
properties:
|
|
11779
|
+
data:
|
|
11780
|
+
description: A list of monitors that can be referenced in the `included`
|
|
11781
|
+
data.
|
|
11782
|
+
items:
|
|
11783
|
+
$ref: '#/components/schemas/MetricAssetMonitorRelationship'
|
|
11784
|
+
type: array
|
|
11785
|
+
type: object
|
|
11786
|
+
MetricAssetNotebookRelationship:
|
|
11787
|
+
description: An object of type `notebook` that can be referenced in the `included`
|
|
11788
|
+
data.
|
|
11789
|
+
properties:
|
|
11790
|
+
id:
|
|
11791
|
+
$ref: '#/components/schemas/MetricNotebookID'
|
|
11792
|
+
type:
|
|
11793
|
+
$ref: '#/components/schemas/MetricNotebookType'
|
|
11794
|
+
type: object
|
|
11795
|
+
MetricAssetNotebookRelationships:
|
|
11796
|
+
description: An object containing the list of notebooks that can be referenced
|
|
11797
|
+
in the `included` data.
|
|
11798
|
+
properties:
|
|
11799
|
+
data:
|
|
11800
|
+
description: A list of notebooks that can be referenced in the `included`
|
|
11801
|
+
data.
|
|
11802
|
+
items:
|
|
11803
|
+
$ref: '#/components/schemas/MetricAssetNotebookRelationship'
|
|
11804
|
+
type: array
|
|
11805
|
+
type: object
|
|
11806
|
+
MetricAssetResponseData:
|
|
11807
|
+
description: Metric assets response data.
|
|
11808
|
+
properties:
|
|
11809
|
+
id:
|
|
11810
|
+
$ref: '#/components/schemas/MetricName'
|
|
11811
|
+
relationships:
|
|
11812
|
+
$ref: '#/components/schemas/MetricAssetResponseRelationships'
|
|
11813
|
+
type:
|
|
11814
|
+
$ref: '#/components/schemas/MetricType'
|
|
11815
|
+
required:
|
|
11816
|
+
- id
|
|
11817
|
+
- type
|
|
11818
|
+
type: object
|
|
11819
|
+
MetricAssetResponseIncluded:
|
|
11820
|
+
description: List of included assets with full set of attributes.
|
|
11821
|
+
oneOf:
|
|
11822
|
+
- $ref: '#/components/schemas/MetricDashboardAsset'
|
|
11823
|
+
- $ref: '#/components/schemas/MetricMonitorAsset'
|
|
11824
|
+
- $ref: '#/components/schemas/MetricNotebookAsset'
|
|
11825
|
+
- $ref: '#/components/schemas/MetricSLOAsset'
|
|
11826
|
+
MetricAssetResponseRelationships:
|
|
11827
|
+
description: Relationships to assets related to the metric.
|
|
11828
|
+
properties:
|
|
11829
|
+
dashboards:
|
|
11830
|
+
$ref: '#/components/schemas/MetricAssetDashboardRelationships'
|
|
11831
|
+
monitors:
|
|
11832
|
+
$ref: '#/components/schemas/MetricAssetMonitorRelationships'
|
|
11833
|
+
notebooks:
|
|
11834
|
+
$ref: '#/components/schemas/MetricAssetNotebookRelationships'
|
|
11835
|
+
slos:
|
|
11836
|
+
$ref: '#/components/schemas/MetricAssetSLORelationships'
|
|
11837
|
+
type: object
|
|
11838
|
+
MetricAssetSLORelationship:
|
|
11839
|
+
description: An object of type `slos` that can be referenced in the `included`
|
|
11840
|
+
data.
|
|
11841
|
+
properties:
|
|
11842
|
+
id:
|
|
11843
|
+
$ref: '#/components/schemas/MetricSLOID'
|
|
11844
|
+
type:
|
|
11845
|
+
$ref: '#/components/schemas/MetricSLOType'
|
|
11846
|
+
type: object
|
|
11847
|
+
MetricAssetSLORelationships:
|
|
11848
|
+
description: An object containing a list of SLOs that can be referenced in the
|
|
11849
|
+
`included` data.
|
|
11850
|
+
properties:
|
|
11851
|
+
data:
|
|
11852
|
+
description: A list of SLOs that can be referenced in the `included` data.
|
|
11853
|
+
items:
|
|
11854
|
+
$ref: '#/components/schemas/MetricAssetSLORelationship'
|
|
11855
|
+
type: array
|
|
11856
|
+
type: object
|
|
11857
|
+
MetricAssetsResponse:
|
|
11858
|
+
description: Response object that includes related dashboards, monitors, notebooks,
|
|
11859
|
+
and SLOs.
|
|
11860
|
+
properties:
|
|
11861
|
+
data:
|
|
11862
|
+
$ref: '#/components/schemas/MetricAssetResponseData'
|
|
11863
|
+
included:
|
|
11864
|
+
description: Array of objects related to the metric assets.
|
|
11865
|
+
items:
|
|
11866
|
+
$ref: '#/components/schemas/MetricAssetResponseIncluded'
|
|
11867
|
+
type: array
|
|
11868
|
+
type: object
|
|
10632
11869
|
MetricBulkConfigureTagsType:
|
|
10633
11870
|
default: metric_bulk_configure_tags
|
|
10634
11871
|
description: The metric bulk configure tags resource.
|
|
@@ -10870,6 +12107,44 @@ components:
|
|
|
10870
12107
|
- MAX
|
|
10871
12108
|
- MIN
|
|
10872
12109
|
- SUM
|
|
12110
|
+
MetricDashboardAsset:
|
|
12111
|
+
description: A dashboard object with title and popularity.
|
|
12112
|
+
properties:
|
|
12113
|
+
attributes:
|
|
12114
|
+
$ref: '#/components/schemas/MetricDashboardAttributes'
|
|
12115
|
+
id:
|
|
12116
|
+
$ref: '#/components/schemas/MetricDashboardID'
|
|
12117
|
+
type:
|
|
12118
|
+
$ref: '#/components/schemas/MetricDashboardType'
|
|
12119
|
+
required:
|
|
12120
|
+
- id
|
|
12121
|
+
- type
|
|
12122
|
+
type: object
|
|
12123
|
+
MetricDashboardAttributes:
|
|
12124
|
+
description: Attributes related to the dashboard, including title and popularity.
|
|
12125
|
+
properties:
|
|
12126
|
+
popularity:
|
|
12127
|
+
description: Value from 0 to 5 that ranks popularity of the dashboard.
|
|
12128
|
+
format: double
|
|
12129
|
+
maximum: 5
|
|
12130
|
+
minimum: 0
|
|
12131
|
+
type: number
|
|
12132
|
+
title:
|
|
12133
|
+
description: Title of the asset.
|
|
12134
|
+
type: string
|
|
12135
|
+
type: object
|
|
12136
|
+
MetricDashboardID:
|
|
12137
|
+
description: The related dashboard's ID.
|
|
12138
|
+
example: xxx-yyy-zzz
|
|
12139
|
+
type: string
|
|
12140
|
+
MetricDashboardType:
|
|
12141
|
+
description: Dashboard resource type.
|
|
12142
|
+
enum:
|
|
12143
|
+
- dashboards
|
|
12144
|
+
example: dashboards
|
|
12145
|
+
type: string
|
|
12146
|
+
x-enum-varnames:
|
|
12147
|
+
- DASHBOARDS
|
|
10873
12148
|
MetricDistinctVolume:
|
|
10874
12149
|
description: Object for a single metric's distinct volume.
|
|
10875
12150
|
properties:
|
|
@@ -11010,10 +12285,60 @@ components:
|
|
|
11010
12285
|
origin:
|
|
11011
12286
|
$ref: '#/components/schemas/MetricOrigin'
|
|
11012
12287
|
type: object
|
|
12288
|
+
MetricMonitorAsset:
|
|
12289
|
+
description: A monitor object with title.
|
|
12290
|
+
properties:
|
|
12291
|
+
attributes:
|
|
12292
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
|
12293
|
+
id:
|
|
12294
|
+
$ref: '#/components/schemas/MetricMonitorID'
|
|
12295
|
+
type:
|
|
12296
|
+
$ref: '#/components/schemas/MetricMonitorType'
|
|
12297
|
+
required:
|
|
12298
|
+
- id
|
|
12299
|
+
- type
|
|
12300
|
+
type: object
|
|
12301
|
+
MetricMonitorID:
|
|
12302
|
+
description: The related monitor's ID.
|
|
12303
|
+
example: '1775073'
|
|
12304
|
+
type: string
|
|
12305
|
+
MetricMonitorType:
|
|
12306
|
+
description: Monitor resource type.
|
|
12307
|
+
enum:
|
|
12308
|
+
- monitors
|
|
12309
|
+
example: monitors
|
|
12310
|
+
type: string
|
|
12311
|
+
x-enum-varnames:
|
|
12312
|
+
- MONITORS
|
|
11013
12313
|
MetricName:
|
|
11014
12314
|
description: The metric name for this resource.
|
|
11015
12315
|
example: test.metric.latency
|
|
11016
12316
|
type: string
|
|
12317
|
+
MetricNotebookAsset:
|
|
12318
|
+
description: A notebook object with title.
|
|
12319
|
+
properties:
|
|
12320
|
+
attributes:
|
|
12321
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
|
12322
|
+
id:
|
|
12323
|
+
$ref: '#/components/schemas/MetricNotebookID'
|
|
12324
|
+
type:
|
|
12325
|
+
$ref: '#/components/schemas/MetricNotebookType'
|
|
12326
|
+
required:
|
|
12327
|
+
- id
|
|
12328
|
+
- type
|
|
12329
|
+
type: object
|
|
12330
|
+
MetricNotebookID:
|
|
12331
|
+
description: The related notebook's ID.
|
|
12332
|
+
example: '12345'
|
|
12333
|
+
type: string
|
|
12334
|
+
MetricNotebookType:
|
|
12335
|
+
description: Notebook resource type.
|
|
12336
|
+
enum:
|
|
12337
|
+
- notebooks
|
|
12338
|
+
example: notebooks
|
|
12339
|
+
type: string
|
|
12340
|
+
x-enum-varnames:
|
|
12341
|
+
- NOTEBOOKS
|
|
11017
12342
|
MetricOrigin:
|
|
11018
12343
|
description: Metric origin information.
|
|
11019
12344
|
properties:
|
|
@@ -11040,7 +12365,7 @@ components:
|
|
|
11040
12365
|
description: The metrics' payload.
|
|
11041
12366
|
properties:
|
|
11042
12367
|
series:
|
|
11043
|
-
description: A list of
|
|
12368
|
+
description: A list of timeseries to submit to Datadog.
|
|
11044
12369
|
example:
|
|
11045
12370
|
- metric: system.load.1
|
|
11046
12371
|
points:
|
|
@@ -11087,6 +12412,31 @@ components:
|
|
|
11087
12412
|
description: The type of the resource.
|
|
11088
12413
|
type: string
|
|
11089
12414
|
type: object
|
|
12415
|
+
MetricSLOAsset:
|
|
12416
|
+
description: A SLO object with title.
|
|
12417
|
+
properties:
|
|
12418
|
+
attributes:
|
|
12419
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
|
12420
|
+
id:
|
|
12421
|
+
$ref: '#/components/schemas/MetricSLOID'
|
|
12422
|
+
type:
|
|
12423
|
+
$ref: '#/components/schemas/MetricSLOType'
|
|
12424
|
+
required:
|
|
12425
|
+
- id
|
|
12426
|
+
- type
|
|
12427
|
+
type: object
|
|
12428
|
+
MetricSLOID:
|
|
12429
|
+
description: The SLO ID.
|
|
12430
|
+
example: 9ffef113b389520db54391d67d652dfb
|
|
12431
|
+
type: string
|
|
12432
|
+
MetricSLOType:
|
|
12433
|
+
description: SLO resource type.
|
|
12434
|
+
enum:
|
|
12435
|
+
- slos
|
|
12436
|
+
example: slos
|
|
12437
|
+
type: string
|
|
12438
|
+
x-enum-varnames:
|
|
12439
|
+
- SLOS
|
|
11090
12440
|
MetricSeries:
|
|
11091
12441
|
description: 'A metric to submit to Datadog.
|
|
11092
12442
|
|
|
@@ -11900,6 +13250,29 @@ components:
|
|
|
11900
13250
|
- id
|
|
11901
13251
|
- type
|
|
11902
13252
|
type: object
|
|
13253
|
+
NullableUserRelationship:
|
|
13254
|
+
description: Relationship to user.
|
|
13255
|
+
nullable: true
|
|
13256
|
+
properties:
|
|
13257
|
+
data:
|
|
13258
|
+
$ref: '#/components/schemas/NullableUserRelationshipData'
|
|
13259
|
+
required:
|
|
13260
|
+
- data
|
|
13261
|
+
type: object
|
|
13262
|
+
NullableUserRelationshipData:
|
|
13263
|
+
description: Relationship to user object.
|
|
13264
|
+
nullable: true
|
|
13265
|
+
properties:
|
|
13266
|
+
id:
|
|
13267
|
+
description: A unique identifier that represents the user.
|
|
13268
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
13269
|
+
type: string
|
|
13270
|
+
type:
|
|
13271
|
+
$ref: '#/components/schemas/UserResourceType'
|
|
13272
|
+
required:
|
|
13273
|
+
- id
|
|
13274
|
+
- type
|
|
13275
|
+
type: object
|
|
11903
13276
|
OktaAccount:
|
|
11904
13277
|
description: Schema for an Okta account.
|
|
11905
13278
|
properties:
|
|
@@ -12064,6 +13437,24 @@ components:
|
|
|
12064
13437
|
type: string
|
|
12065
13438
|
x-enum-varnames:
|
|
12066
13439
|
- ON_DEMAND_CONCURRENCY_CAP
|
|
13440
|
+
OpenAPIEndpoint:
|
|
13441
|
+
description: Endpoint info extracted from an `OpenAPI` specification.
|
|
13442
|
+
properties:
|
|
13443
|
+
method:
|
|
13444
|
+
description: The endpoint method.
|
|
13445
|
+
type: string
|
|
13446
|
+
path:
|
|
13447
|
+
description: The endpoint path.
|
|
13448
|
+
type: string
|
|
13449
|
+
type: object
|
|
13450
|
+
OpenAPIFile:
|
|
13451
|
+
description: Object for API data in an `OpenAPI` format as a file.
|
|
13452
|
+
properties:
|
|
13453
|
+
openapi_spec_file:
|
|
13454
|
+
description: Binary `OpenAPI` spec file
|
|
13455
|
+
format: binary
|
|
13456
|
+
type: string
|
|
13457
|
+
type: object
|
|
12067
13458
|
OpsgenieServiceCreateAttributes:
|
|
12068
13459
|
description: The Opsgenie service attributes for a create request.
|
|
12069
13460
|
properties:
|
|
@@ -13014,6 +14405,113 @@ components:
|
|
|
13014
14405
|
type: string
|
|
13015
14406
|
x-enum-varnames:
|
|
13016
14407
|
- PROCESS
|
|
14408
|
+
Project:
|
|
14409
|
+
description: A Project
|
|
14410
|
+
properties:
|
|
14411
|
+
attributes:
|
|
14412
|
+
$ref: '#/components/schemas/ProjectAttributes'
|
|
14413
|
+
id:
|
|
14414
|
+
description: The Project's identifier
|
|
14415
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
14416
|
+
type: string
|
|
14417
|
+
relationships:
|
|
14418
|
+
$ref: '#/components/schemas/ProjectRelationships'
|
|
14419
|
+
type:
|
|
14420
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
|
14421
|
+
required:
|
|
14422
|
+
- id
|
|
14423
|
+
- type
|
|
14424
|
+
- attributes
|
|
14425
|
+
type: object
|
|
14426
|
+
ProjectAttributes:
|
|
14427
|
+
description: Project attributes
|
|
14428
|
+
properties:
|
|
14429
|
+
key:
|
|
14430
|
+
description: The project's key
|
|
14431
|
+
example: CASEM
|
|
14432
|
+
type: string
|
|
14433
|
+
name:
|
|
14434
|
+
description: Project's name
|
|
14435
|
+
type: string
|
|
14436
|
+
type: object
|
|
14437
|
+
ProjectCreate:
|
|
14438
|
+
description: Project create
|
|
14439
|
+
properties:
|
|
14440
|
+
attributes:
|
|
14441
|
+
$ref: '#/components/schemas/ProjectCreateAttributes'
|
|
14442
|
+
type:
|
|
14443
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
|
14444
|
+
required:
|
|
14445
|
+
- attributes
|
|
14446
|
+
- type
|
|
14447
|
+
type: object
|
|
14448
|
+
ProjectCreateAttributes:
|
|
14449
|
+
description: Project creation attributes
|
|
14450
|
+
properties:
|
|
14451
|
+
key:
|
|
14452
|
+
description: Project's key. Cannot be "CASE"
|
|
14453
|
+
example: SEC
|
|
14454
|
+
type: string
|
|
14455
|
+
name:
|
|
14456
|
+
description: name
|
|
14457
|
+
example: Security Investigation
|
|
14458
|
+
type: string
|
|
14459
|
+
required:
|
|
14460
|
+
- name
|
|
14461
|
+
- key
|
|
14462
|
+
type: object
|
|
14463
|
+
ProjectCreateRequest:
|
|
14464
|
+
description: Project create request
|
|
14465
|
+
properties:
|
|
14466
|
+
data:
|
|
14467
|
+
$ref: '#/components/schemas/ProjectCreate'
|
|
14468
|
+
required:
|
|
14469
|
+
- data
|
|
14470
|
+
type: object
|
|
14471
|
+
ProjectRelationship:
|
|
14472
|
+
description: Relationship to project
|
|
14473
|
+
properties:
|
|
14474
|
+
data:
|
|
14475
|
+
$ref: '#/components/schemas/ProjectRelationshipData'
|
|
14476
|
+
required:
|
|
14477
|
+
- data
|
|
14478
|
+
type: object
|
|
14479
|
+
ProjectRelationshipData:
|
|
14480
|
+
description: Relationship to project object
|
|
14481
|
+
properties:
|
|
14482
|
+
id:
|
|
14483
|
+
description: A unique identifier that represents the project
|
|
14484
|
+
example: e555e290-ed65-49bd-ae18-8acbfcf18db7
|
|
14485
|
+
type: string
|
|
14486
|
+
type:
|
|
14487
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
|
14488
|
+
required:
|
|
14489
|
+
- id
|
|
14490
|
+
- type
|
|
14491
|
+
type: object
|
|
14492
|
+
ProjectRelationships:
|
|
14493
|
+
description: Project relationships
|
|
14494
|
+
properties:
|
|
14495
|
+
member_team:
|
|
14496
|
+
$ref: '#/components/schemas/RelationshipToTeamLinks'
|
|
14497
|
+
member_user:
|
|
14498
|
+
$ref: '#/components/schemas/UsersRelationship'
|
|
14499
|
+
type: object
|
|
14500
|
+
ProjectResourceType:
|
|
14501
|
+
default: project
|
|
14502
|
+
description: Project resource type
|
|
14503
|
+
enum:
|
|
14504
|
+
- project
|
|
14505
|
+
example: project
|
|
14506
|
+
type: string
|
|
14507
|
+
x-enum-varnames:
|
|
14508
|
+
- PROJECT
|
|
14509
|
+
ProjectResponse:
|
|
14510
|
+
description: Project response
|
|
14511
|
+
properties:
|
|
14512
|
+
data:
|
|
14513
|
+
$ref: '#/components/schemas/Project'
|
|
14514
|
+
type: object
|
|
13017
14515
|
ProjectedCost:
|
|
13018
14516
|
description: Projected Cost data.
|
|
13019
14517
|
properties:
|
|
@@ -13070,6 +14568,15 @@ components:
|
|
|
13070
14568
|
type: string
|
|
13071
14569
|
x-enum-varnames:
|
|
13072
14570
|
- PROJECt_COST
|
|
14571
|
+
ProjectsResponse:
|
|
14572
|
+
description: Response with projects
|
|
14573
|
+
properties:
|
|
14574
|
+
data:
|
|
14575
|
+
description: Projects response data
|
|
14576
|
+
items:
|
|
14577
|
+
$ref: '#/components/schemas/Project'
|
|
14578
|
+
type: array
|
|
14579
|
+
type: object
|
|
13073
14580
|
QueryFormula:
|
|
13074
14581
|
description: A formula for calculation based on one or more queries.
|
|
13075
14582
|
properties:
|
|
@@ -16588,6 +18095,219 @@ components:
|
|
|
16588
18095
|
description: The version of the rule.
|
|
16589
18096
|
format: int64
|
|
16590
18097
|
type: integer
|
|
18098
|
+
SecurityMonitoringSuppression:
|
|
18099
|
+
description: The suppression rule's properties.
|
|
18100
|
+
properties:
|
|
18101
|
+
attributes:
|
|
18102
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
|
|
18103
|
+
id:
|
|
18104
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionID'
|
|
18105
|
+
type:
|
|
18106
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionType'
|
|
18107
|
+
type: object
|
|
18108
|
+
SecurityMonitoringSuppressionAttributes:
|
|
18109
|
+
description: The attributes of the suppression rule.
|
|
18110
|
+
properties:
|
|
18111
|
+
creation_date:
|
|
18112
|
+
description: A Unix millisecond timestamp given the creation date of the
|
|
18113
|
+
suppression rule.
|
|
18114
|
+
format: int64
|
|
18115
|
+
type: integer
|
|
18116
|
+
creator:
|
|
18117
|
+
$ref: '#/components/schemas/SecurityMonitoringUser'
|
|
18118
|
+
description:
|
|
18119
|
+
description: A description for the suppression rule.
|
|
18120
|
+
example: This rule suppresses low-severity signals in staging environments.
|
|
18121
|
+
type: string
|
|
18122
|
+
enabled:
|
|
18123
|
+
description: Whether the suppression rule is enabled.
|
|
18124
|
+
example: true
|
|
18125
|
+
type: boolean
|
|
18126
|
+
expiration_date:
|
|
18127
|
+
description: A Unix millisecond timestamp giving an expiration date for
|
|
18128
|
+
the suppression rule. After this date, it won't suppress signals anymore.
|
|
18129
|
+
example: 1703187336000
|
|
18130
|
+
format: int64
|
|
18131
|
+
type: integer
|
|
18132
|
+
name:
|
|
18133
|
+
description: The name of the suppression rule.
|
|
18134
|
+
example: Custom suppression
|
|
18135
|
+
type: string
|
|
18136
|
+
rule_query:
|
|
18137
|
+
description: The rule query of the suppression rule, with the same syntax
|
|
18138
|
+
as the search bar for detection rules.
|
|
18139
|
+
example: type:log_detection source:cloudtrail
|
|
18140
|
+
type: string
|
|
18141
|
+
suppression_query:
|
|
18142
|
+
description: The suppression query of the suppression rule. If a signal
|
|
18143
|
+
matches this query, it is suppressed and not triggered. Same syntax as
|
|
18144
|
+
the queries to search signals in the signal explorer.
|
|
18145
|
+
example: env:staging status:low
|
|
18146
|
+
type: string
|
|
18147
|
+
update_date:
|
|
18148
|
+
description: A Unix millisecond timestamp given the update date of the suppression
|
|
18149
|
+
rule.
|
|
18150
|
+
format: int64
|
|
18151
|
+
type: integer
|
|
18152
|
+
updater:
|
|
18153
|
+
$ref: '#/components/schemas/SecurityMonitoringUser'
|
|
18154
|
+
version:
|
|
18155
|
+
description: The version of the suppression rule; it starts at 1, and is
|
|
18156
|
+
incremented at each update.
|
|
18157
|
+
example: 42
|
|
18158
|
+
format: int32
|
|
18159
|
+
maximum: 2147483647
|
|
18160
|
+
type: integer
|
|
18161
|
+
type: object
|
|
18162
|
+
SecurityMonitoringSuppressionCreateAttributes:
|
|
18163
|
+
description: Object containing the attributes of the suppression rule to be
|
|
18164
|
+
created.
|
|
18165
|
+
properties:
|
|
18166
|
+
description:
|
|
18167
|
+
description: A description for the suppression rule.
|
|
18168
|
+
example: This rule suppresses low-severity signals in staging environments.
|
|
18169
|
+
type: string
|
|
18170
|
+
enabled:
|
|
18171
|
+
description: Whether the suppression rule is enabled.
|
|
18172
|
+
example: true
|
|
18173
|
+
type: boolean
|
|
18174
|
+
expiration_date:
|
|
18175
|
+
description: A Unix millisecond timestamp giving an expiration date for
|
|
18176
|
+
the suppression rule. After this date, it won't suppress signals anymore.
|
|
18177
|
+
example: 1703187336000
|
|
18178
|
+
format: int64
|
|
18179
|
+
type: integer
|
|
18180
|
+
name:
|
|
18181
|
+
description: The name of the suppression rule.
|
|
18182
|
+
example: Custom suppression
|
|
18183
|
+
type: string
|
|
18184
|
+
rule_query:
|
|
18185
|
+
description: The rule query of the suppression rule, with the same syntax
|
|
18186
|
+
as the search bar for detection rules.
|
|
18187
|
+
example: type:log_detection source:cloudtrail
|
|
18188
|
+
type: string
|
|
18189
|
+
suppression_query:
|
|
18190
|
+
description: The suppression query of the suppression rule. If a signal
|
|
18191
|
+
matches this query, it is suppressed and is not triggered . Same syntax
|
|
18192
|
+
as the queries to search signals in the signal explorer.
|
|
18193
|
+
example: env:staging status:low
|
|
18194
|
+
type: string
|
|
18195
|
+
required:
|
|
18196
|
+
- name
|
|
18197
|
+
- enabled
|
|
18198
|
+
- rule_query
|
|
18199
|
+
- suppression_query
|
|
18200
|
+
type: object
|
|
18201
|
+
SecurityMonitoringSuppressionCreateData:
|
|
18202
|
+
description: Object for a single suppression rule.
|
|
18203
|
+
properties:
|
|
18204
|
+
attributes:
|
|
18205
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionCreateAttributes'
|
|
18206
|
+
type:
|
|
18207
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionType'
|
|
18208
|
+
required:
|
|
18209
|
+
- type
|
|
18210
|
+
- attributes
|
|
18211
|
+
type: object
|
|
18212
|
+
SecurityMonitoringSuppressionCreateRequest:
|
|
18213
|
+
description: Request object that includes the suppression rule that you would
|
|
18214
|
+
like to create.
|
|
18215
|
+
properties:
|
|
18216
|
+
data:
|
|
18217
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionCreateData'
|
|
18218
|
+
required:
|
|
18219
|
+
- data
|
|
18220
|
+
type: object
|
|
18221
|
+
SecurityMonitoringSuppressionID:
|
|
18222
|
+
description: The ID of the suppression rule.
|
|
18223
|
+
example: 3dd-0uc-h1s
|
|
18224
|
+
type: string
|
|
18225
|
+
SecurityMonitoringSuppressionResponse:
|
|
18226
|
+
description: Response object containing a single suppression rule.
|
|
18227
|
+
properties:
|
|
18228
|
+
data:
|
|
18229
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppression'
|
|
18230
|
+
type: object
|
|
18231
|
+
SecurityMonitoringSuppressionType:
|
|
18232
|
+
default: suppressions
|
|
18233
|
+
description: The type of the resource. The value should always be `suppressions`.
|
|
18234
|
+
enum:
|
|
18235
|
+
- suppressions
|
|
18236
|
+
example: suppressions
|
|
18237
|
+
type: string
|
|
18238
|
+
x-enum-varnames:
|
|
18239
|
+
- SUPPRESSIONS
|
|
18240
|
+
SecurityMonitoringSuppressionUpdateAttributes:
|
|
18241
|
+
description: The suppression rule properties to be updated.
|
|
18242
|
+
properties:
|
|
18243
|
+
description:
|
|
18244
|
+
description: A description for the suppression rule.
|
|
18245
|
+
example: This rule suppresses low-severity signals in staging environments.
|
|
18246
|
+
type: string
|
|
18247
|
+
enabled:
|
|
18248
|
+
description: Whether the suppression rule is enabled.
|
|
18249
|
+
example: true
|
|
18250
|
+
type: boolean
|
|
18251
|
+
expiration_date:
|
|
18252
|
+
description: A Unix millisecond timestamp giving an expiration date for
|
|
18253
|
+
the suppression rule. After this date, it won't suppress signals anymore.
|
|
18254
|
+
If unset, the expiration date of the suppression rule is left untouched.
|
|
18255
|
+
If set to `null`, the expiration date is removed.
|
|
18256
|
+
example: 1703187336000
|
|
18257
|
+
format: int64
|
|
18258
|
+
nullable: true
|
|
18259
|
+
type: integer
|
|
18260
|
+
name:
|
|
18261
|
+
description: The name of the suppression rule.
|
|
18262
|
+
example: Custom suppression
|
|
18263
|
+
type: string
|
|
18264
|
+
rule_query:
|
|
18265
|
+
description: The rule query of the suppression rule, with the same syntax
|
|
18266
|
+
as the search bar for detection rules.
|
|
18267
|
+
example: type:log_detection source:cloudtrail
|
|
18268
|
+
type: string
|
|
18269
|
+
suppression_query:
|
|
18270
|
+
description: The suppression query of the suppression rule. If a signal
|
|
18271
|
+
matches this query, it is suppressed and not triggered. Same syntax as
|
|
18272
|
+
the queries to search signals in the signal explorer.
|
|
18273
|
+
example: env:staging status:low
|
|
18274
|
+
type: string
|
|
18275
|
+
version:
|
|
18276
|
+
description: The current version of the suppression. This is optional, but
|
|
18277
|
+
it can help prevent concurrent modifications.
|
|
18278
|
+
format: int32
|
|
18279
|
+
maximum: 2147483647
|
|
18280
|
+
type: integer
|
|
18281
|
+
type: object
|
|
18282
|
+
SecurityMonitoringSuppressionUpdateData:
|
|
18283
|
+
description: The new suppression properties; partial updates are supported.
|
|
18284
|
+
properties:
|
|
18285
|
+
attributes:
|
|
18286
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateAttributes'
|
|
18287
|
+
type:
|
|
18288
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionType'
|
|
18289
|
+
required:
|
|
18290
|
+
- type
|
|
18291
|
+
- attributes
|
|
18292
|
+
type: object
|
|
18293
|
+
SecurityMonitoringSuppressionUpdateRequest:
|
|
18294
|
+
description: Request object containing the fields to update on the suppression
|
|
18295
|
+
rule.
|
|
18296
|
+
properties:
|
|
18297
|
+
data:
|
|
18298
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateData'
|
|
18299
|
+
required:
|
|
18300
|
+
- data
|
|
18301
|
+
type: object
|
|
18302
|
+
SecurityMonitoringSuppressionsResponse:
|
|
18303
|
+
description: Response object containing the available suppression rules.
|
|
18304
|
+
properties:
|
|
18305
|
+
data:
|
|
18306
|
+
description: A list of suppressions objects.
|
|
18307
|
+
items:
|
|
18308
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppression'
|
|
18309
|
+
type: array
|
|
18310
|
+
type: object
|
|
16591
18311
|
SecurityMonitoringThirdPartyRootQuery:
|
|
16592
18312
|
description: A query to be combined with the third party case query.
|
|
16593
18313
|
properties:
|
|
@@ -16666,6 +18386,19 @@ components:
|
|
|
16666
18386
|
required:
|
|
16667
18387
|
- uuid
|
|
16668
18388
|
type: object
|
|
18389
|
+
SecurityMonitoringUser:
|
|
18390
|
+
description: A user.
|
|
18391
|
+
properties:
|
|
18392
|
+
handle:
|
|
18393
|
+
description: The handle of the user.
|
|
18394
|
+
example: john.doe@datadoghq.com
|
|
18395
|
+
type: string
|
|
18396
|
+
name:
|
|
18397
|
+
description: The name of the user.
|
|
18398
|
+
example: John Doe
|
|
18399
|
+
nullable: true
|
|
18400
|
+
type: string
|
|
18401
|
+
type: object
|
|
16669
18402
|
SensitiveDataScannerConfigRequest:
|
|
16670
18403
|
description: Group reorder request.
|
|
16671
18404
|
properties:
|
|
@@ -16953,7 +18686,7 @@ components:
|
|
|
16953
18686
|
description: 'Keyword list that will be checked during scanning in order
|
|
16954
18687
|
to validate a match.
|
|
16955
18688
|
|
|
16956
|
-
The number of keywords in the list must be less than or equal to
|
|
18689
|
+
The number of keywords in the list must be less than or equal to 30.'
|
|
16957
18690
|
example:
|
|
16958
18691
|
- credit card
|
|
16959
18692
|
- cc
|
|
@@ -17237,7 +18970,10 @@ components:
|
|
|
17237
18970
|
description: Name of the standard pattern.
|
|
17238
18971
|
type: string
|
|
17239
18972
|
pattern:
|
|
17240
|
-
|
|
18973
|
+
deprecated: true
|
|
18974
|
+
description: (Deprecated) Regex to match, optionally documented for older
|
|
18975
|
+
standard rules. Refer to the `description` field to understand what the
|
|
18976
|
+
rule does.
|
|
17241
18977
|
type: string
|
|
17242
18978
|
priority:
|
|
17243
18979
|
description: Integer from 1 (high) to 5 (low) indicating standard pattern
|
|
@@ -18327,6 +20063,23 @@ components:
|
|
|
18327
20063
|
$ref: '#/components/schemas/ServiceDefinitionData'
|
|
18328
20064
|
type: array
|
|
18329
20065
|
type: object
|
|
20066
|
+
ServiceNowTicket:
|
|
20067
|
+
description: ServiceNow ticket attached to case
|
|
20068
|
+
nullable: true
|
|
20069
|
+
properties:
|
|
20070
|
+
result:
|
|
20071
|
+
$ref: '#/components/schemas/ServiceNowTicketResult'
|
|
20072
|
+
status:
|
|
20073
|
+
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
|
|
20074
|
+
readOnly: true
|
|
20075
|
+
type: object
|
|
20076
|
+
ServiceNowTicketResult:
|
|
20077
|
+
description: ServiceNow ticket information
|
|
20078
|
+
properties:
|
|
20079
|
+
sys_target_link:
|
|
20080
|
+
description: Link to the Incident created on ServiceNow
|
|
20081
|
+
type: string
|
|
20082
|
+
type: object
|
|
18330
20083
|
SlackIntegrationMetadata:
|
|
18331
20084
|
description: Incident integration metadata for the Slack integration.
|
|
18332
20085
|
properties:
|
|
@@ -20043,6 +21796,29 @@ components:
|
|
|
20043
21796
|
example: min
|
|
20044
21797
|
type: string
|
|
20045
21798
|
type: object
|
|
21799
|
+
UpdateOpenAPIResponse:
|
|
21800
|
+
description: Response for `UpdateOpenAPI`.
|
|
21801
|
+
properties:
|
|
21802
|
+
data:
|
|
21803
|
+
$ref: '#/components/schemas/UpdateOpenAPIResponseData'
|
|
21804
|
+
type: object
|
|
21805
|
+
UpdateOpenAPIResponseAttributes:
|
|
21806
|
+
description: Attributes for `UpdateOpenAPI`.
|
|
21807
|
+
properties:
|
|
21808
|
+
failed_endpoints:
|
|
21809
|
+
description: List of endpoints which couldn't be parsed.
|
|
21810
|
+
items:
|
|
21811
|
+
$ref: '#/components/schemas/OpenAPIEndpoint'
|
|
21812
|
+
type: array
|
|
21813
|
+
type: object
|
|
21814
|
+
UpdateOpenAPIResponseData:
|
|
21815
|
+
description: Data envelope for `UpdateOpenAPIResponse`.
|
|
21816
|
+
properties:
|
|
21817
|
+
attributes:
|
|
21818
|
+
$ref: '#/components/schemas/UpdateOpenAPIResponseAttributes'
|
|
21819
|
+
id:
|
|
21820
|
+
$ref: '#/components/schemas/ApiID'
|
|
21821
|
+
type: object
|
|
20046
21822
|
UsageApplicationSecurityMonitoringResponse:
|
|
20047
21823
|
description: Application Security Monitoring usage response.
|
|
20048
21824
|
properties:
|
|
@@ -20305,12 +22081,34 @@ components:
|
|
|
20305
22081
|
type: string
|
|
20306
22082
|
x-enum-varnames:
|
|
20307
22083
|
- USER_INVITATIONS
|
|
22084
|
+
UserRelationshipData:
|
|
22085
|
+
description: Relationship to user object.
|
|
22086
|
+
properties:
|
|
22087
|
+
id:
|
|
22088
|
+
description: A unique identifier that represents the user.
|
|
22089
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
22090
|
+
type: string
|
|
22091
|
+
type:
|
|
22092
|
+
$ref: '#/components/schemas/UserResourceType'
|
|
22093
|
+
required:
|
|
22094
|
+
- id
|
|
22095
|
+
- type
|
|
22096
|
+
type: object
|
|
20308
22097
|
UserRelationships:
|
|
20309
22098
|
description: Relationships of the user object.
|
|
20310
22099
|
properties:
|
|
20311
22100
|
roles:
|
|
20312
22101
|
$ref: '#/components/schemas/RelationshipToRoles'
|
|
20313
22102
|
type: object
|
|
22103
|
+
UserResourceType:
|
|
22104
|
+
default: user
|
|
22105
|
+
description: User resource type.
|
|
22106
|
+
enum:
|
|
22107
|
+
- user
|
|
22108
|
+
example: user
|
|
22109
|
+
type: string
|
|
22110
|
+
x-enum-varnames:
|
|
22111
|
+
- USER
|
|
20314
22112
|
UserResponse:
|
|
20315
22113
|
description: Response containing information about a single user.
|
|
20316
22114
|
properties:
|
|
@@ -20389,6 +22187,10 @@ components:
|
|
|
20389
22187
|
required:
|
|
20390
22188
|
- type
|
|
20391
22189
|
type: object
|
|
22190
|
+
UserTeamIncluded:
|
|
22191
|
+
description: Included resources related to the team membership
|
|
22192
|
+
oneOf:
|
|
22193
|
+
- $ref: '#/components/schemas/User'
|
|
20392
22194
|
UserTeamPermission:
|
|
20393
22195
|
description: A user's permissions for a given team
|
|
20394
22196
|
properties:
|
|
@@ -20443,6 +22245,11 @@ components:
|
|
|
20443
22245
|
properties:
|
|
20444
22246
|
data:
|
|
20445
22247
|
$ref: '#/components/schemas/UserTeam'
|
|
22248
|
+
included:
|
|
22249
|
+
description: Resources related to the team memberships
|
|
22250
|
+
items:
|
|
22251
|
+
$ref: '#/components/schemas/UserTeamIncluded'
|
|
22252
|
+
type: array
|
|
20446
22253
|
type: object
|
|
20447
22254
|
UserTeamRole:
|
|
20448
22255
|
description: The user's role within the team
|
|
@@ -20547,6 +22354,18 @@ components:
|
|
|
20547
22354
|
required:
|
|
20548
22355
|
- data
|
|
20549
22356
|
type: object
|
|
22357
|
+
UsersRelationship:
|
|
22358
|
+
description: Relationship to users.
|
|
22359
|
+
properties:
|
|
22360
|
+
data:
|
|
22361
|
+
description: Relationships to user objects.
|
|
22362
|
+
example: []
|
|
22363
|
+
items:
|
|
22364
|
+
$ref: '#/components/schemas/UserRelationshipData'
|
|
22365
|
+
type: array
|
|
22366
|
+
required:
|
|
22367
|
+
- data
|
|
22368
|
+
type: object
|
|
20550
22369
|
UsersResponse:
|
|
20551
22370
|
description: Response containing information about multiple users.
|
|
20552
22371
|
properties:
|
|
@@ -20619,6 +22438,8 @@ components:
|
|
|
20619
22438
|
apm_service_catalog_read: View service catalog and service definitions.
|
|
20620
22439
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
|
20621
22440
|
when those definitions are maintained by Datadog.
|
|
22441
|
+
cases_read: Read all cases data.
|
|
22442
|
+
cases_write: Create, update and delete cases data.
|
|
20622
22443
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
|
20623
22444
|
the API.
|
|
20624
22445
|
ci_visibility_read: View CI Visibility.
|
|
@@ -20869,6 +22690,195 @@ paths:
|
|
|
20869
22690
|
tags:
|
|
20870
22691
|
- Key Management
|
|
20871
22692
|
x-codegen-request-body-name: body
|
|
22693
|
+
/api/v2/apicatalog/api/{id}:
|
|
22694
|
+
delete:
|
|
22695
|
+
description: Delete a specific API by ID.
|
|
22696
|
+
operationId: DeleteOpenAPI
|
|
22697
|
+
parameters:
|
|
22698
|
+
- description: ID of the API to delete
|
|
22699
|
+
in: path
|
|
22700
|
+
name: id
|
|
22701
|
+
required: true
|
|
22702
|
+
schema:
|
|
22703
|
+
$ref: '#/components/schemas/ApiID'
|
|
22704
|
+
responses:
|
|
22705
|
+
'204':
|
|
22706
|
+
description: API deleted successfully
|
|
22707
|
+
'400':
|
|
22708
|
+
content:
|
|
22709
|
+
application/json:
|
|
22710
|
+
schema:
|
|
22711
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22712
|
+
description: Bad request
|
|
22713
|
+
'403':
|
|
22714
|
+
content:
|
|
22715
|
+
application/json:
|
|
22716
|
+
schema:
|
|
22717
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22718
|
+
description: Forbidden
|
|
22719
|
+
'404':
|
|
22720
|
+
content:
|
|
22721
|
+
application/json:
|
|
22722
|
+
schema:
|
|
22723
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22724
|
+
description: API not found error
|
|
22725
|
+
'429':
|
|
22726
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22727
|
+
summary: Delete an API
|
|
22728
|
+
tags:
|
|
22729
|
+
- API Management
|
|
22730
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22731
|
+
|
|
22732
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22733
|
+
/api/v2/apicatalog/api/{id}/openapi:
|
|
22734
|
+
get:
|
|
22735
|
+
description: Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
|
22736
|
+
format file.
|
|
22737
|
+
operationId: GetOpenAPI
|
|
22738
|
+
parameters:
|
|
22739
|
+
- description: ID of the API to retrieve
|
|
22740
|
+
in: path
|
|
22741
|
+
name: id
|
|
22742
|
+
required: true
|
|
22743
|
+
schema:
|
|
22744
|
+
$ref: '#/components/schemas/ApiID'
|
|
22745
|
+
responses:
|
|
22746
|
+
'200':
|
|
22747
|
+
content:
|
|
22748
|
+
multipart/form-data:
|
|
22749
|
+
schema:
|
|
22750
|
+
format: binary
|
|
22751
|
+
type: string
|
|
22752
|
+
description: OK
|
|
22753
|
+
'400':
|
|
22754
|
+
content:
|
|
22755
|
+
application/json:
|
|
22756
|
+
schema:
|
|
22757
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22758
|
+
description: Bad request
|
|
22759
|
+
'403':
|
|
22760
|
+
content:
|
|
22761
|
+
application/json:
|
|
22762
|
+
schema:
|
|
22763
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22764
|
+
description: Forbidden
|
|
22765
|
+
'404':
|
|
22766
|
+
content:
|
|
22767
|
+
application/json:
|
|
22768
|
+
schema:
|
|
22769
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22770
|
+
description: API not found error
|
|
22771
|
+
'429':
|
|
22772
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22773
|
+
summary: Get an API
|
|
22774
|
+
tags:
|
|
22775
|
+
- API Management
|
|
22776
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22777
|
+
|
|
22778
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22779
|
+
put:
|
|
22780
|
+
description: 'Update information about a specific API. The given content will
|
|
22781
|
+
replace all API content of the given ID.
|
|
22782
|
+
|
|
22783
|
+
The ID is returned by the create API, or can be found in the URL in the API
|
|
22784
|
+
catalog UI.
|
|
22785
|
+
|
|
22786
|
+
'
|
|
22787
|
+
operationId: UpdateOpenAPI
|
|
22788
|
+
parameters:
|
|
22789
|
+
- description: ID of the API to modify
|
|
22790
|
+
in: path
|
|
22791
|
+
name: id
|
|
22792
|
+
required: true
|
|
22793
|
+
schema:
|
|
22794
|
+
$ref: '#/components/schemas/ApiID'
|
|
22795
|
+
requestBody:
|
|
22796
|
+
content:
|
|
22797
|
+
multipart/form-data:
|
|
22798
|
+
schema:
|
|
22799
|
+
$ref: '#/components/schemas/OpenAPIFile'
|
|
22800
|
+
required: true
|
|
22801
|
+
responses:
|
|
22802
|
+
'200':
|
|
22803
|
+
content:
|
|
22804
|
+
application/json:
|
|
22805
|
+
schema:
|
|
22806
|
+
$ref: '#/components/schemas/UpdateOpenAPIResponse'
|
|
22807
|
+
description: API updated successfully
|
|
22808
|
+
'400':
|
|
22809
|
+
content:
|
|
22810
|
+
application/json:
|
|
22811
|
+
schema:
|
|
22812
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22813
|
+
description: Bad request
|
|
22814
|
+
'403':
|
|
22815
|
+
content:
|
|
22816
|
+
application/json:
|
|
22817
|
+
schema:
|
|
22818
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22819
|
+
description: Forbidden
|
|
22820
|
+
'404':
|
|
22821
|
+
content:
|
|
22822
|
+
application/json:
|
|
22823
|
+
schema:
|
|
22824
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22825
|
+
description: API not found error
|
|
22826
|
+
'429':
|
|
22827
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22828
|
+
summary: Update an API
|
|
22829
|
+
tags:
|
|
22830
|
+
- API Management
|
|
22831
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22832
|
+
|
|
22833
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22834
|
+
/api/v2/apicatalog/openapi:
|
|
22835
|
+
post:
|
|
22836
|
+
description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
|
22837
|
+
specification given.
|
|
22838
|
+
|
|
22839
|
+
It supports version `2.0`, `3.0` and `3.1` of the specification. A specific
|
|
22840
|
+
extension section, `x-datadog`,
|
|
22841
|
+
|
|
22842
|
+
let you specify the `teamHandle` for your team responsible for the API in
|
|
22843
|
+
Datadog.
|
|
22844
|
+
|
|
22845
|
+
It returns the created API ID.
|
|
22846
|
+
|
|
22847
|
+
'
|
|
22848
|
+
operationId: CreateOpenAPI
|
|
22849
|
+
requestBody:
|
|
22850
|
+
content:
|
|
22851
|
+
multipart/form-data:
|
|
22852
|
+
schema:
|
|
22853
|
+
$ref: '#/components/schemas/OpenAPIFile'
|
|
22854
|
+
required: true
|
|
22855
|
+
responses:
|
|
22856
|
+
'201':
|
|
22857
|
+
content:
|
|
22858
|
+
application/json:
|
|
22859
|
+
schema:
|
|
22860
|
+
$ref: '#/components/schemas/CreateOpenAPIResponse'
|
|
22861
|
+
description: API created successfully
|
|
22862
|
+
'400':
|
|
22863
|
+
content:
|
|
22864
|
+
application/json:
|
|
22865
|
+
schema:
|
|
22866
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22867
|
+
description: Bad request
|
|
22868
|
+
'403':
|
|
22869
|
+
content:
|
|
22870
|
+
application/json:
|
|
22871
|
+
schema:
|
|
22872
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22873
|
+
description: Forbidden
|
|
22874
|
+
'429':
|
|
22875
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22876
|
+
summary: Create a new API
|
|
22877
|
+
tags:
|
|
22878
|
+
- API Management
|
|
22879
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22880
|
+
|
|
22881
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
20872
22882
|
/api/v2/apm/config/metrics:
|
|
20873
22883
|
get:
|
|
20874
22884
|
description: Get the list of configured span-based metrics with their definitions.
|
|
@@ -21487,137 +23497,603 @@ paths:
|
|
|
21487
23497
|
appKeyAuth: []
|
|
21488
23498
|
- AuthZ:
|
|
21489
23499
|
- user_access_manage
|
|
21490
|
-
summary: Create an AuthN Mapping
|
|
23500
|
+
summary: Create an AuthN Mapping
|
|
23501
|
+
tags:
|
|
23502
|
+
- AuthN Mappings
|
|
23503
|
+
x-codegen-request-body-name: body
|
|
23504
|
+
x-permission: OR(USER_ACCESS_MANAGE)
|
|
23505
|
+
/api/v2/authn_mappings/{authn_mapping_id}:
|
|
23506
|
+
delete:
|
|
23507
|
+
description: Delete an AuthN Mapping specified by AuthN Mapping UUID.
|
|
23508
|
+
operationId: DeleteAuthNMapping
|
|
23509
|
+
parameters:
|
|
23510
|
+
- $ref: '#/components/parameters/AuthNMappingID'
|
|
23511
|
+
responses:
|
|
23512
|
+
'204':
|
|
23513
|
+
description: OK
|
|
23514
|
+
'403':
|
|
23515
|
+
content:
|
|
23516
|
+
application/json:
|
|
23517
|
+
schema:
|
|
23518
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23519
|
+
description: Authentication Error
|
|
23520
|
+
'404':
|
|
23521
|
+
content:
|
|
23522
|
+
application/json:
|
|
23523
|
+
schema:
|
|
23524
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23525
|
+
description: Not Found
|
|
23526
|
+
'429':
|
|
23527
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23528
|
+
security:
|
|
23529
|
+
- apiKeyAuth: []
|
|
23530
|
+
appKeyAuth: []
|
|
23531
|
+
- AuthZ:
|
|
23532
|
+
- user_access_manage
|
|
23533
|
+
summary: Delete an AuthN Mapping
|
|
23534
|
+
tags:
|
|
23535
|
+
- AuthN Mappings
|
|
23536
|
+
x-permission: OR(USER_ACCESS_MANAGE)
|
|
23537
|
+
get:
|
|
23538
|
+
description: Get an AuthN Mapping specified by the AuthN Mapping UUID.
|
|
23539
|
+
operationId: GetAuthNMapping
|
|
23540
|
+
parameters:
|
|
23541
|
+
- $ref: '#/components/parameters/AuthNMappingID'
|
|
23542
|
+
responses:
|
|
23543
|
+
'200':
|
|
23544
|
+
content:
|
|
23545
|
+
application/json:
|
|
23546
|
+
schema:
|
|
23547
|
+
$ref: '#/components/schemas/AuthNMappingResponse'
|
|
23548
|
+
description: OK
|
|
23549
|
+
'403':
|
|
23550
|
+
content:
|
|
23551
|
+
application/json:
|
|
23552
|
+
schema:
|
|
23553
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23554
|
+
description: Authentication Error
|
|
23555
|
+
'404':
|
|
23556
|
+
content:
|
|
23557
|
+
application/json:
|
|
23558
|
+
schema:
|
|
23559
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23560
|
+
description: Not Found
|
|
23561
|
+
'429':
|
|
23562
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23563
|
+
security:
|
|
23564
|
+
- apiKeyAuth: []
|
|
23565
|
+
appKeyAuth: []
|
|
23566
|
+
- AuthZ: []
|
|
23567
|
+
summary: Get an AuthN Mapping by UUID
|
|
23568
|
+
tags:
|
|
23569
|
+
- AuthN Mappings
|
|
23570
|
+
x-permission: OPEN()
|
|
23571
|
+
patch:
|
|
23572
|
+
description: Edit an AuthN Mapping.
|
|
23573
|
+
operationId: UpdateAuthNMapping
|
|
23574
|
+
parameters:
|
|
23575
|
+
- $ref: '#/components/parameters/AuthNMappingID'
|
|
23576
|
+
requestBody:
|
|
23577
|
+
content:
|
|
23578
|
+
application/json:
|
|
23579
|
+
schema:
|
|
23580
|
+
$ref: '#/components/schemas/AuthNMappingUpdateRequest'
|
|
23581
|
+
required: true
|
|
23582
|
+
responses:
|
|
23583
|
+
'200':
|
|
23584
|
+
content:
|
|
23585
|
+
application/json:
|
|
23586
|
+
schema:
|
|
23587
|
+
$ref: '#/components/schemas/AuthNMappingResponse'
|
|
23588
|
+
description: OK
|
|
23589
|
+
'400':
|
|
23590
|
+
content:
|
|
23591
|
+
application/json:
|
|
23592
|
+
schema:
|
|
23593
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23594
|
+
description: Bad Request
|
|
23595
|
+
'403':
|
|
23596
|
+
content:
|
|
23597
|
+
application/json:
|
|
23598
|
+
schema:
|
|
23599
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23600
|
+
description: Authentication Error
|
|
23601
|
+
'404':
|
|
23602
|
+
content:
|
|
23603
|
+
application/json:
|
|
23604
|
+
schema:
|
|
23605
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23606
|
+
description: Not Found
|
|
23607
|
+
'409':
|
|
23608
|
+
content:
|
|
23609
|
+
application/json:
|
|
23610
|
+
schema:
|
|
23611
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23612
|
+
description: Conflict
|
|
23613
|
+
'422':
|
|
23614
|
+
content:
|
|
23615
|
+
application/json:
|
|
23616
|
+
schema:
|
|
23617
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
23618
|
+
description: Unprocessable Entity
|
|
23619
|
+
'429':
|
|
23620
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23621
|
+
security:
|
|
23622
|
+
- apiKeyAuth: []
|
|
23623
|
+
appKeyAuth: []
|
|
23624
|
+
- AuthZ:
|
|
23625
|
+
- user_access_manage
|
|
23626
|
+
summary: Edit an AuthN Mapping
|
|
21491
23627
|
tags:
|
|
21492
23628
|
- AuthN Mappings
|
|
21493
23629
|
x-codegen-request-body-name: body
|
|
21494
23630
|
x-permission: OR(USER_ACCESS_MANAGE)
|
|
21495
|
-
/api/v2/
|
|
21496
|
-
|
|
21497
|
-
description:
|
|
21498
|
-
operationId:
|
|
23631
|
+
/api/v2/cases:
|
|
23632
|
+
get:
|
|
23633
|
+
description: Search cases.
|
|
23634
|
+
operationId: SearchCases
|
|
21499
23635
|
parameters:
|
|
21500
|
-
- $ref: '#/components/parameters/
|
|
23636
|
+
- $ref: '#/components/parameters/PageSize'
|
|
23637
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
23638
|
+
- $ref: '#/components/parameters/CaseSortableFieldParameter'
|
|
23639
|
+
- description: Search query
|
|
23640
|
+
in: query
|
|
23641
|
+
name: filter
|
|
23642
|
+
required: false
|
|
23643
|
+
schema:
|
|
23644
|
+
example: status:open (team:case-management OR team:event-management)
|
|
23645
|
+
type: string
|
|
23646
|
+
- description: Specify if order is ascending or not
|
|
23647
|
+
in: query
|
|
23648
|
+
name: sort[asc]
|
|
23649
|
+
required: false
|
|
23650
|
+
schema:
|
|
23651
|
+
default: false
|
|
23652
|
+
type: boolean
|
|
21501
23653
|
responses:
|
|
21502
|
-
'
|
|
21503
|
-
description: OK
|
|
21504
|
-
'403':
|
|
23654
|
+
'200':
|
|
21505
23655
|
content:
|
|
21506
23656
|
application/json:
|
|
21507
23657
|
schema:
|
|
21508
|
-
$ref: '#/components/schemas/
|
|
21509
|
-
description:
|
|
23658
|
+
$ref: '#/components/schemas/CasesResponse'
|
|
23659
|
+
description: OK
|
|
23660
|
+
'400':
|
|
23661
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23662
|
+
'401':
|
|
23663
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23664
|
+
'403':
|
|
23665
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
21510
23666
|
'404':
|
|
23667
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23668
|
+
'429':
|
|
23669
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23670
|
+
security:
|
|
23671
|
+
- apiKeyAuth: []
|
|
23672
|
+
appKeyAuth: []
|
|
23673
|
+
- AuthZ:
|
|
23674
|
+
- cases_read
|
|
23675
|
+
summary: Search cases
|
|
23676
|
+
tags:
|
|
23677
|
+
- Case Management
|
|
23678
|
+
x-pagination:
|
|
23679
|
+
limitParam: page[size]
|
|
23680
|
+
pageOffsetParam: page[offset]
|
|
23681
|
+
resultsPath: data
|
|
23682
|
+
post:
|
|
23683
|
+
description: Create a Case
|
|
23684
|
+
operationId: CreateCase
|
|
23685
|
+
requestBody:
|
|
23686
|
+
content:
|
|
23687
|
+
application/json:
|
|
23688
|
+
schema:
|
|
23689
|
+
$ref: '#/components/schemas/CaseCreateRequest'
|
|
23690
|
+
description: Case payload
|
|
23691
|
+
required: true
|
|
23692
|
+
responses:
|
|
23693
|
+
'201':
|
|
21511
23694
|
content:
|
|
21512
23695
|
application/json:
|
|
21513
23696
|
schema:
|
|
21514
|
-
$ref: '#/components/schemas/
|
|
21515
|
-
description:
|
|
23697
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
23698
|
+
description: CREATED
|
|
23699
|
+
'400':
|
|
23700
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23701
|
+
'401':
|
|
23702
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23703
|
+
'403':
|
|
23704
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23705
|
+
'404':
|
|
23706
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
21516
23707
|
'429':
|
|
21517
23708
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
21518
23709
|
security:
|
|
21519
23710
|
- apiKeyAuth: []
|
|
21520
23711
|
appKeyAuth: []
|
|
21521
23712
|
- AuthZ:
|
|
21522
|
-
-
|
|
21523
|
-
summary:
|
|
23713
|
+
- cases_write
|
|
23714
|
+
summary: Create a case
|
|
21524
23715
|
tags:
|
|
21525
|
-
-
|
|
21526
|
-
|
|
23716
|
+
- Case Management
|
|
23717
|
+
/api/v2/cases/projects:
|
|
21527
23718
|
get:
|
|
21528
|
-
description: Get
|
|
21529
|
-
operationId:
|
|
21530
|
-
parameters:
|
|
21531
|
-
- $ref: '#/components/parameters/AuthNMappingID'
|
|
23719
|
+
description: Get all projects.
|
|
23720
|
+
operationId: GetProjects
|
|
21532
23721
|
responses:
|
|
21533
23722
|
'200':
|
|
21534
23723
|
content:
|
|
21535
23724
|
application/json:
|
|
21536
23725
|
schema:
|
|
21537
|
-
$ref: '#/components/schemas/
|
|
23726
|
+
$ref: '#/components/schemas/ProjectsResponse'
|
|
21538
23727
|
description: OK
|
|
23728
|
+
'400':
|
|
23729
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23730
|
+
'401':
|
|
23731
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
21539
23732
|
'403':
|
|
23733
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23734
|
+
'404':
|
|
23735
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23736
|
+
'429':
|
|
23737
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23738
|
+
security:
|
|
23739
|
+
- apiKeyAuth: []
|
|
23740
|
+
appKeyAuth: []
|
|
23741
|
+
- AuthZ:
|
|
23742
|
+
- cases_read
|
|
23743
|
+
summary: Get all projects
|
|
23744
|
+
tags:
|
|
23745
|
+
- Case Management
|
|
23746
|
+
post:
|
|
23747
|
+
description: Create a project.
|
|
23748
|
+
operationId: CreateProject
|
|
23749
|
+
requestBody:
|
|
23750
|
+
content:
|
|
23751
|
+
application/json:
|
|
23752
|
+
schema:
|
|
23753
|
+
$ref: '#/components/schemas/ProjectCreateRequest'
|
|
23754
|
+
description: Project payload
|
|
23755
|
+
required: true
|
|
23756
|
+
responses:
|
|
23757
|
+
'201':
|
|
21540
23758
|
content:
|
|
21541
23759
|
application/json:
|
|
21542
23760
|
schema:
|
|
21543
|
-
$ref: '#/components/schemas/
|
|
21544
|
-
description:
|
|
23761
|
+
$ref: '#/components/schemas/ProjectResponse'
|
|
23762
|
+
description: CREATED
|
|
23763
|
+
'400':
|
|
23764
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23765
|
+
'401':
|
|
23766
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23767
|
+
'403':
|
|
23768
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23769
|
+
'404':
|
|
23770
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23771
|
+
'429':
|
|
23772
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23773
|
+
security:
|
|
23774
|
+
- apiKeyAuth: []
|
|
23775
|
+
appKeyAuth: []
|
|
23776
|
+
- AuthZ:
|
|
23777
|
+
- cases_write
|
|
23778
|
+
summary: Create a project
|
|
23779
|
+
tags:
|
|
23780
|
+
- Case Management
|
|
23781
|
+
/api/v2/cases/projects/{project_id}:
|
|
23782
|
+
delete:
|
|
23783
|
+
description: Remove a project using the project's `id`.
|
|
23784
|
+
operationId: DeleteProject
|
|
23785
|
+
parameters:
|
|
23786
|
+
- $ref: '#/components/parameters/ProjectIDPathParameter'
|
|
23787
|
+
responses:
|
|
23788
|
+
'204':
|
|
23789
|
+
description: No Content
|
|
23790
|
+
'403':
|
|
23791
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
21545
23792
|
'404':
|
|
21546
23793
|
content:
|
|
21547
23794
|
application/json:
|
|
21548
23795
|
schema:
|
|
21549
23796
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
21550
|
-
description:
|
|
23797
|
+
description: API error response
|
|
21551
23798
|
'429':
|
|
21552
23799
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
21553
23800
|
security:
|
|
21554
23801
|
- apiKeyAuth: []
|
|
21555
23802
|
appKeyAuth: []
|
|
21556
|
-
- AuthZ:
|
|
21557
|
-
|
|
23803
|
+
- AuthZ:
|
|
23804
|
+
- cases_write
|
|
23805
|
+
summary: Remove a project
|
|
21558
23806
|
tags:
|
|
21559
|
-
-
|
|
21560
|
-
|
|
21561
|
-
|
|
21562
|
-
|
|
21563
|
-
operationId: UpdateAuthNMapping
|
|
23807
|
+
- Case Management
|
|
23808
|
+
get:
|
|
23809
|
+
description: Get the details of a project by `project_id`.
|
|
23810
|
+
operationId: GetProject
|
|
21564
23811
|
parameters:
|
|
21565
|
-
- $ref: '#/components/parameters/
|
|
23812
|
+
- $ref: '#/components/parameters/ProjectIDPathParameter'
|
|
23813
|
+
responses:
|
|
23814
|
+
'200':
|
|
23815
|
+
content:
|
|
23816
|
+
application/json:
|
|
23817
|
+
schema:
|
|
23818
|
+
$ref: '#/components/schemas/ProjectResponse'
|
|
23819
|
+
description: OK
|
|
23820
|
+
'400':
|
|
23821
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23822
|
+
'401':
|
|
23823
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23824
|
+
'403':
|
|
23825
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23826
|
+
'404':
|
|
23827
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23828
|
+
'429':
|
|
23829
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23830
|
+
security:
|
|
23831
|
+
- apiKeyAuth: []
|
|
23832
|
+
appKeyAuth: []
|
|
23833
|
+
- AuthZ:
|
|
23834
|
+
- cases_read
|
|
23835
|
+
summary: Get the details of a project
|
|
23836
|
+
tags:
|
|
23837
|
+
- Case Management
|
|
23838
|
+
/api/v2/cases/{case_id}:
|
|
23839
|
+
get:
|
|
23840
|
+
description: Get the details of case by `case_id`
|
|
23841
|
+
operationId: GetCase
|
|
23842
|
+
parameters:
|
|
23843
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
23844
|
+
responses:
|
|
23845
|
+
'200':
|
|
23846
|
+
content:
|
|
23847
|
+
application/json:
|
|
23848
|
+
schema:
|
|
23849
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
23850
|
+
description: OK
|
|
23851
|
+
'400':
|
|
23852
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23853
|
+
'401':
|
|
23854
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23855
|
+
'403':
|
|
23856
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23857
|
+
'404':
|
|
23858
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23859
|
+
'429':
|
|
23860
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23861
|
+
security:
|
|
23862
|
+
- apiKeyAuth: []
|
|
23863
|
+
appKeyAuth: []
|
|
23864
|
+
- AuthZ:
|
|
23865
|
+
- cases_read
|
|
23866
|
+
summary: Get the details of a case
|
|
23867
|
+
tags:
|
|
23868
|
+
- Case Management
|
|
23869
|
+
/api/v2/cases/{case_id}/archive:
|
|
23870
|
+
post:
|
|
23871
|
+
description: Archive case
|
|
23872
|
+
operationId: ArchiveCase
|
|
23873
|
+
parameters:
|
|
23874
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
21566
23875
|
requestBody:
|
|
21567
23876
|
content:
|
|
21568
23877
|
application/json:
|
|
21569
23878
|
schema:
|
|
21570
|
-
$ref: '#/components/schemas/
|
|
23879
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
|
23880
|
+
description: Archive case payload
|
|
21571
23881
|
required: true
|
|
21572
23882
|
responses:
|
|
21573
23883
|
'200':
|
|
21574
23884
|
content:
|
|
21575
23885
|
application/json:
|
|
21576
23886
|
schema:
|
|
21577
|
-
$ref: '#/components/schemas/
|
|
23887
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
21578
23888
|
description: OK
|
|
21579
23889
|
'400':
|
|
23890
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23891
|
+
'401':
|
|
23892
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23893
|
+
'403':
|
|
23894
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23895
|
+
'404':
|
|
23896
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23897
|
+
'429':
|
|
23898
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23899
|
+
security:
|
|
23900
|
+
- apiKeyAuth: []
|
|
23901
|
+
appKeyAuth: []
|
|
23902
|
+
- AuthZ:
|
|
23903
|
+
- cases_write
|
|
23904
|
+
summary: Archive case
|
|
23905
|
+
tags:
|
|
23906
|
+
- Case Management
|
|
23907
|
+
/api/v2/cases/{case_id}/assign:
|
|
23908
|
+
post:
|
|
23909
|
+
description: Assign case to a user
|
|
23910
|
+
operationId: AssignCase
|
|
23911
|
+
parameters:
|
|
23912
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
23913
|
+
requestBody:
|
|
23914
|
+
content:
|
|
23915
|
+
application/json:
|
|
23916
|
+
schema:
|
|
23917
|
+
$ref: '#/components/schemas/CaseAssignRequest'
|
|
23918
|
+
description: Assign case payload
|
|
23919
|
+
required: true
|
|
23920
|
+
responses:
|
|
23921
|
+
'200':
|
|
21580
23922
|
content:
|
|
21581
23923
|
application/json:
|
|
21582
23924
|
schema:
|
|
21583
|
-
$ref: '#/components/schemas/
|
|
21584
|
-
description:
|
|
23925
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
23926
|
+
description: OK
|
|
23927
|
+
'400':
|
|
23928
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23929
|
+
'401':
|
|
23930
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
21585
23931
|
'403':
|
|
23932
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23933
|
+
'404':
|
|
23934
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23935
|
+
'429':
|
|
23936
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23937
|
+
security:
|
|
23938
|
+
- apiKeyAuth: []
|
|
23939
|
+
appKeyAuth: []
|
|
23940
|
+
- AuthZ:
|
|
23941
|
+
- cases_write
|
|
23942
|
+
summary: Assign case
|
|
23943
|
+
tags:
|
|
23944
|
+
- Case Management
|
|
23945
|
+
/api/v2/cases/{case_id}/priority:
|
|
23946
|
+
post:
|
|
23947
|
+
description: Update case priority
|
|
23948
|
+
operationId: UpdatePriority
|
|
23949
|
+
parameters:
|
|
23950
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
23951
|
+
requestBody:
|
|
23952
|
+
content:
|
|
23953
|
+
application/json:
|
|
23954
|
+
schema:
|
|
23955
|
+
$ref: '#/components/schemas/CaseUpdatePriorityRequest'
|
|
23956
|
+
description: Case priority update payload
|
|
23957
|
+
required: true
|
|
23958
|
+
responses:
|
|
23959
|
+
'200':
|
|
21586
23960
|
content:
|
|
21587
23961
|
application/json:
|
|
21588
23962
|
schema:
|
|
21589
|
-
$ref: '#/components/schemas/
|
|
21590
|
-
description:
|
|
23963
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
23964
|
+
description: OK
|
|
23965
|
+
'400':
|
|
23966
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23967
|
+
'401':
|
|
23968
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23969
|
+
'403':
|
|
23970
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
21591
23971
|
'404':
|
|
23972
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23973
|
+
'429':
|
|
23974
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23975
|
+
security:
|
|
23976
|
+
- apiKeyAuth: []
|
|
23977
|
+
appKeyAuth: []
|
|
23978
|
+
- AuthZ:
|
|
23979
|
+
- cases_write
|
|
23980
|
+
summary: Update case priority
|
|
23981
|
+
tags:
|
|
23982
|
+
- Case Management
|
|
23983
|
+
/api/v2/cases/{case_id}/status:
|
|
23984
|
+
post:
|
|
23985
|
+
description: Update case status
|
|
23986
|
+
operationId: UpdateStatus
|
|
23987
|
+
parameters:
|
|
23988
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
23989
|
+
requestBody:
|
|
23990
|
+
content:
|
|
23991
|
+
application/json:
|
|
23992
|
+
schema:
|
|
23993
|
+
$ref: '#/components/schemas/CaseUpdateStatusRequest'
|
|
23994
|
+
description: Case status update payload
|
|
23995
|
+
required: true
|
|
23996
|
+
responses:
|
|
23997
|
+
'200':
|
|
21592
23998
|
content:
|
|
21593
23999
|
application/json:
|
|
21594
24000
|
schema:
|
|
21595
|
-
$ref: '#/components/schemas/
|
|
21596
|
-
description:
|
|
21597
|
-
'
|
|
24001
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24002
|
+
description: OK
|
|
24003
|
+
'400':
|
|
24004
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24005
|
+
'401':
|
|
24006
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24007
|
+
'403':
|
|
24008
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24009
|
+
'404':
|
|
24010
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24011
|
+
'429':
|
|
24012
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24013
|
+
security:
|
|
24014
|
+
- apiKeyAuth: []
|
|
24015
|
+
appKeyAuth: []
|
|
24016
|
+
- AuthZ:
|
|
24017
|
+
- cases_write
|
|
24018
|
+
summary: Update case status
|
|
24019
|
+
tags:
|
|
24020
|
+
- Case Management
|
|
24021
|
+
/api/v2/cases/{case_id}/unarchive:
|
|
24022
|
+
post:
|
|
24023
|
+
description: Unarchive case
|
|
24024
|
+
operationId: UnarchiveCase
|
|
24025
|
+
parameters:
|
|
24026
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24027
|
+
requestBody:
|
|
24028
|
+
content:
|
|
24029
|
+
application/json:
|
|
24030
|
+
schema:
|
|
24031
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
|
24032
|
+
description: Unarchive case payload
|
|
24033
|
+
required: true
|
|
24034
|
+
responses:
|
|
24035
|
+
'200':
|
|
21598
24036
|
content:
|
|
21599
24037
|
application/json:
|
|
21600
24038
|
schema:
|
|
21601
|
-
$ref: '#/components/schemas/
|
|
21602
|
-
description:
|
|
21603
|
-
'
|
|
24039
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24040
|
+
description: OK
|
|
24041
|
+
'400':
|
|
24042
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24043
|
+
'401':
|
|
24044
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24045
|
+
'403':
|
|
24046
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24047
|
+
'404':
|
|
24048
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24049
|
+
'429':
|
|
24050
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24051
|
+
security:
|
|
24052
|
+
- apiKeyAuth: []
|
|
24053
|
+
appKeyAuth: []
|
|
24054
|
+
- AuthZ:
|
|
24055
|
+
- cases_write
|
|
24056
|
+
summary: Unarchive case
|
|
24057
|
+
tags:
|
|
24058
|
+
- Case Management
|
|
24059
|
+
/api/v2/cases/{case_id}/unassign:
|
|
24060
|
+
post:
|
|
24061
|
+
description: Unassign case
|
|
24062
|
+
operationId: UnassignCase
|
|
24063
|
+
parameters:
|
|
24064
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24065
|
+
requestBody:
|
|
24066
|
+
content:
|
|
24067
|
+
application/json:
|
|
24068
|
+
schema:
|
|
24069
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
|
24070
|
+
description: Unassign case payload
|
|
24071
|
+
required: true
|
|
24072
|
+
responses:
|
|
24073
|
+
'200':
|
|
21604
24074
|
content:
|
|
21605
24075
|
application/json:
|
|
21606
24076
|
schema:
|
|
21607
|
-
$ref: '#/components/schemas/
|
|
21608
|
-
description:
|
|
24077
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24078
|
+
description: OK
|
|
24079
|
+
'400':
|
|
24080
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24081
|
+
'401':
|
|
24082
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24083
|
+
'403':
|
|
24084
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24085
|
+
'404':
|
|
24086
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
21609
24087
|
'429':
|
|
21610
24088
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
21611
24089
|
security:
|
|
21612
24090
|
- apiKeyAuth: []
|
|
21613
24091
|
appKeyAuth: []
|
|
21614
24092
|
- AuthZ:
|
|
21615
|
-
-
|
|
21616
|
-
summary:
|
|
24093
|
+
- cases_write
|
|
24094
|
+
summary: Unassign case
|
|
21617
24095
|
tags:
|
|
21618
|
-
-
|
|
21619
|
-
x-codegen-request-body-name: body
|
|
21620
|
-
x-permission: OR(USER_ACCESS_MANAGE)
|
|
24096
|
+
- Case Management
|
|
21621
24097
|
/api/v2/ci/pipeline:
|
|
21622
24098
|
post:
|
|
21623
24099
|
description: 'Send your pipeline event to your Datadog platform over HTTP. For
|
|
@@ -21890,8 +24366,8 @@ paths:
|
|
|
21890
24366
|
x-codegen-request-body-name: body
|
|
21891
24367
|
/api/v2/ci/tests/events:
|
|
21892
24368
|
get:
|
|
21893
|
-
description: 'List endpoint returns CI Visibility test events that match a [
|
|
21894
|
-
|
|
24369
|
+
description: 'List endpoint returns CI Visibility test events that match a [search
|
|
24370
|
+
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
21895
24371
|
|
|
21896
24372
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
21897
24373
|
|
|
@@ -21974,8 +24450,8 @@ paths:
|
|
|
21974
24450
|
resultsPath: data
|
|
21975
24451
|
/api/v2/ci/tests/events/search:
|
|
21976
24452
|
post:
|
|
21977
|
-
description: 'List endpoint returns CI Visibility test events that match a [
|
|
21978
|
-
|
|
24453
|
+
description: 'List endpoint returns CI Visibility test events that match a [search
|
|
24454
|
+
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
21979
24455
|
|
|
21980
24456
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
21981
24457
|
|
|
@@ -22497,7 +24973,7 @@ paths:
|
|
|
22497
24973
|
/api/v2/cost_by_tag/active_billing_dimensions:
|
|
22498
24974
|
get:
|
|
22499
24975
|
description: Get active billing dimensions for cost attribution. Cost data for
|
|
22500
|
-
a given month becomes available no later than the
|
|
24976
|
+
a given month becomes available no later than the 19th of the following month.
|
|
22501
24977
|
operationId: GetActiveBillingDimensions
|
|
22502
24978
|
responses:
|
|
22503
24979
|
'200':
|
|
@@ -22527,7 +25003,8 @@ paths:
|
|
|
22527
25003
|
security:
|
|
22528
25004
|
- apiKeyAuth: []
|
|
22529
25005
|
appKeyAuth: []
|
|
22530
|
-
- AuthZ:
|
|
25006
|
+
- AuthZ:
|
|
25007
|
+
- usage_read
|
|
22531
25008
|
summary: Get active billing dimensions for cost attribution
|
|
22532
25009
|
tags:
|
|
22533
25010
|
- Usage Metering
|
|
@@ -22538,7 +25015,7 @@ paths:
|
|
|
22538
25015
|
get:
|
|
22539
25016
|
description: "Get monthly cost attribution by tag across multi-org and single
|
|
22540
25017
|
root-org accounts.\nCost Attribution data for a given month becomes available
|
|
22541
|
-
no later than the
|
|
25018
|
+
no later than the 19th of the following month.\nThis API endpoint is paginated.
|
|
22542
25019
|
To make sure you receive all records, check if the value of `next_record_id`
|
|
22543
25020
|
is\nset in the response. If it is, make another request and pass `next_record_id`
|
|
22544
25021
|
as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month,
|
|
@@ -22648,7 +25125,8 @@ paths:
|
|
|
22648
25125
|
security:
|
|
22649
25126
|
- apiKeyAuth: []
|
|
22650
25127
|
appKeyAuth: []
|
|
22651
|
-
- AuthZ:
|
|
25128
|
+
- AuthZ:
|
|
25129
|
+
- usage_read
|
|
22652
25130
|
summary: Get Monthly Cost Attribution
|
|
22653
25131
|
tags:
|
|
22654
25132
|
- Usage Metering
|
|
@@ -25896,6 +28374,135 @@ paths:
|
|
|
25896
28374
|
tags:
|
|
25897
28375
|
- Logs Archives
|
|
25898
28376
|
x-codegen-request-body-name: body
|
|
28377
|
+
/api/v2/logs/config/custom-destinations:
|
|
28378
|
+
get:
|
|
28379
|
+
description: Get the list of configured custom destinations in your organization
|
|
28380
|
+
with their definitions.
|
|
28381
|
+
operationId: ListLogsCustomDestinations
|
|
28382
|
+
responses:
|
|
28383
|
+
'200':
|
|
28384
|
+
content:
|
|
28385
|
+
application/json:
|
|
28386
|
+
schema:
|
|
28387
|
+
$ref: '#/components/schemas/CustomDestinationsResponse'
|
|
28388
|
+
description: OK
|
|
28389
|
+
'403':
|
|
28390
|
+
content:
|
|
28391
|
+
application/json:
|
|
28392
|
+
schema:
|
|
28393
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
28394
|
+
description: Forbidden
|
|
28395
|
+
'429':
|
|
28396
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28397
|
+
summary: Get all custom destinations
|
|
28398
|
+
tags:
|
|
28399
|
+
- Logs Custom Destinations
|
|
28400
|
+
post:
|
|
28401
|
+
description: Create a custom destination in your organization.
|
|
28402
|
+
operationId: CreateLogsCustomDestination
|
|
28403
|
+
requestBody:
|
|
28404
|
+
content:
|
|
28405
|
+
application/json:
|
|
28406
|
+
schema:
|
|
28407
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequest'
|
|
28408
|
+
description: The definition of the new custom destination.
|
|
28409
|
+
required: true
|
|
28410
|
+
responses:
|
|
28411
|
+
'200':
|
|
28412
|
+
content:
|
|
28413
|
+
application/json:
|
|
28414
|
+
schema:
|
|
28415
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
|
28416
|
+
description: OK
|
|
28417
|
+
'400':
|
|
28418
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28419
|
+
'403':
|
|
28420
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28421
|
+
'409':
|
|
28422
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
28423
|
+
'429':
|
|
28424
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28425
|
+
summary: Create a custom destination
|
|
28426
|
+
tags:
|
|
28427
|
+
- Logs Custom Destinations
|
|
28428
|
+
x-codegen-request-body-name: body
|
|
28429
|
+
/api/v2/logs/config/custom-destinations/{custom_destination_id}:
|
|
28430
|
+
delete:
|
|
28431
|
+
description: Delete a specific custom destination in your organization.
|
|
28432
|
+
operationId: DeleteLogsCustomDestination
|
|
28433
|
+
parameters:
|
|
28434
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
|
28435
|
+
responses:
|
|
28436
|
+
'204':
|
|
28437
|
+
description: OK
|
|
28438
|
+
'400':
|
|
28439
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28440
|
+
'403':
|
|
28441
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28442
|
+
'404':
|
|
28443
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
28444
|
+
'429':
|
|
28445
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28446
|
+
summary: Delete a custom destination
|
|
28447
|
+
tags:
|
|
28448
|
+
- Logs Custom Destinations
|
|
28449
|
+
get:
|
|
28450
|
+
description: Get a specific custom destination in your organization.
|
|
28451
|
+
operationId: GetLogsCustomDestination
|
|
28452
|
+
parameters:
|
|
28453
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
|
28454
|
+
responses:
|
|
28455
|
+
'200':
|
|
28456
|
+
content:
|
|
28457
|
+
application/json:
|
|
28458
|
+
schema:
|
|
28459
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
|
28460
|
+
description: OK
|
|
28461
|
+
'400':
|
|
28462
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28463
|
+
'403':
|
|
28464
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28465
|
+
'404':
|
|
28466
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
28467
|
+
'429':
|
|
28468
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28469
|
+
summary: Get a custom destination
|
|
28470
|
+
tags:
|
|
28471
|
+
- Logs Custom Destinations
|
|
28472
|
+
patch:
|
|
28473
|
+
description: Update the given fields of a specific custom destination in your
|
|
28474
|
+
organization.
|
|
28475
|
+
operationId: UpdateLogsCustomDestination
|
|
28476
|
+
parameters:
|
|
28477
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
|
28478
|
+
requestBody:
|
|
28479
|
+
content:
|
|
28480
|
+
application/json:
|
|
28481
|
+
schema:
|
|
28482
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequest'
|
|
28483
|
+
description: New definition of the custom destination's fields.
|
|
28484
|
+
required: true
|
|
28485
|
+
responses:
|
|
28486
|
+
'200':
|
|
28487
|
+
content:
|
|
28488
|
+
application/json:
|
|
28489
|
+
schema:
|
|
28490
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
|
28491
|
+
description: OK
|
|
28492
|
+
'400':
|
|
28493
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28494
|
+
'403':
|
|
28495
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28496
|
+
'404':
|
|
28497
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
28498
|
+
'409':
|
|
28499
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
28500
|
+
'429':
|
|
28501
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28502
|
+
summary: Update a custom destination
|
|
28503
|
+
tags:
|
|
28504
|
+
- Logs Custom Destinations
|
|
28505
|
+
x-codegen-request-body-name: body
|
|
25899
28506
|
/api/v2/logs/config/metrics:
|
|
25900
28507
|
get:
|
|
25901
28508
|
description: Get the list of configured log-based metrics with their definitions.
|
|
@@ -26509,6 +29116,51 @@ paths:
|
|
|
26509
29116
|
summary: List tags by metric name
|
|
26510
29117
|
tags:
|
|
26511
29118
|
- Metrics
|
|
29119
|
+
/api/v2/metrics/{metric_name}/assets:
|
|
29120
|
+
get:
|
|
29121
|
+
description: Returns dashboards, monitors, notebooks, and SLOs that a metric
|
|
29122
|
+
is stored in, if any. Updated every 24 hours.
|
|
29123
|
+
operationId: ListMetricAssets
|
|
29124
|
+
parameters:
|
|
29125
|
+
- $ref: '#/components/parameters/MetricName'
|
|
29126
|
+
responses:
|
|
29127
|
+
'200':
|
|
29128
|
+
content:
|
|
29129
|
+
application/json:
|
|
29130
|
+
schema:
|
|
29131
|
+
$ref: '#/components/schemas/MetricAssetsResponse'
|
|
29132
|
+
description: Success
|
|
29133
|
+
'400':
|
|
29134
|
+
content:
|
|
29135
|
+
application/json:
|
|
29136
|
+
schema:
|
|
29137
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29138
|
+
description: API error response.
|
|
29139
|
+
'403':
|
|
29140
|
+
content:
|
|
29141
|
+
application/json:
|
|
29142
|
+
schema:
|
|
29143
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29144
|
+
description: API error response.
|
|
29145
|
+
'404':
|
|
29146
|
+
content:
|
|
29147
|
+
application/json:
|
|
29148
|
+
schema:
|
|
29149
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29150
|
+
description: API error response.
|
|
29151
|
+
'429':
|
|
29152
|
+
content:
|
|
29153
|
+
application/json:
|
|
29154
|
+
schema:
|
|
29155
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29156
|
+
description: Too Many Requests
|
|
29157
|
+
security:
|
|
29158
|
+
- apiKeyAuth: []
|
|
29159
|
+
appKeyAuth: []
|
|
29160
|
+
- AuthZ: []
|
|
29161
|
+
summary: Related Assets to a Metric
|
|
29162
|
+
tags:
|
|
29163
|
+
- Metrics
|
|
26512
29164
|
/api/v2/metrics/{metric_name}/estimate:
|
|
26513
29165
|
get:
|
|
26514
29166
|
description: Returns the estimated cardinality for a metric with a given tag,
|
|
@@ -26525,7 +29177,8 @@ paths:
|
|
|
26525
29177
|
schema:
|
|
26526
29178
|
type: string
|
|
26527
29179
|
- description: The number of hours of look back (from now) to estimate cardinality
|
|
26528
|
-
with.
|
|
29180
|
+
with. Estimates are based on historical data, and unspecified fields default
|
|
29181
|
+
to the minimum 49 hours.
|
|
26529
29182
|
example: 49
|
|
26530
29183
|
in: query
|
|
26531
29184
|
name: filter[hours_ago]
|
|
@@ -26533,6 +29186,7 @@ paths:
|
|
|
26533
29186
|
schema:
|
|
26534
29187
|
format: int32
|
|
26535
29188
|
maximum: 2147483647
|
|
29189
|
+
minimum: 49
|
|
26536
29190
|
type: integer
|
|
26537
29191
|
- description: The number of aggregations that a `count`, `rate`, or `gauge`
|
|
26538
29192
|
metric is configured to use. Max number of aggregation combos is 9.
|
|
@@ -26600,19 +29254,6 @@ paths:
|
|
|
26600
29254
|
summary: Tag Configuration Cardinality Estimator
|
|
26601
29255
|
tags:
|
|
26602
29256
|
- Metrics
|
|
26603
|
-
x-dd-ownership:
|
|
26604
|
-
notification_configuration:
|
|
26605
|
-
manual_escalation_policy: '[Points Aggregation] Primary'
|
|
26606
|
-
prod_high_urgency: '@pagerduty-Points-Aggregation @slack-points-aggr-ops'
|
|
26607
|
-
prod_low_urgency: '@slack-points-aggr-ops'
|
|
26608
|
-
slack_support_channel: '#points-aggregation'
|
|
26609
|
-
staging_high_urgency: '@slack-points-aggr-stg-ops'
|
|
26610
|
-
staging_low_urgency: '@slack-points-aggr-stg-ops'
|
|
26611
|
-
team: points-aggregation
|
|
26612
|
-
team_escalation: '[Points Aggregation] Primary'
|
|
26613
|
-
x-permission:
|
|
26614
|
-
operator: OPEN
|
|
26615
|
-
permissions: []
|
|
26616
29257
|
/api/v2/metrics/{metric_name}/tags:
|
|
26617
29258
|
delete:
|
|
26618
29259
|
description: 'Deletes a metric''s tag configuration. Can only be used with application
|
|
@@ -27723,6 +30364,154 @@ paths:
|
|
|
27723
30364
|
We are gradually onboarding support for more sources. If you have any
|
|
27724
30365
|
|
|
27725
30366
|
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
|
30367
|
+
/api/v2/remote_config/products/cws/agent_rules:
|
|
30368
|
+
get:
|
|
30369
|
+
description: Get the list of Cloud Security Management Threats Agent rules.
|
|
30370
|
+
operationId: ListCSMThreatsAgentRules
|
|
30371
|
+
responses:
|
|
30372
|
+
'200':
|
|
30373
|
+
content:
|
|
30374
|
+
application/json:
|
|
30375
|
+
schema:
|
|
30376
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse'
|
|
30377
|
+
description: OK
|
|
30378
|
+
'403':
|
|
30379
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30380
|
+
'429':
|
|
30381
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30382
|
+
summary: Get all CSM Threats Agent rules
|
|
30383
|
+
tags:
|
|
30384
|
+
- Cloud Workload Security
|
|
30385
|
+
post:
|
|
30386
|
+
description: Create a new Cloud Security Management Threats Agent rule with
|
|
30387
|
+
the given parameters.
|
|
30388
|
+
operationId: CreateCSMThreatsAgentRule
|
|
30389
|
+
requestBody:
|
|
30390
|
+
content:
|
|
30391
|
+
application/json:
|
|
30392
|
+
schema:
|
|
30393
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest'
|
|
30394
|
+
description: The definition of the new Agent rule.
|
|
30395
|
+
required: true
|
|
30396
|
+
responses:
|
|
30397
|
+
'200':
|
|
30398
|
+
content:
|
|
30399
|
+
application/json:
|
|
30400
|
+
schema:
|
|
30401
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
|
30402
|
+
description: OK
|
|
30403
|
+
'400':
|
|
30404
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
30405
|
+
'403':
|
|
30406
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30407
|
+
'409':
|
|
30408
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
30409
|
+
'429':
|
|
30410
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30411
|
+
summary: Create a CSM Threats Agent rule
|
|
30412
|
+
tags:
|
|
30413
|
+
- Cloud Workload Security
|
|
30414
|
+
x-codegen-request-body-name: body
|
|
30415
|
+
/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}:
|
|
30416
|
+
delete:
|
|
30417
|
+
description: Delete a specific Cloud Security Management Threats Agent rule.
|
|
30418
|
+
operationId: DeleteCSMThreatsAgentRule
|
|
30419
|
+
parameters:
|
|
30420
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
|
30421
|
+
responses:
|
|
30422
|
+
'204':
|
|
30423
|
+
description: OK
|
|
30424
|
+
'403':
|
|
30425
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30426
|
+
'404':
|
|
30427
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
30428
|
+
'429':
|
|
30429
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30430
|
+
summary: Delete a CSM Threats Agent rule
|
|
30431
|
+
tags:
|
|
30432
|
+
- Cloud Workload Security
|
|
30433
|
+
get:
|
|
30434
|
+
description: Get the details of a specific Cloud Security Management Threats
|
|
30435
|
+
Agent rule.
|
|
30436
|
+
operationId: GetCSMThreatsAgentRule
|
|
30437
|
+
parameters:
|
|
30438
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
|
30439
|
+
responses:
|
|
30440
|
+
'200':
|
|
30441
|
+
content:
|
|
30442
|
+
application/json:
|
|
30443
|
+
schema:
|
|
30444
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
|
30445
|
+
description: OK
|
|
30446
|
+
'403':
|
|
30447
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30448
|
+
'404':
|
|
30449
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
30450
|
+
'429':
|
|
30451
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30452
|
+
summary: Get a CSM Threats Agent rule
|
|
30453
|
+
tags:
|
|
30454
|
+
- Cloud Workload Security
|
|
30455
|
+
patch:
|
|
30456
|
+
description: 'Update a specific Cloud Security Management Threats Agent rule.
|
|
30457
|
+
|
|
30458
|
+
Returns the Agent rule object when the request is successful.'
|
|
30459
|
+
operationId: UpdateCSMThreatsAgentRule
|
|
30460
|
+
parameters:
|
|
30461
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
|
30462
|
+
requestBody:
|
|
30463
|
+
content:
|
|
30464
|
+
application/json:
|
|
30465
|
+
schema:
|
|
30466
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest'
|
|
30467
|
+
description: New definition of the Agent rule.
|
|
30468
|
+
required: true
|
|
30469
|
+
responses:
|
|
30470
|
+
'200':
|
|
30471
|
+
content:
|
|
30472
|
+
application/json:
|
|
30473
|
+
schema:
|
|
30474
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
|
30475
|
+
description: OK
|
|
30476
|
+
'400':
|
|
30477
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
30478
|
+
'403':
|
|
30479
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30480
|
+
'404':
|
|
30481
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
30482
|
+
'409':
|
|
30483
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
|
30484
|
+
'429':
|
|
30485
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30486
|
+
summary: Update a CSM Threats Agent rule
|
|
30487
|
+
tags:
|
|
30488
|
+
- Cloud Workload Security
|
|
30489
|
+
x-codegen-request-body-name: body
|
|
30490
|
+
/api/v2/remote_config/products/cws/policy/download:
|
|
30491
|
+
get:
|
|
30492
|
+
description: 'The download endpoint generates a CSM Threats policy file from
|
|
30493
|
+
your currently active
|
|
30494
|
+
|
|
30495
|
+
CSM Threats rules, and downloads them as a `.policy` file. This file can then
|
|
30496
|
+
be deployed to
|
|
30497
|
+
|
|
30498
|
+
your Agents to update the policy running in your environment.'
|
|
30499
|
+
operationId: DownloadCSMThreatsPolicy
|
|
30500
|
+
responses:
|
|
30501
|
+
'200':
|
|
30502
|
+
content:
|
|
30503
|
+
application/zip:
|
|
30504
|
+
schema:
|
|
30505
|
+
format: binary
|
|
30506
|
+
type: string
|
|
30507
|
+
description: OK
|
|
30508
|
+
'403':
|
|
30509
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30510
|
+
'429':
|
|
30511
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30512
|
+
summary: Get the latest CSM Threats policy
|
|
30513
|
+
tags:
|
|
30514
|
+
- Cloud Workload Security
|
|
27726
30515
|
/api/v2/restriction_policy/{resource_id}:
|
|
27727
30516
|
delete:
|
|
27728
30517
|
description: Deletes the restriction policy associated with a specified resource.
|
|
@@ -28825,10 +31614,9 @@ paths:
|
|
|
28825
31614
|
tags:
|
|
28826
31615
|
- Service Scorecards
|
|
28827
31616
|
x-codegen-request-body-name: body
|
|
28828
|
-
x-unstable: '**Note**: This endpoint is in
|
|
28829
|
-
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
|
31617
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
28830
31618
|
|
|
28831
|
-
|
|
31619
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
28832
31620
|
/api/v2/scorecard/rules:
|
|
28833
31621
|
get:
|
|
28834
31622
|
description: Fetch all rules.
|
|
@@ -28953,10 +31741,9 @@ paths:
|
|
|
28953
31741
|
tags:
|
|
28954
31742
|
- Service Scorecards
|
|
28955
31743
|
x-codegen-request-body-name: body
|
|
28956
|
-
x-unstable: '**Note**: This endpoint is in
|
|
28957
|
-
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
|
31744
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
28958
31745
|
|
|
28959
|
-
|
|
31746
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
28960
31747
|
/api/v2/scorecard/rules/{rule_id}:
|
|
28961
31748
|
delete:
|
|
28962
31749
|
description: Deletes a single rule.
|
|
@@ -28982,10 +31769,9 @@ paths:
|
|
|
28982
31769
|
summary: Delete a rule
|
|
28983
31770
|
tags:
|
|
28984
31771
|
- Service Scorecards
|
|
28985
|
-
x-unstable: '**Note**: This endpoint is in
|
|
28986
|
-
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
|
31772
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
28987
31773
|
|
|
28988
|
-
|
|
31774
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
28989
31775
|
/api/v2/security/cloud_workload/policy/download:
|
|
28990
31776
|
get:
|
|
28991
31777
|
description: 'The download endpoint generates a Cloud Workload Security policy
|
|
@@ -29288,6 +32074,149 @@ paths:
|
|
|
29288
32074
|
tags:
|
|
29289
32075
|
- Security Monitoring
|
|
29290
32076
|
x-codegen-request-body-name: body
|
|
32077
|
+
/api/v2/security_monitoring/configuration/suppressions:
|
|
32078
|
+
get:
|
|
32079
|
+
description: Get the list of all suppression rules.
|
|
32080
|
+
operationId: ListSecurityMonitoringSuppressions
|
|
32081
|
+
responses:
|
|
32082
|
+
'200':
|
|
32083
|
+
content:
|
|
32084
|
+
application/json:
|
|
32085
|
+
schema:
|
|
32086
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
|
|
32087
|
+
description: OK
|
|
32088
|
+
'403':
|
|
32089
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
32090
|
+
'429':
|
|
32091
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32092
|
+
security:
|
|
32093
|
+
- apiKeyAuth: []
|
|
32094
|
+
appKeyAuth: []
|
|
32095
|
+
- AuthZ:
|
|
32096
|
+
- security_monitoring_suppressions_read
|
|
32097
|
+
summary: Get all suppression rules
|
|
32098
|
+
tags:
|
|
32099
|
+
- Security Monitoring
|
|
32100
|
+
post:
|
|
32101
|
+
description: Create a new suppression rule.
|
|
32102
|
+
operationId: CreateSecurityMonitoringSuppression
|
|
32103
|
+
requestBody:
|
|
32104
|
+
content:
|
|
32105
|
+
application/json:
|
|
32106
|
+
schema:
|
|
32107
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest'
|
|
32108
|
+
description: The definition of the new suppression rule.
|
|
32109
|
+
required: true
|
|
32110
|
+
responses:
|
|
32111
|
+
'200':
|
|
32112
|
+
content:
|
|
32113
|
+
application/json:
|
|
32114
|
+
schema:
|
|
32115
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
|
|
32116
|
+
description: OK
|
|
32117
|
+
'400':
|
|
32118
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
32119
|
+
'403':
|
|
32120
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
32121
|
+
'409':
|
|
32122
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
32123
|
+
'429':
|
|
32124
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32125
|
+
security:
|
|
32126
|
+
- apiKeyAuth: []
|
|
32127
|
+
appKeyAuth: []
|
|
32128
|
+
- AuthZ:
|
|
32129
|
+
- security_monitoring_suppressions_write
|
|
32130
|
+
summary: Create a suppression rule
|
|
32131
|
+
tags:
|
|
32132
|
+
- Security Monitoring
|
|
32133
|
+
x-codegen-request-body-name: body
|
|
32134
|
+
/api/v2/security_monitoring/configuration/suppressions/{suppression_id}:
|
|
32135
|
+
delete:
|
|
32136
|
+
description: Delete a specific suppression rule.
|
|
32137
|
+
operationId: DeleteSecurityMonitoringSuppression
|
|
32138
|
+
parameters:
|
|
32139
|
+
- $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
|
|
32140
|
+
responses:
|
|
32141
|
+
'204':
|
|
32142
|
+
description: OK
|
|
32143
|
+
'403':
|
|
32144
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
32145
|
+
'404':
|
|
32146
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
32147
|
+
'429':
|
|
32148
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32149
|
+
security:
|
|
32150
|
+
- apiKeyAuth: []
|
|
32151
|
+
appKeyAuth: []
|
|
32152
|
+
- AuthZ:
|
|
32153
|
+
- security_monitoring_suppressions_write
|
|
32154
|
+
summary: Delete a suppression rule
|
|
32155
|
+
tags:
|
|
32156
|
+
- Security Monitoring
|
|
32157
|
+
get:
|
|
32158
|
+
description: Get the details of a specific suppression rule.
|
|
32159
|
+
operationId: GetSecurityMonitoringSuppression
|
|
32160
|
+
parameters:
|
|
32161
|
+
- $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
|
|
32162
|
+
responses:
|
|
32163
|
+
'200':
|
|
32164
|
+
content:
|
|
32165
|
+
application/json:
|
|
32166
|
+
schema:
|
|
32167
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
|
|
32168
|
+
description: OK
|
|
32169
|
+
'403':
|
|
32170
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
32171
|
+
'404':
|
|
32172
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
32173
|
+
'429':
|
|
32174
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32175
|
+
security:
|
|
32176
|
+
- apiKeyAuth: []
|
|
32177
|
+
appKeyAuth: []
|
|
32178
|
+
- AuthZ:
|
|
32179
|
+
- security_monitoring_suppressions_read
|
|
32180
|
+
summary: Get a suppression rule
|
|
32181
|
+
tags:
|
|
32182
|
+
- Security Monitoring
|
|
32183
|
+
patch:
|
|
32184
|
+
description: Update a specific suppression rule.
|
|
32185
|
+
operationId: UpdateSecurityMonitoringSuppression
|
|
32186
|
+
parameters:
|
|
32187
|
+
- $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
|
|
32188
|
+
requestBody:
|
|
32189
|
+
content:
|
|
32190
|
+
application/json:
|
|
32191
|
+
schema:
|
|
32192
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateRequest'
|
|
32193
|
+
description: New definition of the suppression rule. Supports partial updates.
|
|
32194
|
+
required: true
|
|
32195
|
+
responses:
|
|
32196
|
+
'200':
|
|
32197
|
+
content:
|
|
32198
|
+
application/json:
|
|
32199
|
+
schema:
|
|
32200
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
|
|
32201
|
+
description: OK
|
|
32202
|
+
'400':
|
|
32203
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
32204
|
+
'403':
|
|
32205
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
32206
|
+
'404':
|
|
32207
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
32208
|
+
'409':
|
|
32209
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
|
32210
|
+
'429':
|
|
32211
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32212
|
+
security:
|
|
32213
|
+
- apiKeyAuth: []
|
|
32214
|
+
appKeyAuth: []
|
|
32215
|
+
- AuthZ:
|
|
32216
|
+
- security_monitoring_suppressions_write
|
|
32217
|
+
summary: Update a suppression rule
|
|
32218
|
+
tags:
|
|
32219
|
+
- Security Monitoring
|
|
29291
32220
|
/api/v2/security_monitoring/rules:
|
|
29292
32221
|
get:
|
|
29293
32222
|
description: List rules.
|
|
@@ -30350,6 +33279,7 @@ paths:
|
|
|
30350
33279
|
x-codegen-request-body-name: body
|
|
30351
33280
|
/api/v2/services:
|
|
30352
33281
|
get:
|
|
33282
|
+
deprecated: true
|
|
30353
33283
|
description: Get all incident services uploaded for the requesting user's organization.
|
|
30354
33284
|
If the `include[users]` query parameter is provided, the included attribute
|
|
30355
33285
|
will contain the users related to these incident services.
|
|
@@ -30384,10 +33314,9 @@ paths:
|
|
|
30384
33314
|
summary: Get a list of all incident services
|
|
30385
33315
|
tags:
|
|
30386
33316
|
- Incident Services
|
|
30387
|
-
x-unstable: '**Note**: This endpoint is
|
|
30388
|
-
|
|
30389
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33317
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
30390
33318
|
post:
|
|
33319
|
+
deprecated: true
|
|
30391
33320
|
description: Creates a new incident service.
|
|
30392
33321
|
operationId: CreateIncidentService
|
|
30393
33322
|
requestBody:
|
|
@@ -30423,9 +33352,7 @@ paths:
|
|
|
30423
33352
|
tags:
|
|
30424
33353
|
- Incident Services
|
|
30425
33354
|
x-codegen-request-body-name: body
|
|
30426
|
-
x-unstable: '**Note**: This endpoint is
|
|
30427
|
-
|
|
30428
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33355
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
30429
33356
|
/api/v2/services/definitions:
|
|
30430
33357
|
get:
|
|
30431
33358
|
description: Get a list of all service definitions from the Datadog Service
|
|
@@ -30456,7 +33383,7 @@ paths:
|
|
|
30456
33383
|
- Service Definition
|
|
30457
33384
|
x-pagination:
|
|
30458
33385
|
limitParam: page[size]
|
|
30459
|
-
|
|
33386
|
+
pageParam: page[number]
|
|
30460
33387
|
resultsPath: data
|
|
30461
33388
|
post:
|
|
30462
33389
|
description: Create or update service definition in the Datadog Service Catalog.
|
|
@@ -30550,6 +33477,7 @@ paths:
|
|
|
30550
33477
|
- Service Definition
|
|
30551
33478
|
/api/v2/services/{service_id}:
|
|
30552
33479
|
delete:
|
|
33480
|
+
deprecated: true
|
|
30553
33481
|
description: Deletes an existing incident service.
|
|
30554
33482
|
operationId: DeleteIncidentService
|
|
30555
33483
|
parameters:
|
|
@@ -30575,10 +33503,9 @@ paths:
|
|
|
30575
33503
|
summary: Delete an existing incident service
|
|
30576
33504
|
tags:
|
|
30577
33505
|
- Incident Services
|
|
30578
|
-
x-unstable: '**Note**: This endpoint is
|
|
30579
|
-
|
|
30580
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33506
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
30581
33507
|
get:
|
|
33508
|
+
deprecated: true
|
|
30582
33509
|
description: 'Get details of an incident service. If the `include[users]` query
|
|
30583
33510
|
parameter is provided,
|
|
30584
33511
|
|
|
@@ -30612,10 +33539,9 @@ paths:
|
|
|
30612
33539
|
summary: Get details of an incident service
|
|
30613
33540
|
tags:
|
|
30614
33541
|
- Incident Services
|
|
30615
|
-
x-unstable: '**Note**: This endpoint is
|
|
30616
|
-
|
|
30617
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33542
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
30618
33543
|
patch:
|
|
33544
|
+
deprecated: true
|
|
30619
33545
|
description: Updates an existing incident service. Only provide the attributes
|
|
30620
33546
|
which should be updated as this request is a partial update.
|
|
30621
33547
|
operationId: UpdateIncidentService
|
|
@@ -30654,9 +33580,7 @@ paths:
|
|
|
30654
33580
|
tags:
|
|
30655
33581
|
- Incident Services
|
|
30656
33582
|
x-codegen-request-body-name: body
|
|
30657
|
-
x-unstable: '**Note**: This endpoint is
|
|
30658
|
-
|
|
30659
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33583
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
30660
33584
|
/api/v2/spans/analytics/aggregate:
|
|
30661
33585
|
post:
|
|
30662
33586
|
description: 'The API endpoint to aggregate spans into buckets and compute metrics
|
|
@@ -31350,6 +34274,10 @@ paths:
|
|
|
31350
34274
|
summary: Get team memberships
|
|
31351
34275
|
tags:
|
|
31352
34276
|
- Teams
|
|
34277
|
+
x-pagination:
|
|
34278
|
+
limitParam: page[size]
|
|
34279
|
+
pageParam: page[number]
|
|
34280
|
+
resultsPath: data
|
|
31353
34281
|
post:
|
|
31354
34282
|
description: Add a user to a team.
|
|
31355
34283
|
operationId: CreateTeamMembership
|
|
@@ -32054,10 +34982,10 @@ paths:
|
|
|
32054
34982
|
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
|
|
32055
34983
|
|
|
32056
34984
|
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
|
|
32057
|
-
`cws`, `dbm`, `
|
|
34985
|
+
`cws`, `dbm`, `error_tracking`,
|
|
32058
34986
|
|
|
32059
|
-
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
|
|
32060
|
-
`iot`,
|
|
34987
|
+
`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
|
|
34988
|
+
`ingested_spans`, `iot`,
|
|
32061
34989
|
|
|
32062
34990
|
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `netflow_monitoring`,
|
|
32063
34991
|
`observability_pipelines`,
|
|
@@ -32154,7 +35082,7 @@ paths:
|
|
|
32154
35082
|
- Usage Metering
|
|
32155
35083
|
/api/v2/usage/lambda_traced_invocations:
|
|
32156
35084
|
get:
|
|
32157
|
-
description: 'Get hourly usage for
|
|
35085
|
+
description: 'Get hourly usage for Lambda traced invocations.
|
|
32158
35086
|
|
|
32159
35087
|
**Note:** hourly usage data for all products is now available in the [Get
|
|
32160
35088
|
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
|
@@ -32208,7 +35136,7 @@ paths:
|
|
|
32208
35136
|
appKeyAuth: []
|
|
32209
35137
|
- AuthZ:
|
|
32210
35138
|
- usage_read
|
|
32211
|
-
summary: Get hourly usage for
|
|
35139
|
+
summary: Get hourly usage for Lambda traced invocations
|
|
32212
35140
|
tags:
|
|
32213
35141
|
- Usage Metering
|
|
32214
35142
|
/api/v2/usage/observability_pipelines:
|
|
@@ -32792,44 +35720,68 @@ servers:
|
|
|
32792
35720
|
default: api
|
|
32793
35721
|
description: The subdomain where the API is deployed.
|
|
32794
35722
|
tags:
|
|
35723
|
+
- description: Configure your API endpoints through the Datadog API.
|
|
35724
|
+
name: API Management
|
|
32795
35725
|
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
|
|
32796
35726
|
for your organization. You need an API and application key with Admin rights to
|
|
32797
|
-
interact with this endpoint.
|
|
35727
|
+
interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)
|
|
35728
|
+
on the Trace Retention page for more information.
|
|
32798
35729
|
externalDocs:
|
|
32799
35730
|
description: Find out more at
|
|
32800
35731
|
url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
|
|
32801
35732
|
name: APM Retention Filters
|
|
32802
35733
|
- description: Search your Audit Logs events over HTTP.
|
|
32803
35734
|
name: Audit
|
|
32804
|
-
- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
|
35735
|
+
- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
|
32805
35736
|
|
|
32806
|
-
is used to automatically map
|
|
35737
|
+
is used to automatically map groups of users to roles in Datadog using attributes
|
|
32807
35738
|
|
|
32808
|
-
sent from Identity Providers.'
|
|
35739
|
+
sent from Identity Providers. Use these endpoints to manage your AuthN Mappings.'
|
|
32809
35740
|
name: AuthN Mappings
|
|
32810
35741
|
- description: Search or aggregate your CI Visibility pipeline events and send them
|
|
32811
|
-
to your Datadog site over HTTP.
|
|
35742
|
+
to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/)
|
|
35743
|
+
for more information.
|
|
32812
35744
|
name: CI Visibility Pipelines
|
|
32813
|
-
- description: Search or aggregate your CI Visibility test events over HTTP.
|
|
35745
|
+
- description: Search or aggregate your CI Visibility test events over HTTP. See the
|
|
35746
|
+
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
|
|
35747
|
+
information.
|
|
32814
35748
|
name: CI Visibility Tests
|
|
32815
|
-
- description:
|
|
32816
|
-
|
|
35749
|
+
- description: Cloud Security Management Threats (CSM Threats) monitors file, network,
|
|
35750
|
+
and process activity across your environment to detect real-time threats to your
|
|
35751
|
+
infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/)
|
|
35752
|
+
for more information on setting up CSM Threats.
|
|
35753
|
+
name: CSM Threats
|
|
35754
|
+
- description: View and manage cases and projects within Case Management. See the
|
|
35755
|
+
[Case Management page](https://docs.datadoghq.com/service_management/case_management/)
|
|
35756
|
+
for more information.
|
|
35757
|
+
name: Case Management
|
|
35758
|
+
- description: The Cloud Cost Management API allows you to set up, edit, and delete
|
|
35759
|
+
Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management
|
|
35760
|
+
page](https://docs.datadoghq.com/cloud_cost_management/) for more information.
|
|
32817
35761
|
name: Cloud Cost Management
|
|
32818
35762
|
- description: Workload activity security rules for generating events using the Datadog
|
|
32819
|
-
security Agent.
|
|
35763
|
+
security Agent. See the [Setting up CSM Workload Security page](https://docs.datadoghq.com/security/cloud_security_management/setup/csm_workload_security/)
|
|
35764
|
+
for more information.
|
|
32820
35765
|
name: Cloud Workload Security
|
|
32821
|
-
- description:
|
|
32822
|
-
|
|
35766
|
+
- description: Manage your Datadog Cloudflare integration directly through the Datadog
|
|
35767
|
+
API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
|
|
35768
|
+
for more information.
|
|
32823
35769
|
name: Cloudflare Integration
|
|
32824
|
-
- description:
|
|
32825
|
-
the Datadog API.
|
|
35770
|
+
- description: Manage your Datadog Confluent Cloud integration accounts and account
|
|
35771
|
+
resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/)
|
|
35772
|
+
for more information.
|
|
32826
35773
|
name: Confluent Cloud
|
|
32827
35774
|
- description: The Container Images API allows you to query Container Image data for
|
|
32828
|
-
your organization.
|
|
35775
|
+
your organization. See the [Container Images View page](https://docs.datadoghq.com/infrastructure/containers/container_images/)
|
|
35776
|
+
for more information.
|
|
32829
35777
|
name: Container Images
|
|
32830
35778
|
- description: The Containers API allows you to query container data for your organization.
|
|
35779
|
+
See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for
|
|
35780
|
+
more information.
|
|
32831
35781
|
name: Containers
|
|
32832
35782
|
- description: Send events for DORA Metrics to measure and improve software delivery.
|
|
35783
|
+
See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more
|
|
35784
|
+
information.
|
|
32833
35785
|
name: DORA Metrics
|
|
32834
35786
|
- description: 'Interact with your dashboard lists through the API to
|
|
32835
35787
|
|
|
@@ -32849,18 +35801,15 @@ tags:
|
|
|
32849
35801
|
|
|
32850
35802
|
end times, prevent all alerting related to specified Datadog tags.'
|
|
32851
35803
|
name: Downtimes
|
|
32852
|
-
- description: 'The
|
|
32853
|
-
|
|
35804
|
+
- description: 'The Event Management API allows you to programmatically post events
|
|
35805
|
+
to the Events Explorer
|
|
32854
35806
|
|
|
32855
|
-
and fetch events from the
|
|
32856
|
-
|
|
32857
|
-
If an event is sent out with a message containing more than 4000 characters, only
|
|
32858
|
-
the
|
|
32859
|
-
|
|
32860
|
-
first 4000 characters are displayed.'
|
|
35807
|
+
and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
|
|
35808
|
+
for more information.'
|
|
32861
35809
|
name: Events
|
|
32862
|
-
- description:
|
|
32863
|
-
API.
|
|
35810
|
+
- description: Manage your Datadog Fastly integration accounts and services directly
|
|
35811
|
+
through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/)
|
|
35812
|
+
for more information.
|
|
32864
35813
|
name: Fastly Integration
|
|
32865
35814
|
- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly
|
|
32866
35815
|
|
|
@@ -32877,15 +35826,19 @@ tags:
|
|
|
32877
35826
|
|
|
32878
35827
|
This is an enterprise-only feature. Request access by
|
|
32879
35828
|
|
|
32880
|
-
contacting Datadog support.
|
|
35829
|
+
contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/)
|
|
35830
|
+
for more information.'
|
|
32881
35831
|
name: IP Allowlist
|
|
32882
35832
|
- description: Create, update, delete, and retrieve services which can be associated
|
|
32883
|
-
with incidents.
|
|
35833
|
+
with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
|
|
35834
|
+
for more information.
|
|
32884
35835
|
name: Incident Services
|
|
32885
35836
|
- description: The Incident Teams endpoints are deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/)
|
|
32886
35837
|
to create, update, delete, and retrieve teams which can be associated with incidents.
|
|
32887
35838
|
name: Incident Teams
|
|
32888
|
-
- description: Manage incident response
|
|
35839
|
+
- description: Manage incident response, as well as associated attachments, metadata,
|
|
35840
|
+
and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
|
|
35841
|
+
for more information.
|
|
32889
35842
|
name: Incidents
|
|
32890
35843
|
- description: 'Manage your Datadog API and application keys. You need an API key
|
|
32891
35844
|
and
|
|
@@ -32900,17 +35853,28 @@ tags:
|
|
|
32900
35853
|
url: https://docs.datadoghq.com/account_management/api-app-keys/
|
|
32901
35854
|
name: Key Management
|
|
32902
35855
|
- description: Search your logs and send them to your Datadog platform over HTTP.
|
|
35856
|
+
See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.
|
|
32903
35857
|
name: Logs
|
|
32904
35858
|
- description: 'Archives forward all the logs ingested to a cloud storage system.
|
|
32905
35859
|
|
|
32906
35860
|
|
|
32907
35861
|
See the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives)
|
|
32908
35862
|
|
|
32909
|
-
for a list of the archives currently configured in
|
|
35863
|
+
for a list of the archives currently configured in Datadog.'
|
|
32910
35864
|
externalDocs:
|
|
32911
35865
|
description: Find out more at
|
|
32912
35866
|
url: https://docs.datadoghq.com/logs/archives/
|
|
32913
35867
|
name: Logs Archives
|
|
35868
|
+
- description: 'Custom Destinations forward all the logs ingested to an external destination.
|
|
35869
|
+
|
|
35870
|
+
|
|
35871
|
+
See the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations)
|
|
35872
|
+
|
|
35873
|
+
for a list of the custom destinations currently configured in web UI.'
|
|
35874
|
+
externalDocs:
|
|
35875
|
+
description: Find out more at
|
|
35876
|
+
url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/
|
|
35877
|
+
name: Logs Custom Destinations
|
|
32914
35878
|
- description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
|
|
32915
35879
|
for your organization.
|
|
32916
35880
|
externalDocs:
|
|
@@ -32924,7 +35888,8 @@ tags:
|
|
|
32924
35888
|
points\nand as the timeframe over which a metric is viewed increases,\naggregation
|
|
32925
35889
|
between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete
|
|
32926
35890
|
`manage_tags` API methods can only be performed by\na user who has the `Manage
|
|
32927
|
-
Tags for Metrics` permission.
|
|
35891
|
+
Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/)
|
|
35892
|
+
for more information."
|
|
32928
35893
|
name: Metrics
|
|
32929
35894
|
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
|
|
32930
35895
|
a metric or check that you care about and
|
|
@@ -32940,8 +35905,8 @@ tags:
|
|
|
32940
35905
|
description: Find out more at
|
|
32941
35906
|
url: https://docs.datadoghq.com/monitors/create/types/
|
|
32942
35907
|
name: Monitors
|
|
32943
|
-
- description: Configure your Datadog Okta integration
|
|
32944
|
-
API.
|
|
35908
|
+
- description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/)
|
|
35909
|
+
directly through the Datadog API.
|
|
32945
35910
|
name: Okta Integration
|
|
32946
35911
|
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
|
32947
35912
|
|
|
@@ -32955,25 +35920,33 @@ tags:
|
|
|
32955
35920
|
description: Find out more at
|
|
32956
35921
|
url: https://docs.datadoghq.com/account_management/multi_organization
|
|
32957
35922
|
name: Organizations
|
|
32958
|
-
- description: 'The
|
|
35923
|
+
- description: 'The Powerpack endpoints allow you to:
|
|
35924
|
+
|
|
32959
35925
|
|
|
35926
|
+
- Get a Powerpack
|
|
32960
35927
|
|
|
32961
|
-
-
|
|
35928
|
+
- Create a Powerpack
|
|
32962
35929
|
|
|
32963
|
-
-
|
|
35930
|
+
- Delete a Powerpack
|
|
32964
35931
|
|
|
32965
|
-
-
|
|
35932
|
+
- Get a list of all Powerpacks
|
|
32966
35933
|
|
|
32967
|
-
- Get a list of all powerpacks
|
|
32968
35934
|
|
|
35935
|
+
The Patch and Delete API methods can only be performed on a Powerpack by
|
|
32969
35936
|
|
|
32970
|
-
|
|
35937
|
+
a user who has the powerpack create permission for that specific Powerpack.
|
|
32971
35938
|
|
|
32972
|
-
|
|
35939
|
+
|
|
35940
|
+
Read [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/)
|
|
35941
|
+
for more information.'
|
|
32973
35942
|
name: Powerpack
|
|
32974
35943
|
- description: The processes API allows you to query processes data for your organization.
|
|
35944
|
+
See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
|
|
35945
|
+
for more information.
|
|
32975
35946
|
name: Processes
|
|
32976
|
-
- description:
|
|
35947
|
+
- description: Manage your Real User Monitoring (RUM) applications, and search or
|
|
35948
|
+
aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
|
|
35949
|
+
for more information
|
|
32977
35950
|
name: RUM
|
|
32978
35951
|
- description: 'A restriction policy defines the access control rules for a resource,
|
|
32979
35952
|
mapping a set of relations
|
|
@@ -32999,20 +35972,24 @@ tags:
|
|
|
32999
35972
|
|
|
33000
35973
|
[Pipelines page](https://app.datadoghq.com/logs/pipelines).'
|
|
33001
35974
|
name: Roles
|
|
33002
|
-
- description:
|
|
33003
|
-
|
|
33004
|
-
|
|
35975
|
+
- description: Create and manage your security rules, signals, filters, and more.
|
|
35976
|
+
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
|
|
35977
|
+
information.
|
|
33005
35978
|
name: Security Monitoring
|
|
33006
35979
|
- description: Create, update, delete, and retrieve sensitive data scanner groups
|
|
33007
|
-
and rules.
|
|
35980
|
+
and rules. See the [Sensitive Data Scanner page](https://docs.datadoghq.com/sensitive_data_scanner/)
|
|
35981
|
+
for more information.
|
|
33008
35982
|
name: Sensitive Data Scanner
|
|
33009
|
-
- description: Create, edit, and disable service accounts.
|
|
35983
|
+
- description: Create, edit, and disable service accounts. See the [Service Accounts
|
|
35984
|
+
page](https://docs.datadoghq.com/account_management/org_settings/service_accounts/)
|
|
35985
|
+
for more information.
|
|
33010
35986
|
name: Service Accounts
|
|
33011
35987
|
- description: API to create, update, retrieve and delete service definitions.
|
|
33012
35988
|
externalDocs:
|
|
33013
35989
|
url: https://docs.datadoghq.com/tracing/service_catalog/
|
|
33014
35990
|
name: Service Definition
|
|
33015
|
-
- description: 'API to create, update scorecard rules and outcomes.
|
|
35991
|
+
- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
|
|
35992
|
+
for more information.
|
|
33016
35993
|
|
|
33017
35994
|
|
|
33018
35995
|
This feature is currently in BETA. If you have any feedback, contact [Datadog
|
|
@@ -33021,7 +35998,8 @@ tags:
|
|
|
33021
35998
|
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
|
33022
35999
|
name: Spans
|
|
33023
36000
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|
|
33024
|
-
for your organization.
|
|
36001
|
+
for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/)
|
|
36002
|
+
for more information.
|
|
33025
36003
|
externalDocs:
|
|
33026
36004
|
description: Find out more at
|
|
33027
36005
|
url: https://docs.datadoghq.com/tracing/metrics/metrics_namespace/
|
|
@@ -33033,7 +36011,8 @@ tags:
|
|
|
33033
36011
|
use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more
|
|
33034
36012
|
information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)."
|
|
33035
36013
|
name: Synthetics
|
|
33036
|
-
- description: View and manage teams within Datadog.
|
|
36014
|
+
- description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/)
|
|
36015
|
+
for more information.
|
|
33037
36016
|
name: Teams
|
|
33038
36017
|
- description: 'The usage metering API allows you to get hourly, daily, and
|
|
33039
36018
|
|
|
@@ -33051,7 +36030,9 @@ tags:
|
|
|
33051
36030
|
|
|
33052
36031
|
You can retrieve up to 24 hours of hourly usage data for multiple organizations,
|
|
33053
36032
|
|
|
33054
|
-
and up to two months of hourly usage data for a single organization in one request.
|
|
36033
|
+
and up to two months of hourly usage data for a single organization in one request.
|
|
36034
|
+
|
|
36035
|
+
Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).'
|
|
33055
36036
|
externalDocs:
|
|
33056
36037
|
description: Find out more at
|
|
33057
36038
|
url: https://docs.datadoghq.com/account_management/billing/usage_details/
|