datadog_api_client 2.20.0 → 2.22.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 +502 -754
- data/.generator/schemas/v2/openapi.yaml +2903 -102
- data/.github/workflows/prepare_release.yml +2 -2
- data/.github/workflows/publish.yml +2 -2
- data/.github/workflows/release.yml +2 -2
- data/.github/workflows/test.yml +1 -1
- data/CHANGELOG.md +52 -0
- data/Gemfile +1 -1
- data/examples/v1/aws-integration/CreateAWSAccount.rb +1 -1
- data/examples/v1/aws-integration/CreateNewAWSExternalID.rb +1 -0
- data/examples/v1/aws-integration/UpdateAWSAccount.rb +1 -1
- data/examples/v1/gcp-integration/CreateGCPIntegration.rb +3 -0
- data/examples/v1/gcp-integration/UpdateGCPIntegration_3544259255.rb +25 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1241981394.rb +118 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +29 -0
- data/examples/v1/synthetics/UpdateBrowserTest.rb +4 -0
- data/examples/v2/apm-retention-filters/UpdateApmRetentionFilter.rb +2 -2
- data/examples/v2/authn-mappings/CreateAuthNMapping.rb +1 -1
- data/examples/v2/authn-mappings/UpdateAuthNMapping.rb +1 -1
- 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.rb +1 -1
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_109518525.rb +1 -1
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_130557025.rb +1 -1
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_194782945.rb +18 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb +1 -1
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_4235664992.rb +1 -1
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount.rb +1 -1
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount_2241994060.rb +21 -0
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount_3205636354.rb +1 -1
- 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 +22 -0
- data/examples/v2/metrics/ListMetricAssets.rb +5 -0
- data/examples/v2/metrics/QueryScalarData_3112571352.rb +2 -2
- data/examples/v2/metrics/QueryTimeseriesData_301142940.rb +3 -3
- data/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression_3192265332.rb +19 -0
- data/examples/v2/security-monitoring/ValidateSecurityMonitoringRule.rb +42 -0
- data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +4 -0
- data/examples/v2/service-level-objectives/CreateSLOReportJob.rb +20 -0
- data/examples/v2/service-level-objectives/GetSLOReport.rb +8 -0
- data/examples/v2/service-level-objectives/GetSLOReportJobStatus.rb +11 -0
- data/lib/datadog_api_client/configuration.rb +3 -0
- data/lib/datadog_api_client/inflector.rb +132 -7
- data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -3
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +104 -131
- data/lib/datadog_api_client/v1/models/aws_account.rb +12 -2
- 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 +8 -0
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_events_data_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/monitor_options.rb +4 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +12 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +124 -4
- data/lib/datadog_api_client/v1/models/series.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_time_slice_condition.rb +14 -2
- data/lib/datadog_api_client/v1/models/slo_time_slice_interval.rb +29 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_spec.rb +1 -1
- 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 +23 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request_body_file.rb +175 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_request_body_type.rb +2 -0
- 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/apm_retention_filters_api.rb +6 -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 +70 -2
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +67 -0
- data/lib/datadog_api_client/v2/api/service_definition_api.rb +2 -1
- data/lib/datadog_api_client/v2/api/service_level_objectives_api.rb +245 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +15 -6
- data/lib/datadog_api_client/v2/models/authn_mapping_create_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/authn_mapping_create_relationships.rb +37 -54
- data/lib/datadog_api_client/v2/models/authn_mapping_included.rb +2 -1
- data/lib/datadog_api_client/v2/models/authn_mapping_relationship_to_role.rb +98 -0
- data/lib/datadog_api_client/v2/models/authn_mapping_relationship_to_team.rb +98 -0
- data/lib/datadog_api_client/v2/models/authn_mapping_relationships.rb +14 -4
- data/lib/datadog_api_client/v2/models/authn_mapping_team.rb +100 -0
- data/lib/datadog_api_client/v2/models/authn_mapping_team_attributes.rb +212 -0
- data/lib/datadog_api_client/v2/models/authn_mapping_update_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/authn_mapping_update_relationships.rb +37 -54
- 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/{v1/models/usage_attribution_pagination.rb → v2/models/case_update_status_attributes.rb} +29 -51
- data/lib/datadog_api_client/v2/models/case_update_status_request.rb +98 -0
- data/lib/datadog_api_client/{v1/models/usage_attribution_metadata.rb → v2/models/cases_response.rb} +22 -22
- 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/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 +1 -1
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +21 -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_series.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/{v1/models/usage_attribution_response.rb → v2/models/nullable_user_relationship.rb} +22 -26
- data/lib/datadog_api_client/v2/models/nullable_user_relationship_data.rb +119 -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/relationship_to_team.rb +80 -0
- data/lib/datadog_api_client/v2/models/relationship_to_team_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/retention_filter_update_attributes.rb +183 -0
- data/lib/datadog_api_client/v2/models/retention_filter_update_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_create_payload.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_attributes.rb +13 -14
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_attributes.rb +11 -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_definition_v2_dot2.rb +13 -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/slo_report_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/slo_report_create_request_attributes.rb +160 -0
- data/lib/datadog_api_client/v2/models/slo_report_create_request_data.rb +98 -0
- data/lib/datadog_api_client/v2/models/slo_report_interval.rb +27 -0
- data/lib/datadog_api_client/v2/models/slo_report_post_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/slo_report_post_response_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/slo_report_status.rb +29 -0
- data/lib/datadog_api_client/v2/models/slo_report_status_get_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/slo_report_status_get_response_attributes.rb +80 -0
- data/lib/datadog_api_client/v2/models/slo_report_status_get_response_data.rb +100 -0
- data/lib/datadog_api_client/v2/models/timeseries_response_series.rb +8 -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/user_teams_response.rb +13 -1
- data/lib/datadog_api_client/v2/models/users_relationship.rb +100 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +196 -33
- data/examples/v1/usage-metering/GetUsageAttribution.rb +0 -9
- data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +0 -152
- data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +0 -61
- data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +0 -72
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +0 -590
|
@@ -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,21 @@ 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
|
|
414
|
+
ReportID:
|
|
415
|
+
description: The ID of the report job.
|
|
416
|
+
in: path
|
|
417
|
+
name: report_id
|
|
418
|
+
required: true
|
|
419
|
+
schema:
|
|
420
|
+
type: string
|
|
384
421
|
ResourceID:
|
|
385
422
|
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
|
|
386
423
|
`dashboard`, `notebook`, `security-rule`, `slo`.'
|
|
@@ -1295,11 +1332,10 @@ components:
|
|
|
1295
1332
|
- type
|
|
1296
1333
|
type: object
|
|
1297
1334
|
AuthNMappingCreateRelationships:
|
|
1298
|
-
description: Relationship of AuthN Mapping create object to Role.
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
type: object
|
|
1335
|
+
description: Relationship of AuthN Mapping create object to a Role or Team.
|
|
1336
|
+
oneOf:
|
|
1337
|
+
- $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
|
|
1338
|
+
- $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
|
|
1303
1339
|
AuthNMappingCreateRequest:
|
|
1304
1340
|
description: Request for creating an AuthN Mapping.
|
|
1305
1341
|
properties:
|
|
@@ -1313,6 +1349,23 @@ components:
|
|
|
1313
1349
|
oneOf:
|
|
1314
1350
|
- $ref: '#/components/schemas/SAMLAssertionAttribute'
|
|
1315
1351
|
- $ref: '#/components/schemas/Role'
|
|
1352
|
+
- $ref: '#/components/schemas/AuthNMappingTeam'
|
|
1353
|
+
AuthNMappingRelationshipToRole:
|
|
1354
|
+
description: Relationship of AuthN Mapping to a Role.
|
|
1355
|
+
properties:
|
|
1356
|
+
role:
|
|
1357
|
+
$ref: '#/components/schemas/RelationshipToRole'
|
|
1358
|
+
required:
|
|
1359
|
+
- role
|
|
1360
|
+
type: object
|
|
1361
|
+
AuthNMappingRelationshipToTeam:
|
|
1362
|
+
description: Relationship of AuthN Mapping to a Team.
|
|
1363
|
+
properties:
|
|
1364
|
+
team:
|
|
1365
|
+
$ref: '#/components/schemas/RelationshipToTeam'
|
|
1366
|
+
required:
|
|
1367
|
+
- team
|
|
1368
|
+
type: object
|
|
1316
1369
|
AuthNMappingRelationships:
|
|
1317
1370
|
description: All relationships associated with AuthN Mapping.
|
|
1318
1371
|
properties:
|
|
@@ -1320,6 +1373,8 @@ components:
|
|
|
1320
1373
|
$ref: '#/components/schemas/RelationshipToRole'
|
|
1321
1374
|
saml_assertion_attribute:
|
|
1322
1375
|
$ref: '#/components/schemas/RelationshipToSAMLAssertionAttribute'
|
|
1376
|
+
team:
|
|
1377
|
+
$ref: '#/components/schemas/RelationshipToTeam'
|
|
1323
1378
|
type: object
|
|
1324
1379
|
AuthNMappingResponse:
|
|
1325
1380
|
description: AuthN Mapping response from the API.
|
|
@@ -1332,6 +1387,60 @@ components:
|
|
|
1332
1387
|
$ref: '#/components/schemas/AuthNMappingIncluded'
|
|
1333
1388
|
type: array
|
|
1334
1389
|
type: object
|
|
1390
|
+
AuthNMappingTeam:
|
|
1391
|
+
description: Team.
|
|
1392
|
+
properties:
|
|
1393
|
+
attributes:
|
|
1394
|
+
$ref: '#/components/schemas/AuthNMappingTeamAttributes'
|
|
1395
|
+
id:
|
|
1396
|
+
description: The ID of the Team.
|
|
1397
|
+
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
|
|
1398
|
+
type: string
|
|
1399
|
+
type:
|
|
1400
|
+
$ref: '#/components/schemas/TeamType'
|
|
1401
|
+
type: object
|
|
1402
|
+
AuthNMappingTeamAttributes:
|
|
1403
|
+
description: Team attributes.
|
|
1404
|
+
properties:
|
|
1405
|
+
avatar:
|
|
1406
|
+
description: Unicode representation of the avatar for the team, limited
|
|
1407
|
+
to a single grapheme
|
|
1408
|
+
example: "\U0001F951"
|
|
1409
|
+
nullable: true
|
|
1410
|
+
type: string
|
|
1411
|
+
banner:
|
|
1412
|
+
description: Banner selection for the team
|
|
1413
|
+
format: int64
|
|
1414
|
+
nullable: true
|
|
1415
|
+
type: integer
|
|
1416
|
+
handle:
|
|
1417
|
+
description: The team's identifier
|
|
1418
|
+
example: example-team
|
|
1419
|
+
maxLength: 195
|
|
1420
|
+
type: string
|
|
1421
|
+
link_count:
|
|
1422
|
+
description: The number of links belonging to the team
|
|
1423
|
+
format: int32
|
|
1424
|
+
maximum: 2147483647
|
|
1425
|
+
readOnly: true
|
|
1426
|
+
type: integer
|
|
1427
|
+
name:
|
|
1428
|
+
description: The name of the team
|
|
1429
|
+
example: Example Team
|
|
1430
|
+
maxLength: 200
|
|
1431
|
+
type: string
|
|
1432
|
+
summary:
|
|
1433
|
+
description: A brief summary of the team, derived from the `description`
|
|
1434
|
+
maxLength: 120
|
|
1435
|
+
nullable: true
|
|
1436
|
+
type: string
|
|
1437
|
+
user_count:
|
|
1438
|
+
description: The number of users belonging to the team
|
|
1439
|
+
format: int32
|
|
1440
|
+
maximum: 2147483647
|
|
1441
|
+
readOnly: true
|
|
1442
|
+
type: integer
|
|
1443
|
+
type: object
|
|
1335
1444
|
AuthNMappingUpdateAttributes:
|
|
1336
1445
|
description: Key/Value pair of attributes used for update request.
|
|
1337
1446
|
properties:
|
|
@@ -1364,11 +1473,10 @@ components:
|
|
|
1364
1473
|
- type
|
|
1365
1474
|
type: object
|
|
1366
1475
|
AuthNMappingUpdateRelationships:
|
|
1367
|
-
description: Relationship of AuthN Mapping update object to Role.
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
type: object
|
|
1476
|
+
description: Relationship of AuthN Mapping update object to a Role or Team.
|
|
1477
|
+
oneOf:
|
|
1478
|
+
- $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
|
|
1479
|
+
- $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
|
|
1372
1480
|
AuthNMappingUpdateRequest:
|
|
1373
1481
|
description: Request to update an AuthN Mapping.
|
|
1374
1482
|
properties:
|
|
@@ -2016,7 +2124,8 @@ components:
|
|
|
2016
2124
|
type: number
|
|
2017
2125
|
type: object
|
|
2018
2126
|
CIAppAggregateSort:
|
|
2019
|
-
description: A sort rule.
|
|
2127
|
+
description: A sort rule. The `aggregation` field is required when `type` is
|
|
2128
|
+
`measure`.
|
|
2020
2129
|
example:
|
|
2021
2130
|
aggregation: count
|
|
2022
2131
|
order: asc
|
|
@@ -3332,6 +3441,345 @@ components:
|
|
|
3332
3441
|
from the other indexes
|
|
3333
3442
|
type: string
|
|
3334
3443
|
type: object
|
|
3444
|
+
Case:
|
|
3445
|
+
description: A case
|
|
3446
|
+
properties:
|
|
3447
|
+
attributes:
|
|
3448
|
+
$ref: '#/components/schemas/CaseAttributes'
|
|
3449
|
+
id:
|
|
3450
|
+
description: Case's identifier
|
|
3451
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
3452
|
+
type: string
|
|
3453
|
+
relationships:
|
|
3454
|
+
$ref: '#/components/schemas/CaseRelationships'
|
|
3455
|
+
type:
|
|
3456
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3457
|
+
required:
|
|
3458
|
+
- id
|
|
3459
|
+
- type
|
|
3460
|
+
- attributes
|
|
3461
|
+
type: object
|
|
3462
|
+
Case3rdPartyTicketStatus:
|
|
3463
|
+
default: IN_PROGRESS
|
|
3464
|
+
description: Case status
|
|
3465
|
+
enum:
|
|
3466
|
+
- IN_PROGRESS
|
|
3467
|
+
- COMPLETED
|
|
3468
|
+
- FAILED
|
|
3469
|
+
example: COMPLETED
|
|
3470
|
+
readOnly: true
|
|
3471
|
+
type: string
|
|
3472
|
+
x-enum-varnames:
|
|
3473
|
+
- IN_PROGRESS
|
|
3474
|
+
- COMPLETED
|
|
3475
|
+
- FAILED
|
|
3476
|
+
CaseAssign:
|
|
3477
|
+
description: Case assign
|
|
3478
|
+
properties:
|
|
3479
|
+
attributes:
|
|
3480
|
+
$ref: '#/components/schemas/CaseAssignAttributes'
|
|
3481
|
+
type:
|
|
3482
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3483
|
+
required:
|
|
3484
|
+
- attributes
|
|
3485
|
+
- type
|
|
3486
|
+
type: object
|
|
3487
|
+
CaseAssignAttributes:
|
|
3488
|
+
description: Case assign attributes
|
|
3489
|
+
properties:
|
|
3490
|
+
assignee_id:
|
|
3491
|
+
description: Assignee's UUID
|
|
3492
|
+
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
|
|
3493
|
+
type: string
|
|
3494
|
+
required:
|
|
3495
|
+
- assignee_id
|
|
3496
|
+
type: object
|
|
3497
|
+
CaseAssignRequest:
|
|
3498
|
+
description: Case assign request
|
|
3499
|
+
properties:
|
|
3500
|
+
data:
|
|
3501
|
+
$ref: '#/components/schemas/CaseAssign'
|
|
3502
|
+
required:
|
|
3503
|
+
- data
|
|
3504
|
+
type: object
|
|
3505
|
+
CaseAttributes:
|
|
3506
|
+
description: Case attributes
|
|
3507
|
+
properties:
|
|
3508
|
+
archived_at:
|
|
3509
|
+
description: Timestamp of when the case was archived
|
|
3510
|
+
format: date-time
|
|
3511
|
+
nullable: true
|
|
3512
|
+
readOnly: true
|
|
3513
|
+
type: string
|
|
3514
|
+
closed_at:
|
|
3515
|
+
description: Timestamp of when the case was closed
|
|
3516
|
+
format: date-time
|
|
3517
|
+
nullable: true
|
|
3518
|
+
readOnly: true
|
|
3519
|
+
type: string
|
|
3520
|
+
created_at:
|
|
3521
|
+
description: Timestamp of when the case was created
|
|
3522
|
+
format: date-time
|
|
3523
|
+
readOnly: true
|
|
3524
|
+
type: string
|
|
3525
|
+
description:
|
|
3526
|
+
description: Description
|
|
3527
|
+
type: string
|
|
3528
|
+
jira_issue:
|
|
3529
|
+
$ref: '#/components/schemas/JiraIssue'
|
|
3530
|
+
key:
|
|
3531
|
+
description: Key
|
|
3532
|
+
example: CASEM-4523
|
|
3533
|
+
type: string
|
|
3534
|
+
modified_at:
|
|
3535
|
+
description: Timestamp of when the case was last modified
|
|
3536
|
+
format: date-time
|
|
3537
|
+
nullable: true
|
|
3538
|
+
readOnly: true
|
|
3539
|
+
type: string
|
|
3540
|
+
priority:
|
|
3541
|
+
$ref: '#/components/schemas/CasePriority'
|
|
3542
|
+
service_now_ticket:
|
|
3543
|
+
$ref: '#/components/schemas/ServiceNowTicket'
|
|
3544
|
+
status:
|
|
3545
|
+
$ref: '#/components/schemas/CaseStatus'
|
|
3546
|
+
title:
|
|
3547
|
+
description: Title
|
|
3548
|
+
example: Memory leak investigation on API
|
|
3549
|
+
type: string
|
|
3550
|
+
type:
|
|
3551
|
+
$ref: '#/components/schemas/CaseType'
|
|
3552
|
+
type: object
|
|
3553
|
+
CaseCreate:
|
|
3554
|
+
description: Case creation data
|
|
3555
|
+
properties:
|
|
3556
|
+
attributes:
|
|
3557
|
+
$ref: '#/components/schemas/CaseCreateAttributes'
|
|
3558
|
+
relationships:
|
|
3559
|
+
$ref: '#/components/schemas/CaseCreateRelationships'
|
|
3560
|
+
type:
|
|
3561
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3562
|
+
required:
|
|
3563
|
+
- attributes
|
|
3564
|
+
- type
|
|
3565
|
+
type: object
|
|
3566
|
+
CaseCreateAttributes:
|
|
3567
|
+
description: Case creation attributes
|
|
3568
|
+
properties:
|
|
3569
|
+
description:
|
|
3570
|
+
description: Description
|
|
3571
|
+
type: string
|
|
3572
|
+
priority:
|
|
3573
|
+
$ref: '#/components/schemas/CasePriority'
|
|
3574
|
+
title:
|
|
3575
|
+
description: Title
|
|
3576
|
+
example: Security breach investigation
|
|
3577
|
+
type: string
|
|
3578
|
+
type:
|
|
3579
|
+
$ref: '#/components/schemas/CaseType'
|
|
3580
|
+
required:
|
|
3581
|
+
- title
|
|
3582
|
+
- type
|
|
3583
|
+
type: object
|
|
3584
|
+
CaseCreateRelationships:
|
|
3585
|
+
description: Relationships formed with the case on creation
|
|
3586
|
+
properties:
|
|
3587
|
+
assignee:
|
|
3588
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3589
|
+
project:
|
|
3590
|
+
$ref: '#/components/schemas/ProjectRelationship'
|
|
3591
|
+
required:
|
|
3592
|
+
- project
|
|
3593
|
+
type: object
|
|
3594
|
+
CaseCreateRequest:
|
|
3595
|
+
description: Case create request
|
|
3596
|
+
properties:
|
|
3597
|
+
data:
|
|
3598
|
+
$ref: '#/components/schemas/CaseCreate'
|
|
3599
|
+
required:
|
|
3600
|
+
- data
|
|
3601
|
+
type: object
|
|
3602
|
+
CaseEmpty:
|
|
3603
|
+
description: Case empty request data
|
|
3604
|
+
properties:
|
|
3605
|
+
type:
|
|
3606
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3607
|
+
required:
|
|
3608
|
+
- type
|
|
3609
|
+
type: object
|
|
3610
|
+
CaseEmptyRequest:
|
|
3611
|
+
description: Case empty request
|
|
3612
|
+
properties:
|
|
3613
|
+
data:
|
|
3614
|
+
$ref: '#/components/schemas/CaseEmpty'
|
|
3615
|
+
required:
|
|
3616
|
+
- data
|
|
3617
|
+
type: object
|
|
3618
|
+
CasePriority:
|
|
3619
|
+
default: NOT_DEFINED
|
|
3620
|
+
description: Case priority
|
|
3621
|
+
enum:
|
|
3622
|
+
- NOT_DEFINED
|
|
3623
|
+
- P1
|
|
3624
|
+
- P2
|
|
3625
|
+
- P3
|
|
3626
|
+
- P4
|
|
3627
|
+
- P5
|
|
3628
|
+
example: NOT_DEFINED
|
|
3629
|
+
type: string
|
|
3630
|
+
x-enum-varnames:
|
|
3631
|
+
- NOT_DEFINED
|
|
3632
|
+
- P1
|
|
3633
|
+
- P2
|
|
3634
|
+
- P3
|
|
3635
|
+
- P4
|
|
3636
|
+
- P5
|
|
3637
|
+
CaseRelationships:
|
|
3638
|
+
description: Resources related to a case
|
|
3639
|
+
properties:
|
|
3640
|
+
assignee:
|
|
3641
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3642
|
+
created_by:
|
|
3643
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3644
|
+
modified_by:
|
|
3645
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
|
3646
|
+
project:
|
|
3647
|
+
$ref: '#/components/schemas/ProjectRelationship'
|
|
3648
|
+
type: object
|
|
3649
|
+
CaseResourceType:
|
|
3650
|
+
default: case
|
|
3651
|
+
description: Case resource type
|
|
3652
|
+
enum:
|
|
3653
|
+
- case
|
|
3654
|
+
example: case
|
|
3655
|
+
type: string
|
|
3656
|
+
x-enum-varnames:
|
|
3657
|
+
- CASE
|
|
3658
|
+
CaseResponse:
|
|
3659
|
+
description: Case response
|
|
3660
|
+
properties:
|
|
3661
|
+
data:
|
|
3662
|
+
$ref: '#/components/schemas/Case'
|
|
3663
|
+
type: object
|
|
3664
|
+
CaseSortableField:
|
|
3665
|
+
description: Case field that can be sorted on
|
|
3666
|
+
enum:
|
|
3667
|
+
- created_at
|
|
3668
|
+
- priority
|
|
3669
|
+
- status
|
|
3670
|
+
example: created_at
|
|
3671
|
+
type: string
|
|
3672
|
+
x-enum-varnames:
|
|
3673
|
+
- CREATED_AT
|
|
3674
|
+
- PRIORITY
|
|
3675
|
+
- STATUS
|
|
3676
|
+
CaseStatus:
|
|
3677
|
+
description: Case status
|
|
3678
|
+
enum:
|
|
3679
|
+
- OPEN
|
|
3680
|
+
- IN_PROGRESS
|
|
3681
|
+
- CLOSED
|
|
3682
|
+
example: OPEN
|
|
3683
|
+
type: string
|
|
3684
|
+
x-enum-varnames:
|
|
3685
|
+
- OPEN
|
|
3686
|
+
- IN_PROGRESS
|
|
3687
|
+
- CLOSED
|
|
3688
|
+
CaseType:
|
|
3689
|
+
description: Case type
|
|
3690
|
+
enum:
|
|
3691
|
+
- STANDARD
|
|
3692
|
+
example: STANDARD
|
|
3693
|
+
type: string
|
|
3694
|
+
x-enum-varnames:
|
|
3695
|
+
- STANDARD
|
|
3696
|
+
CaseUpdatePriority:
|
|
3697
|
+
description: Case priority status
|
|
3698
|
+
properties:
|
|
3699
|
+
attributes:
|
|
3700
|
+
$ref: '#/components/schemas/CaseUpdatePriorityAttributes'
|
|
3701
|
+
type:
|
|
3702
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3703
|
+
required:
|
|
3704
|
+
- attributes
|
|
3705
|
+
- type
|
|
3706
|
+
type: object
|
|
3707
|
+
CaseUpdatePriorityAttributes:
|
|
3708
|
+
description: Case update priority attributes
|
|
3709
|
+
properties:
|
|
3710
|
+
priority:
|
|
3711
|
+
$ref: '#/components/schemas/CasePriority'
|
|
3712
|
+
required:
|
|
3713
|
+
- priority
|
|
3714
|
+
type: object
|
|
3715
|
+
CaseUpdatePriorityRequest:
|
|
3716
|
+
description: Case update priority request
|
|
3717
|
+
properties:
|
|
3718
|
+
data:
|
|
3719
|
+
$ref: '#/components/schemas/CaseUpdatePriority'
|
|
3720
|
+
required:
|
|
3721
|
+
- data
|
|
3722
|
+
type: object
|
|
3723
|
+
CaseUpdateStatus:
|
|
3724
|
+
description: Case update status
|
|
3725
|
+
properties:
|
|
3726
|
+
attributes:
|
|
3727
|
+
$ref: '#/components/schemas/CaseUpdateStatusAttributes'
|
|
3728
|
+
type:
|
|
3729
|
+
$ref: '#/components/schemas/CaseResourceType'
|
|
3730
|
+
required:
|
|
3731
|
+
- attributes
|
|
3732
|
+
- type
|
|
3733
|
+
type: object
|
|
3734
|
+
CaseUpdateStatusAttributes:
|
|
3735
|
+
description: Case update status attributes
|
|
3736
|
+
properties:
|
|
3737
|
+
status:
|
|
3738
|
+
$ref: '#/components/schemas/CaseStatus'
|
|
3739
|
+
required:
|
|
3740
|
+
- status
|
|
3741
|
+
type: object
|
|
3742
|
+
CaseUpdateStatusRequest:
|
|
3743
|
+
description: Case update status request
|
|
3744
|
+
properties:
|
|
3745
|
+
data:
|
|
3746
|
+
$ref: '#/components/schemas/CaseUpdateStatus'
|
|
3747
|
+
required:
|
|
3748
|
+
- data
|
|
3749
|
+
type: object
|
|
3750
|
+
CasesResponse:
|
|
3751
|
+
description: Response with cases
|
|
3752
|
+
properties:
|
|
3753
|
+
data:
|
|
3754
|
+
description: Cases response data
|
|
3755
|
+
items:
|
|
3756
|
+
$ref: '#/components/schemas/Case'
|
|
3757
|
+
type: array
|
|
3758
|
+
meta:
|
|
3759
|
+
$ref: '#/components/schemas/CasesResponseMeta'
|
|
3760
|
+
type: object
|
|
3761
|
+
CasesResponseMeta:
|
|
3762
|
+
description: Cases response metadata
|
|
3763
|
+
properties:
|
|
3764
|
+
page:
|
|
3765
|
+
$ref: '#/components/schemas/CasesResponseMetaPagination'
|
|
3766
|
+
type: object
|
|
3767
|
+
CasesResponseMetaPagination:
|
|
3768
|
+
description: Pagination metadata
|
|
3769
|
+
properties:
|
|
3770
|
+
current:
|
|
3771
|
+
description: Current page number
|
|
3772
|
+
format: int64
|
|
3773
|
+
type: integer
|
|
3774
|
+
size:
|
|
3775
|
+
description: Number of cases in current page
|
|
3776
|
+
format: int64
|
|
3777
|
+
type: integer
|
|
3778
|
+
total:
|
|
3779
|
+
description: Total number of pages
|
|
3780
|
+
format: int64
|
|
3781
|
+
type: integer
|
|
3782
|
+
type: object
|
|
3335
3783
|
ChargebackBreakdown:
|
|
3336
3784
|
description: Charges breakdown.
|
|
3337
3785
|
properties:
|
|
@@ -3556,9 +4004,27 @@ components:
|
|
|
3556
4004
|
type: string
|
|
3557
4005
|
x-enum-varnames:
|
|
3558
4006
|
- CLOUD_COST_ACTIVITY
|
|
4007
|
+
CloudWorkloadSecurityAgentRuleAction:
|
|
4008
|
+
description: The action the rule can perform if triggered.
|
|
4009
|
+
properties:
|
|
4010
|
+
filter:
|
|
4011
|
+
description: SECL expression used to target the container to apply the action
|
|
4012
|
+
on
|
|
4013
|
+
type: string
|
|
4014
|
+
kill:
|
|
4015
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
|
|
4016
|
+
type: object
|
|
4017
|
+
CloudWorkloadSecurityAgentRuleActions:
|
|
4018
|
+
description: The array of actions the rule can perform if triggered.
|
|
4019
|
+
items:
|
|
4020
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAction'
|
|
4021
|
+
nullable: true
|
|
4022
|
+
type: array
|
|
3559
4023
|
CloudWorkloadSecurityAgentRuleAttributes:
|
|
3560
4024
|
description: A Cloud Workload Security Agent rule returned by the API.
|
|
3561
4025
|
properties:
|
|
4026
|
+
actions:
|
|
4027
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
|
3562
4028
|
agentConstraint:
|
|
3563
4029
|
description: The version of the agent.
|
|
3564
4030
|
type: string
|
|
@@ -3691,6 +4157,17 @@ components:
|
|
|
3691
4157
|
type:
|
|
3692
4158
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
|
|
3693
4159
|
type: object
|
|
4160
|
+
CloudWorkloadSecurityAgentRuleID:
|
|
4161
|
+
description: The ID of the agent rule.
|
|
4162
|
+
example: 3dd-0uc-h1s
|
|
4163
|
+
type: string
|
|
4164
|
+
CloudWorkloadSecurityAgentRuleKill:
|
|
4165
|
+
description: Kill system call applied on the container matching the rule
|
|
4166
|
+
properties:
|
|
4167
|
+
signal:
|
|
4168
|
+
description: Supported signals for the kill system call.
|
|
4169
|
+
type: string
|
|
4170
|
+
type: object
|
|
3694
4171
|
CloudWorkloadSecurityAgentRuleResponse:
|
|
3695
4172
|
description: Response object that includes an Agent rule.
|
|
3696
4173
|
properties:
|
|
@@ -3727,6 +4204,8 @@ components:
|
|
|
3727
4204
|
properties:
|
|
3728
4205
|
attributes:
|
|
3729
4206
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes'
|
|
4207
|
+
id:
|
|
4208
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleID'
|
|
3730
4209
|
type:
|
|
3731
4210
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
|
|
3732
4211
|
required:
|
|
@@ -4947,6 +5426,621 @@ components:
|
|
|
4947
5426
|
nullable: true
|
|
4948
5427
|
type: string
|
|
4949
5428
|
type: object
|
|
5429
|
+
CustomDestinationAttributeTagsRestrictionListType:
|
|
5430
|
+
default: ALLOW_LIST
|
|
5431
|
+
description: 'How `forward_tags_restriction_list` parameter should be interpreted.
|
|
5432
|
+
|
|
5433
|
+
If `ALLOW_LIST`, then only tags whose keys on the forwarded logs match the
|
|
5434
|
+
ones on the restriction list
|
|
5435
|
+
|
|
5436
|
+
are forwarded.
|
|
5437
|
+
|
|
5438
|
+
|
|
5439
|
+
`BLOCK_LIST` works the opposite way. It does not forward the tags matching
|
|
5440
|
+
the ones on the list.'
|
|
5441
|
+
enum:
|
|
5442
|
+
- ALLOW_LIST
|
|
5443
|
+
- BLOCK_LIST
|
|
5444
|
+
example: ALLOW_LIST
|
|
5445
|
+
type: string
|
|
5446
|
+
x-enum-varnames:
|
|
5447
|
+
- ALLOW_LIST
|
|
5448
|
+
- BLOCK_LIST
|
|
5449
|
+
CustomDestinationCreateRequest:
|
|
5450
|
+
description: The custom destination.
|
|
5451
|
+
properties:
|
|
5452
|
+
data:
|
|
5453
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequestDefinition'
|
|
5454
|
+
type: object
|
|
5455
|
+
CustomDestinationCreateRequestAttributes:
|
|
5456
|
+
description: The attributes associated with the custom destination.
|
|
5457
|
+
properties:
|
|
5458
|
+
enabled:
|
|
5459
|
+
default: true
|
|
5460
|
+
description: Whether logs matching this custom destination should be forwarded
|
|
5461
|
+
or not.
|
|
5462
|
+
example: true
|
|
5463
|
+
type: boolean
|
|
5464
|
+
forward_tags:
|
|
5465
|
+
default: true
|
|
5466
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
|
5467
|
+
not.
|
|
5468
|
+
example: true
|
|
5469
|
+
type: boolean
|
|
5470
|
+
forward_tags_restriction_list:
|
|
5471
|
+
default: []
|
|
5472
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
|
5473
|
+
to be filtered.
|
|
5474
|
+
|
|
5475
|
+
|
|
5476
|
+
An empty list represents no restriction is in place and either all or
|
|
5477
|
+
no tags will be
|
|
5478
|
+
|
|
5479
|
+
forwarded depending on `forward_tags_restriction_list_type` parameter.'
|
|
5480
|
+
example:
|
|
5481
|
+
- datacenter
|
|
5482
|
+
- host
|
|
5483
|
+
items:
|
|
5484
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
|
5485
|
+
type: string
|
|
5486
|
+
maxItems: 10
|
|
5487
|
+
minItems: 0
|
|
5488
|
+
type: array
|
|
5489
|
+
forward_tags_restriction_list_type:
|
|
5490
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
|
5491
|
+
forwarder_destination:
|
|
5492
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestination'
|
|
5493
|
+
name:
|
|
5494
|
+
description: The custom destination name.
|
|
5495
|
+
example: Nginx logs
|
|
5496
|
+
type: string
|
|
5497
|
+
query:
|
|
5498
|
+
default: ''
|
|
5499
|
+
description: The custom destination query and filter. Logs matching this
|
|
5500
|
+
query are forwarded to the destination.
|
|
5501
|
+
example: source:nginx
|
|
5502
|
+
type: string
|
|
5503
|
+
required:
|
|
5504
|
+
- name
|
|
5505
|
+
- forwarder_destination
|
|
5506
|
+
type: object
|
|
5507
|
+
CustomDestinationCreateRequestDefinition:
|
|
5508
|
+
description: The definition of a custom destination.
|
|
5509
|
+
properties:
|
|
5510
|
+
attributes:
|
|
5511
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequestAttributes'
|
|
5512
|
+
type:
|
|
5513
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
|
5514
|
+
required:
|
|
5515
|
+
- type
|
|
5516
|
+
- attributes
|
|
5517
|
+
type: object
|
|
5518
|
+
CustomDestinationElasticsearchDestinationAuth:
|
|
5519
|
+
description: Basic access authentication.
|
|
5520
|
+
properties:
|
|
5521
|
+
password:
|
|
5522
|
+
description: The password of the authentication. This field is not returned
|
|
5523
|
+
by the API.
|
|
5524
|
+
example: datadog-custom-destination-password
|
|
5525
|
+
type: string
|
|
5526
|
+
writeOnly: true
|
|
5527
|
+
username:
|
|
5528
|
+
description: The username of the authentication. This field is not returned
|
|
5529
|
+
by the API.
|
|
5530
|
+
example: datadog-custom-destination-username
|
|
5531
|
+
type: string
|
|
5532
|
+
writeOnly: true
|
|
5533
|
+
required:
|
|
5534
|
+
- username
|
|
5535
|
+
- password
|
|
5536
|
+
type: object
|
|
5537
|
+
CustomDestinationForwardDestination:
|
|
5538
|
+
description: A custom destination's location to forward logs.
|
|
5539
|
+
oneOf:
|
|
5540
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp'
|
|
5541
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk'
|
|
5542
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch'
|
|
5543
|
+
type: object
|
|
5544
|
+
CustomDestinationForwardDestinationElasticsearch:
|
|
5545
|
+
description: The Elasticsearch destination.
|
|
5546
|
+
properties:
|
|
5547
|
+
auth:
|
|
5548
|
+
$ref: '#/components/schemas/CustomDestinationElasticsearchDestinationAuth'
|
|
5549
|
+
endpoint:
|
|
5550
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5551
|
+
|
|
5552
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5553
|
+
example: https://example.com
|
|
5554
|
+
type: string
|
|
5555
|
+
index_name:
|
|
5556
|
+
description: Name of the Elasticsearch index (must follow [Elasticsearch's
|
|
5557
|
+
criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
|
|
5558
|
+
example: nginx-logs
|
|
5559
|
+
type: string
|
|
5560
|
+
index_rotation:
|
|
5561
|
+
description: 'Date pattern with US locale and UTC timezone to be appended
|
|
5562
|
+
to the index name after adding `-`
|
|
5563
|
+
|
|
5564
|
+
(that is, `${index_name}-${indexPattern}`).
|
|
5565
|
+
|
|
5566
|
+
You can customize the index rotation naming pattern by choosing one of
|
|
5567
|
+
these options:
|
|
5568
|
+
|
|
5569
|
+
- Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
|
|
5570
|
+
|
|
5571
|
+
- Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
|
|
5572
|
+
|
|
5573
|
+
- Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`)
|
|
5574
|
+
|
|
5575
|
+
- Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
|
|
5576
|
+
|
|
5577
|
+
|
|
5578
|
+
If this field is missing or is blank, it means that the index name will
|
|
5579
|
+
always be the same
|
|
5580
|
+
|
|
5581
|
+
(that is, no rotation).'
|
|
5582
|
+
example: yyyy-MM-dd
|
|
5583
|
+
type: string
|
|
5584
|
+
type:
|
|
5585
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearchType'
|
|
5586
|
+
required:
|
|
5587
|
+
- type
|
|
5588
|
+
- endpoint
|
|
5589
|
+
- auth
|
|
5590
|
+
- index_name
|
|
5591
|
+
type: object
|
|
5592
|
+
CustomDestinationForwardDestinationElasticsearchType:
|
|
5593
|
+
default: elasticsearch
|
|
5594
|
+
description: Type of the Elasticsearch destination.
|
|
5595
|
+
enum:
|
|
5596
|
+
- elasticsearch
|
|
5597
|
+
example: elasticsearch
|
|
5598
|
+
type: string
|
|
5599
|
+
x-enum-varnames:
|
|
5600
|
+
- ELASTICSEARCH
|
|
5601
|
+
CustomDestinationForwardDestinationHttp:
|
|
5602
|
+
description: The HTTP destination.
|
|
5603
|
+
properties:
|
|
5604
|
+
auth:
|
|
5605
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuth'
|
|
5606
|
+
endpoint:
|
|
5607
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5608
|
+
|
|
5609
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5610
|
+
example: https://example.com
|
|
5611
|
+
type: string
|
|
5612
|
+
type:
|
|
5613
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationHttpType'
|
|
5614
|
+
required:
|
|
5615
|
+
- type
|
|
5616
|
+
- endpoint
|
|
5617
|
+
- auth
|
|
5618
|
+
type: object
|
|
5619
|
+
CustomDestinationForwardDestinationHttpType:
|
|
5620
|
+
default: http
|
|
5621
|
+
description: Type of the HTTP destination.
|
|
5622
|
+
enum:
|
|
5623
|
+
- http
|
|
5624
|
+
example: http
|
|
5625
|
+
type: string
|
|
5626
|
+
x-enum-varnames:
|
|
5627
|
+
- HTTP
|
|
5628
|
+
CustomDestinationForwardDestinationSplunk:
|
|
5629
|
+
description: The Splunk HTTP Event Collector (HEC) destination.
|
|
5630
|
+
properties:
|
|
5631
|
+
access_token:
|
|
5632
|
+
description: Access token of the Splunk HTTP Event Collector. This field
|
|
5633
|
+
is not returned by the API.
|
|
5634
|
+
example: splunk_access_token
|
|
5635
|
+
type: string
|
|
5636
|
+
writeOnly: true
|
|
5637
|
+
endpoint:
|
|
5638
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5639
|
+
|
|
5640
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5641
|
+
example: https://example.com
|
|
5642
|
+
type: string
|
|
5643
|
+
type:
|
|
5644
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationSplunkType'
|
|
5645
|
+
required:
|
|
5646
|
+
- type
|
|
5647
|
+
- endpoint
|
|
5648
|
+
- access_token
|
|
5649
|
+
type: object
|
|
5650
|
+
CustomDestinationForwardDestinationSplunkType:
|
|
5651
|
+
default: splunk_hec
|
|
5652
|
+
description: Type of the Splunk HTTP Event Collector (HEC) destination.
|
|
5653
|
+
enum:
|
|
5654
|
+
- splunk_hec
|
|
5655
|
+
example: splunk_hec
|
|
5656
|
+
type: string
|
|
5657
|
+
x-enum-varnames:
|
|
5658
|
+
- SPLUNK_HEC
|
|
5659
|
+
CustomDestinationHttpDestinationAuth:
|
|
5660
|
+
description: Authentication method of the HTTP requests.
|
|
5661
|
+
oneOf:
|
|
5662
|
+
- $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasic'
|
|
5663
|
+
- $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader'
|
|
5664
|
+
type: object
|
|
5665
|
+
CustomDestinationHttpDestinationAuthBasic:
|
|
5666
|
+
description: Basic access authentication.
|
|
5667
|
+
properties:
|
|
5668
|
+
password:
|
|
5669
|
+
description: The password of the authentication. This field is not returned
|
|
5670
|
+
by the API.
|
|
5671
|
+
example: datadog-custom-destination-password
|
|
5672
|
+
type: string
|
|
5673
|
+
writeOnly: true
|
|
5674
|
+
type:
|
|
5675
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasicType'
|
|
5676
|
+
username:
|
|
5677
|
+
description: The username of the authentication. This field is not returned
|
|
5678
|
+
by the API.
|
|
5679
|
+
example: datadog-custom-destination-username
|
|
5680
|
+
type: string
|
|
5681
|
+
writeOnly: true
|
|
5682
|
+
required:
|
|
5683
|
+
- type
|
|
5684
|
+
- username
|
|
5685
|
+
- password
|
|
5686
|
+
type: object
|
|
5687
|
+
CustomDestinationHttpDestinationAuthBasicType:
|
|
5688
|
+
default: basic
|
|
5689
|
+
description: Type of the basic access authentication.
|
|
5690
|
+
enum:
|
|
5691
|
+
- basic
|
|
5692
|
+
example: basic
|
|
5693
|
+
type: string
|
|
5694
|
+
x-enum-varnames:
|
|
5695
|
+
- BASIC
|
|
5696
|
+
CustomDestinationHttpDestinationAuthCustomHeader:
|
|
5697
|
+
description: Custom header access authentication.
|
|
5698
|
+
properties:
|
|
5699
|
+
header_name:
|
|
5700
|
+
description: The header name of the authentication.
|
|
5701
|
+
example: CUSTOM-HEADER-NAME
|
|
5702
|
+
type: string
|
|
5703
|
+
header_value:
|
|
5704
|
+
description: The header value of the authentication. This field is not returned
|
|
5705
|
+
by the API.
|
|
5706
|
+
example: CUSTOM-HEADER-AUTHENTICATION-VALUE
|
|
5707
|
+
type: string
|
|
5708
|
+
writeOnly: true
|
|
5709
|
+
type:
|
|
5710
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeaderType'
|
|
5711
|
+
required:
|
|
5712
|
+
- type
|
|
5713
|
+
- header_name
|
|
5714
|
+
- header_value
|
|
5715
|
+
type: object
|
|
5716
|
+
CustomDestinationHttpDestinationAuthCustomHeaderType:
|
|
5717
|
+
default: custom_header
|
|
5718
|
+
description: Type of the custom header access authentication.
|
|
5719
|
+
enum:
|
|
5720
|
+
- custom_header
|
|
5721
|
+
example: custom_header
|
|
5722
|
+
type: string
|
|
5723
|
+
x-enum-varnames:
|
|
5724
|
+
- CUSTOM_HEADER
|
|
5725
|
+
CustomDestinationResponse:
|
|
5726
|
+
description: The custom destination.
|
|
5727
|
+
properties:
|
|
5728
|
+
data:
|
|
5729
|
+
$ref: '#/components/schemas/CustomDestinationResponseDefinition'
|
|
5730
|
+
type: object
|
|
5731
|
+
CustomDestinationResponseAttributes:
|
|
5732
|
+
description: The attributes associated with the custom destination.
|
|
5733
|
+
properties:
|
|
5734
|
+
enabled:
|
|
5735
|
+
default: true
|
|
5736
|
+
description: Whether logs matching this custom destination should be forwarded
|
|
5737
|
+
or not.
|
|
5738
|
+
example: true
|
|
5739
|
+
type: boolean
|
|
5740
|
+
forward_tags:
|
|
5741
|
+
default: true
|
|
5742
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
|
5743
|
+
not.
|
|
5744
|
+
example: true
|
|
5745
|
+
type: boolean
|
|
5746
|
+
forward_tags_restriction_list:
|
|
5747
|
+
default: []
|
|
5748
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
|
5749
|
+
to be filtered.
|
|
5750
|
+
|
|
5751
|
+
|
|
5752
|
+
An empty list represents no restriction is in place and either all or
|
|
5753
|
+
no tags will be
|
|
5754
|
+
|
|
5755
|
+
forwarded depending on `forward_tags_restriction_list_type` parameter.'
|
|
5756
|
+
example:
|
|
5757
|
+
- datacenter
|
|
5758
|
+
- host
|
|
5759
|
+
items:
|
|
5760
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
|
5761
|
+
type: string
|
|
5762
|
+
maxItems: 10
|
|
5763
|
+
minItems: 0
|
|
5764
|
+
type: array
|
|
5765
|
+
forward_tags_restriction_list_type:
|
|
5766
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
|
5767
|
+
forwarder_destination:
|
|
5768
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestination'
|
|
5769
|
+
name:
|
|
5770
|
+
description: The custom destination name.
|
|
5771
|
+
example: Nginx logs
|
|
5772
|
+
type: string
|
|
5773
|
+
query:
|
|
5774
|
+
default: ''
|
|
5775
|
+
description: The custom destination query filter. Logs matching this query
|
|
5776
|
+
are forwarded to the destination.
|
|
5777
|
+
example: source:nginx
|
|
5778
|
+
type: string
|
|
5779
|
+
type: object
|
|
5780
|
+
CustomDestinationResponseDefinition:
|
|
5781
|
+
description: The definition of a custom destination.
|
|
5782
|
+
properties:
|
|
5783
|
+
attributes:
|
|
5784
|
+
$ref: '#/components/schemas/CustomDestinationResponseAttributes'
|
|
5785
|
+
id:
|
|
5786
|
+
description: The custom destination ID.
|
|
5787
|
+
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
|
|
5788
|
+
readOnly: true
|
|
5789
|
+
type: string
|
|
5790
|
+
type:
|
|
5791
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
|
5792
|
+
type: object
|
|
5793
|
+
CustomDestinationResponseElasticsearchDestinationAuth:
|
|
5794
|
+
additionalProperties:
|
|
5795
|
+
description: Basic access authentication.
|
|
5796
|
+
description: Basic access authentication.
|
|
5797
|
+
type: object
|
|
5798
|
+
CustomDestinationResponseForwardDestination:
|
|
5799
|
+
description: A custom destination's location to forward logs.
|
|
5800
|
+
oneOf:
|
|
5801
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp'
|
|
5802
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk'
|
|
5803
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch'
|
|
5804
|
+
type: object
|
|
5805
|
+
CustomDestinationResponseForwardDestinationElasticsearch:
|
|
5806
|
+
description: The Elasticsearch destination.
|
|
5807
|
+
properties:
|
|
5808
|
+
auth:
|
|
5809
|
+
$ref: '#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth'
|
|
5810
|
+
endpoint:
|
|
5811
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5812
|
+
|
|
5813
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5814
|
+
example: https://example.com
|
|
5815
|
+
type: string
|
|
5816
|
+
index_name:
|
|
5817
|
+
description: Name of the Elasticsearch index (must follow [Elasticsearch's
|
|
5818
|
+
criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
|
|
5819
|
+
example: nginx-logs
|
|
5820
|
+
type: string
|
|
5821
|
+
index_rotation:
|
|
5822
|
+
description: 'Date pattern with US locale and UTC timezone to be appended
|
|
5823
|
+
to the index name after adding `-`
|
|
5824
|
+
|
|
5825
|
+
(that is, `${index_name}-${indexPattern}`).
|
|
5826
|
+
|
|
5827
|
+
You can customize the index rotation naming pattern by choosing one of
|
|
5828
|
+
these options:
|
|
5829
|
+
|
|
5830
|
+
- Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
|
|
5831
|
+
|
|
5832
|
+
- Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
|
|
5833
|
+
|
|
5834
|
+
- Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`)
|
|
5835
|
+
|
|
5836
|
+
- Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
|
|
5837
|
+
|
|
5838
|
+
|
|
5839
|
+
If this field is missing or is blank, it means that the index name will
|
|
5840
|
+
always be the same
|
|
5841
|
+
|
|
5842
|
+
(that is, no rotation).'
|
|
5843
|
+
example: yyyy-MM-dd
|
|
5844
|
+
type: string
|
|
5845
|
+
type:
|
|
5846
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType'
|
|
5847
|
+
required:
|
|
5848
|
+
- type
|
|
5849
|
+
- endpoint
|
|
5850
|
+
- auth
|
|
5851
|
+
- index_name
|
|
5852
|
+
type: object
|
|
5853
|
+
CustomDestinationResponseForwardDestinationElasticsearchType:
|
|
5854
|
+
default: elasticsearch
|
|
5855
|
+
description: Type of the Elasticsearch destination.
|
|
5856
|
+
enum:
|
|
5857
|
+
- elasticsearch
|
|
5858
|
+
example: elasticsearch
|
|
5859
|
+
type: string
|
|
5860
|
+
x-enum-varnames:
|
|
5861
|
+
- ELASTICSEARCH
|
|
5862
|
+
CustomDestinationResponseForwardDestinationHttp:
|
|
5863
|
+
description: The HTTP destination.
|
|
5864
|
+
properties:
|
|
5865
|
+
auth:
|
|
5866
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuth'
|
|
5867
|
+
endpoint:
|
|
5868
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5869
|
+
|
|
5870
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5871
|
+
example: https://example.com
|
|
5872
|
+
type: string
|
|
5873
|
+
type:
|
|
5874
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttpType'
|
|
5875
|
+
required:
|
|
5876
|
+
- type
|
|
5877
|
+
- endpoint
|
|
5878
|
+
- auth
|
|
5879
|
+
type: object
|
|
5880
|
+
CustomDestinationResponseForwardDestinationHttpType:
|
|
5881
|
+
default: http
|
|
5882
|
+
description: Type of the HTTP destination.
|
|
5883
|
+
enum:
|
|
5884
|
+
- http
|
|
5885
|
+
example: http
|
|
5886
|
+
type: string
|
|
5887
|
+
x-enum-varnames:
|
|
5888
|
+
- HTTP
|
|
5889
|
+
CustomDestinationResponseForwardDestinationSplunk:
|
|
5890
|
+
description: The Splunk HTTP Event Collector (HEC) destination.
|
|
5891
|
+
properties:
|
|
5892
|
+
endpoint:
|
|
5893
|
+
description: 'The destination for which logs will be forwarded to.
|
|
5894
|
+
|
|
5895
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
|
5896
|
+
example: https://example.com
|
|
5897
|
+
type: string
|
|
5898
|
+
type:
|
|
5899
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType'
|
|
5900
|
+
required:
|
|
5901
|
+
- type
|
|
5902
|
+
- endpoint
|
|
5903
|
+
type: object
|
|
5904
|
+
CustomDestinationResponseForwardDestinationSplunkType:
|
|
5905
|
+
default: splunk_hec
|
|
5906
|
+
description: Type of the Splunk HTTP Event Collector (HEC) destination.
|
|
5907
|
+
enum:
|
|
5908
|
+
- splunk_hec
|
|
5909
|
+
example: splunk_hec
|
|
5910
|
+
type: string
|
|
5911
|
+
x-enum-varnames:
|
|
5912
|
+
- SPLUNK_HEC
|
|
5913
|
+
CustomDestinationResponseHttpDestinationAuth:
|
|
5914
|
+
description: Authentication method of the HTTP requests.
|
|
5915
|
+
oneOf:
|
|
5916
|
+
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic'
|
|
5917
|
+
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader'
|
|
5918
|
+
type: object
|
|
5919
|
+
CustomDestinationResponseHttpDestinationAuthBasic:
|
|
5920
|
+
description: Basic access authentication.
|
|
5921
|
+
properties:
|
|
5922
|
+
type:
|
|
5923
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType'
|
|
5924
|
+
required:
|
|
5925
|
+
- type
|
|
5926
|
+
type: object
|
|
5927
|
+
CustomDestinationResponseHttpDestinationAuthBasicType:
|
|
5928
|
+
default: basic
|
|
5929
|
+
description: Type of the basic access authentication.
|
|
5930
|
+
enum:
|
|
5931
|
+
- basic
|
|
5932
|
+
example: basic
|
|
5933
|
+
type: string
|
|
5934
|
+
x-enum-varnames:
|
|
5935
|
+
- BASIC
|
|
5936
|
+
CustomDestinationResponseHttpDestinationAuthCustomHeader:
|
|
5937
|
+
description: Custom header access authentication.
|
|
5938
|
+
properties:
|
|
5939
|
+
header_name:
|
|
5940
|
+
description: The header name of the authentication.
|
|
5941
|
+
example: CUSTOM-HEADER-NAME
|
|
5942
|
+
type: string
|
|
5943
|
+
type:
|
|
5944
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType'
|
|
5945
|
+
required:
|
|
5946
|
+
- type
|
|
5947
|
+
- header_name
|
|
5948
|
+
type: object
|
|
5949
|
+
CustomDestinationResponseHttpDestinationAuthCustomHeaderType:
|
|
5950
|
+
default: custom_header
|
|
5951
|
+
description: Type of the custom header access authentication.
|
|
5952
|
+
enum:
|
|
5953
|
+
- custom_header
|
|
5954
|
+
example: custom_header
|
|
5955
|
+
type: string
|
|
5956
|
+
x-enum-varnames:
|
|
5957
|
+
- CUSTOM_HEADER
|
|
5958
|
+
CustomDestinationType:
|
|
5959
|
+
default: custom_destination
|
|
5960
|
+
description: The type of the resource. The value should always be `custom_destination`.
|
|
5961
|
+
enum:
|
|
5962
|
+
- custom_destination
|
|
5963
|
+
example: custom_destination
|
|
5964
|
+
type: string
|
|
5965
|
+
x-enum-varnames:
|
|
5966
|
+
- CUSTOM_DESTINATION
|
|
5967
|
+
CustomDestinationUpdateRequest:
|
|
5968
|
+
description: The custom destination.
|
|
5969
|
+
properties:
|
|
5970
|
+
data:
|
|
5971
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequestDefinition'
|
|
5972
|
+
type: object
|
|
5973
|
+
CustomDestinationUpdateRequestAttributes:
|
|
5974
|
+
description: The attributes associated with the custom destination.
|
|
5975
|
+
properties:
|
|
5976
|
+
enabled:
|
|
5977
|
+
default: true
|
|
5978
|
+
description: Whether logs matching this custom destination should be forwarded
|
|
5979
|
+
or not.
|
|
5980
|
+
example: true
|
|
5981
|
+
type: boolean
|
|
5982
|
+
forward_tags:
|
|
5983
|
+
default: true
|
|
5984
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
|
5985
|
+
not.
|
|
5986
|
+
example: true
|
|
5987
|
+
type: boolean
|
|
5988
|
+
forward_tags_restriction_list:
|
|
5989
|
+
default: []
|
|
5990
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
|
5991
|
+
to be restricted from being forwarded.
|
|
5992
|
+
|
|
5993
|
+
An empty list represents no restriction is in place and either all or
|
|
5994
|
+
no tags will be forwarded depending on `forward_tags_restriction_list_type`
|
|
5995
|
+
parameter.'
|
|
5996
|
+
example:
|
|
5997
|
+
- datacenter
|
|
5998
|
+
- host
|
|
5999
|
+
items:
|
|
6000
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
|
6001
|
+
type: string
|
|
6002
|
+
maxItems: 10
|
|
6003
|
+
minItems: 0
|
|
6004
|
+
type: array
|
|
6005
|
+
forward_tags_restriction_list_type:
|
|
6006
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
|
6007
|
+
forwarder_destination:
|
|
6008
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestination'
|
|
6009
|
+
name:
|
|
6010
|
+
description: The custom destination name.
|
|
6011
|
+
example: Nginx logs
|
|
6012
|
+
type: string
|
|
6013
|
+
query:
|
|
6014
|
+
default: ''
|
|
6015
|
+
description: The custom destination query and filter. Logs matching this
|
|
6016
|
+
query are forwarded to the destination.
|
|
6017
|
+
example: source:nginx
|
|
6018
|
+
type: string
|
|
6019
|
+
type: object
|
|
6020
|
+
CustomDestinationUpdateRequestDefinition:
|
|
6021
|
+
description: The definition of a custom destination.
|
|
6022
|
+
properties:
|
|
6023
|
+
attributes:
|
|
6024
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequestAttributes'
|
|
6025
|
+
id:
|
|
6026
|
+
description: The custom destination ID.
|
|
6027
|
+
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
|
|
6028
|
+
type: string
|
|
6029
|
+
type:
|
|
6030
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
|
6031
|
+
required:
|
|
6032
|
+
- type
|
|
6033
|
+
- id
|
|
6034
|
+
type: object
|
|
6035
|
+
CustomDestinationsResponse:
|
|
6036
|
+
description: The available custom destinations.
|
|
6037
|
+
properties:
|
|
6038
|
+
data:
|
|
6039
|
+
description: A list of custom destinations.
|
|
6040
|
+
items:
|
|
6041
|
+
$ref: '#/components/schemas/CustomDestinationResponseDefinition'
|
|
6042
|
+
type: array
|
|
6043
|
+
type: object
|
|
4950
6044
|
DORADeploymentRequest:
|
|
4951
6045
|
description: Request to create a DORA deployment event.
|
|
4952
6046
|
properties:
|
|
@@ -4964,7 +6058,7 @@ components:
|
|
|
4964
6058
|
type: string
|
|
4965
6059
|
finished_at:
|
|
4966
6060
|
description: Unix timestamp in nanoseconds when the deployment finished.
|
|
4967
|
-
It should not be older than
|
|
6061
|
+
It should not be older than 1 hour.
|
|
4968
6062
|
example: 1693491984000000000
|
|
4969
6063
|
format: int64
|
|
4970
6064
|
type: integer
|
|
@@ -5063,16 +6157,21 @@ components:
|
|
|
5063
6157
|
git:
|
|
5064
6158
|
$ref: '#/components/schemas/DORAGitInfo'
|
|
5065
6159
|
id:
|
|
5066
|
-
description: Incident ID
|
|
6160
|
+
description: Incident ID. Required to update a previously sent incident.
|
|
5067
6161
|
type: string
|
|
5068
6162
|
name:
|
|
5069
6163
|
description: Incident name.
|
|
5070
|
-
example: Webserver is down failing all requests
|
|
5071
|
-
type: string
|
|
5072
|
-
service:
|
|
5073
|
-
description: Service name from a service available in the Service Catalog.
|
|
5074
|
-
example: shopist
|
|
6164
|
+
example: Webserver is down failing all requests.
|
|
5075
6165
|
type: string
|
|
6166
|
+
services:
|
|
6167
|
+
description: Service names impacted by the incident. If possible, use names
|
|
6168
|
+
registered in the Service Catalog. Required when the team field is not
|
|
6169
|
+
provided.
|
|
6170
|
+
example:
|
|
6171
|
+
- shopist
|
|
6172
|
+
items:
|
|
6173
|
+
type: string
|
|
6174
|
+
type: array
|
|
5076
6175
|
severity:
|
|
5077
6176
|
description: Incident severity.
|
|
5078
6177
|
example: High
|
|
@@ -5082,12 +6181,17 @@ components:
|
|
|
5082
6181
|
example: 1693491974000000000
|
|
5083
6182
|
format: int64
|
|
5084
6183
|
type: integer
|
|
6184
|
+
team:
|
|
6185
|
+
description: Name of the team owning the services impacted. If possible,
|
|
6186
|
+
use team handles registered in Datadog. Required when the services field
|
|
6187
|
+
is not provided.
|
|
6188
|
+
example: backend
|
|
6189
|
+
type: string
|
|
5085
6190
|
version:
|
|
5086
6191
|
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
|
5087
6192
|
example: v1.12.07
|
|
5088
6193
|
type: string
|
|
5089
6194
|
required:
|
|
5090
|
-
- service
|
|
5091
6195
|
- started_at
|
|
5092
6196
|
type: object
|
|
5093
6197
|
DORAIncidentRequestData:
|
|
@@ -5741,7 +6845,7 @@ components:
|
|
|
5741
6845
|
type: string
|
|
5742
6846
|
type: object
|
|
5743
6847
|
DowntimeScheduleOneTimeCreateUpdateRequest:
|
|
5744
|
-
additionalProperties:
|
|
6848
|
+
additionalProperties: false
|
|
5745
6849
|
description: A one-time downtime definition.
|
|
5746
6850
|
properties:
|
|
5747
6851
|
end:
|
|
@@ -5876,6 +6980,7 @@ components:
|
|
|
5876
6980
|
- recurrences
|
|
5877
6981
|
type: object
|
|
5878
6982
|
DowntimeScheduleRecurrencesUpdateRequest:
|
|
6983
|
+
additionalProperties: false
|
|
5879
6984
|
description: A recurring downtime schedule definition.
|
|
5880
6985
|
properties:
|
|
5881
6986
|
recurrences:
|
|
@@ -7016,6 +8121,18 @@ components:
|
|
|
7016
8121
|
description: Your service account email address.
|
|
7017
8122
|
example: datadog-service-account@test-project.iam.gserviceaccount.com
|
|
7018
8123
|
type: string
|
|
8124
|
+
cloud_run_revision_filters:
|
|
8125
|
+
description: 'List of filters to limit the Cloud Run revisions that are
|
|
8126
|
+
pulled into Datadog by using tags.
|
|
8127
|
+
|
|
8128
|
+
Only Cloud Run revision resources that apply to specified filters are
|
|
8129
|
+
imported into Datadog.'
|
|
8130
|
+
example:
|
|
8131
|
+
- $KEY:$VALUE
|
|
8132
|
+
items:
|
|
8133
|
+
description: Cloud Run Filters
|
|
8134
|
+
type: string
|
|
8135
|
+
type: array
|
|
7019
8136
|
host_filters:
|
|
7020
8137
|
description: Your Host Filters.
|
|
7021
8138
|
items:
|
|
@@ -9344,6 +10461,32 @@ components:
|
|
|
9344
10461
|
- project_key
|
|
9345
10462
|
- account
|
|
9346
10463
|
type: object
|
|
10464
|
+
JiraIssue:
|
|
10465
|
+
description: Jira issue attached to case
|
|
10466
|
+
nullable: true
|
|
10467
|
+
properties:
|
|
10468
|
+
result:
|
|
10469
|
+
$ref: '#/components/schemas/JiraIssueResult'
|
|
10470
|
+
status:
|
|
10471
|
+
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
|
|
10472
|
+
readOnly: true
|
|
10473
|
+
type: object
|
|
10474
|
+
JiraIssueResult:
|
|
10475
|
+
description: Jira issue information
|
|
10476
|
+
properties:
|
|
10477
|
+
issue_id:
|
|
10478
|
+
description: Jira issue ID
|
|
10479
|
+
type: string
|
|
10480
|
+
issue_key:
|
|
10481
|
+
description: Jira issue key
|
|
10482
|
+
type: string
|
|
10483
|
+
issue_url:
|
|
10484
|
+
description: Jira issue URL
|
|
10485
|
+
type: string
|
|
10486
|
+
project_key:
|
|
10487
|
+
description: Jira project key
|
|
10488
|
+
type: string
|
|
10489
|
+
type: object
|
|
9347
10490
|
ListApplicationKeysResponse:
|
|
9348
10491
|
description: Response for a list of application keys.
|
|
9349
10492
|
properties:
|
|
@@ -9999,7 +11142,6 @@ components:
|
|
|
9999
11142
|
example: project-id
|
|
10000
11143
|
type: string
|
|
10001
11144
|
required:
|
|
10002
|
-
- project_id
|
|
10003
11145
|
- client_email
|
|
10004
11146
|
type: object
|
|
10005
11147
|
LogsArchiveIntegrationS3:
|
|
@@ -10672,6 +11814,136 @@ components:
|
|
|
10672
11814
|
$ref: '#/components/schemas/MetricAllTags'
|
|
10673
11815
|
readOnly: true
|
|
10674
11816
|
type: object
|
|
11817
|
+
MetricAssetAttributes:
|
|
11818
|
+
description: Assets where only included attribute is its title
|
|
11819
|
+
properties:
|
|
11820
|
+
title:
|
|
11821
|
+
description: Title of the asset.
|
|
11822
|
+
type: string
|
|
11823
|
+
type: object
|
|
11824
|
+
MetricAssetDashboardRelationship:
|
|
11825
|
+
description: An object of type `dashboard` that can be referenced in the `included`
|
|
11826
|
+
data.
|
|
11827
|
+
properties:
|
|
11828
|
+
id:
|
|
11829
|
+
$ref: '#/components/schemas/MetricDashboardID'
|
|
11830
|
+
type:
|
|
11831
|
+
$ref: '#/components/schemas/MetricDashboardType'
|
|
11832
|
+
type: object
|
|
11833
|
+
MetricAssetDashboardRelationships:
|
|
11834
|
+
description: An object containing the list of dashboards that can be referenced
|
|
11835
|
+
in the `included` data.
|
|
11836
|
+
properties:
|
|
11837
|
+
data:
|
|
11838
|
+
description: A list of dashboards that can be referenced in the `included`
|
|
11839
|
+
data.
|
|
11840
|
+
items:
|
|
11841
|
+
$ref: '#/components/schemas/MetricAssetDashboardRelationship'
|
|
11842
|
+
type: array
|
|
11843
|
+
type: object
|
|
11844
|
+
MetricAssetMonitorRelationship:
|
|
11845
|
+
description: An object of type `monitor` that can be referenced in the `included`
|
|
11846
|
+
data.
|
|
11847
|
+
properties:
|
|
11848
|
+
id:
|
|
11849
|
+
$ref: '#/components/schemas/MetricMonitorID'
|
|
11850
|
+
type:
|
|
11851
|
+
$ref: '#/components/schemas/MetricMonitorType'
|
|
11852
|
+
type: object
|
|
11853
|
+
MetricAssetMonitorRelationships:
|
|
11854
|
+
description: A object containing the list of monitors that can be referenced
|
|
11855
|
+
in the `included` data.
|
|
11856
|
+
properties:
|
|
11857
|
+
data:
|
|
11858
|
+
description: A list of monitors that can be referenced in the `included`
|
|
11859
|
+
data.
|
|
11860
|
+
items:
|
|
11861
|
+
$ref: '#/components/schemas/MetricAssetMonitorRelationship'
|
|
11862
|
+
type: array
|
|
11863
|
+
type: object
|
|
11864
|
+
MetricAssetNotebookRelationship:
|
|
11865
|
+
description: An object of type `notebook` that can be referenced in the `included`
|
|
11866
|
+
data.
|
|
11867
|
+
properties:
|
|
11868
|
+
id:
|
|
11869
|
+
$ref: '#/components/schemas/MetricNotebookID'
|
|
11870
|
+
type:
|
|
11871
|
+
$ref: '#/components/schemas/MetricNotebookType'
|
|
11872
|
+
type: object
|
|
11873
|
+
MetricAssetNotebookRelationships:
|
|
11874
|
+
description: An object containing the list of notebooks that can be referenced
|
|
11875
|
+
in the `included` data.
|
|
11876
|
+
properties:
|
|
11877
|
+
data:
|
|
11878
|
+
description: A list of notebooks that can be referenced in the `included`
|
|
11879
|
+
data.
|
|
11880
|
+
items:
|
|
11881
|
+
$ref: '#/components/schemas/MetricAssetNotebookRelationship'
|
|
11882
|
+
type: array
|
|
11883
|
+
type: object
|
|
11884
|
+
MetricAssetResponseData:
|
|
11885
|
+
description: Metric assets response data.
|
|
11886
|
+
properties:
|
|
11887
|
+
id:
|
|
11888
|
+
$ref: '#/components/schemas/MetricName'
|
|
11889
|
+
relationships:
|
|
11890
|
+
$ref: '#/components/schemas/MetricAssetResponseRelationships'
|
|
11891
|
+
type:
|
|
11892
|
+
$ref: '#/components/schemas/MetricType'
|
|
11893
|
+
required:
|
|
11894
|
+
- id
|
|
11895
|
+
- type
|
|
11896
|
+
type: object
|
|
11897
|
+
MetricAssetResponseIncluded:
|
|
11898
|
+
description: List of included assets with full set of attributes.
|
|
11899
|
+
oneOf:
|
|
11900
|
+
- $ref: '#/components/schemas/MetricDashboardAsset'
|
|
11901
|
+
- $ref: '#/components/schemas/MetricMonitorAsset'
|
|
11902
|
+
- $ref: '#/components/schemas/MetricNotebookAsset'
|
|
11903
|
+
- $ref: '#/components/schemas/MetricSLOAsset'
|
|
11904
|
+
MetricAssetResponseRelationships:
|
|
11905
|
+
description: Relationships to assets related to the metric.
|
|
11906
|
+
properties:
|
|
11907
|
+
dashboards:
|
|
11908
|
+
$ref: '#/components/schemas/MetricAssetDashboardRelationships'
|
|
11909
|
+
monitors:
|
|
11910
|
+
$ref: '#/components/schemas/MetricAssetMonitorRelationships'
|
|
11911
|
+
notebooks:
|
|
11912
|
+
$ref: '#/components/schemas/MetricAssetNotebookRelationships'
|
|
11913
|
+
slos:
|
|
11914
|
+
$ref: '#/components/schemas/MetricAssetSLORelationships'
|
|
11915
|
+
type: object
|
|
11916
|
+
MetricAssetSLORelationship:
|
|
11917
|
+
description: An object of type `slos` that can be referenced in the `included`
|
|
11918
|
+
data.
|
|
11919
|
+
properties:
|
|
11920
|
+
id:
|
|
11921
|
+
$ref: '#/components/schemas/MetricSLOID'
|
|
11922
|
+
type:
|
|
11923
|
+
$ref: '#/components/schemas/MetricSLOType'
|
|
11924
|
+
type: object
|
|
11925
|
+
MetricAssetSLORelationships:
|
|
11926
|
+
description: An object containing a list of SLOs that can be referenced in the
|
|
11927
|
+
`included` data.
|
|
11928
|
+
properties:
|
|
11929
|
+
data:
|
|
11930
|
+
description: A list of SLOs that can be referenced in the `included` data.
|
|
11931
|
+
items:
|
|
11932
|
+
$ref: '#/components/schemas/MetricAssetSLORelationship'
|
|
11933
|
+
type: array
|
|
11934
|
+
type: object
|
|
11935
|
+
MetricAssetsResponse:
|
|
11936
|
+
description: Response object that includes related dashboards, monitors, notebooks,
|
|
11937
|
+
and SLOs.
|
|
11938
|
+
properties:
|
|
11939
|
+
data:
|
|
11940
|
+
$ref: '#/components/schemas/MetricAssetResponseData'
|
|
11941
|
+
included:
|
|
11942
|
+
description: Array of objects related to the metric assets.
|
|
11943
|
+
items:
|
|
11944
|
+
$ref: '#/components/schemas/MetricAssetResponseIncluded'
|
|
11945
|
+
type: array
|
|
11946
|
+
type: object
|
|
10675
11947
|
MetricBulkConfigureTagsType:
|
|
10676
11948
|
default: metric_bulk_configure_tags
|
|
10677
11949
|
description: The metric bulk configure tags resource.
|
|
@@ -10913,6 +12185,44 @@ components:
|
|
|
10913
12185
|
- MAX
|
|
10914
12186
|
- MIN
|
|
10915
12187
|
- SUM
|
|
12188
|
+
MetricDashboardAsset:
|
|
12189
|
+
description: A dashboard object with title and popularity.
|
|
12190
|
+
properties:
|
|
12191
|
+
attributes:
|
|
12192
|
+
$ref: '#/components/schemas/MetricDashboardAttributes'
|
|
12193
|
+
id:
|
|
12194
|
+
$ref: '#/components/schemas/MetricDashboardID'
|
|
12195
|
+
type:
|
|
12196
|
+
$ref: '#/components/schemas/MetricDashboardType'
|
|
12197
|
+
required:
|
|
12198
|
+
- id
|
|
12199
|
+
- type
|
|
12200
|
+
type: object
|
|
12201
|
+
MetricDashboardAttributes:
|
|
12202
|
+
description: Attributes related to the dashboard, including title and popularity.
|
|
12203
|
+
properties:
|
|
12204
|
+
popularity:
|
|
12205
|
+
description: Value from 0 to 5 that ranks popularity of the dashboard.
|
|
12206
|
+
format: double
|
|
12207
|
+
maximum: 5
|
|
12208
|
+
minimum: 0
|
|
12209
|
+
type: number
|
|
12210
|
+
title:
|
|
12211
|
+
description: Title of the asset.
|
|
12212
|
+
type: string
|
|
12213
|
+
type: object
|
|
12214
|
+
MetricDashboardID:
|
|
12215
|
+
description: The related dashboard's ID.
|
|
12216
|
+
example: xxx-yyy-zzz
|
|
12217
|
+
type: string
|
|
12218
|
+
MetricDashboardType:
|
|
12219
|
+
description: Dashboard resource type.
|
|
12220
|
+
enum:
|
|
12221
|
+
- dashboards
|
|
12222
|
+
example: dashboards
|
|
12223
|
+
type: string
|
|
12224
|
+
x-enum-varnames:
|
|
12225
|
+
- DASHBOARDS
|
|
10916
12226
|
MetricDistinctVolume:
|
|
10917
12227
|
description: Object for a single metric's distinct volume.
|
|
10918
12228
|
properties:
|
|
@@ -11053,10 +12363,60 @@ components:
|
|
|
11053
12363
|
origin:
|
|
11054
12364
|
$ref: '#/components/schemas/MetricOrigin'
|
|
11055
12365
|
type: object
|
|
12366
|
+
MetricMonitorAsset:
|
|
12367
|
+
description: A monitor object with title.
|
|
12368
|
+
properties:
|
|
12369
|
+
attributes:
|
|
12370
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
|
12371
|
+
id:
|
|
12372
|
+
$ref: '#/components/schemas/MetricMonitorID'
|
|
12373
|
+
type:
|
|
12374
|
+
$ref: '#/components/schemas/MetricMonitorType'
|
|
12375
|
+
required:
|
|
12376
|
+
- id
|
|
12377
|
+
- type
|
|
12378
|
+
type: object
|
|
12379
|
+
MetricMonitorID:
|
|
12380
|
+
description: The related monitor's ID.
|
|
12381
|
+
example: '1775073'
|
|
12382
|
+
type: string
|
|
12383
|
+
MetricMonitorType:
|
|
12384
|
+
description: Monitor resource type.
|
|
12385
|
+
enum:
|
|
12386
|
+
- monitors
|
|
12387
|
+
example: monitors
|
|
12388
|
+
type: string
|
|
12389
|
+
x-enum-varnames:
|
|
12390
|
+
- MONITORS
|
|
11056
12391
|
MetricName:
|
|
11057
12392
|
description: The metric name for this resource.
|
|
11058
12393
|
example: test.metric.latency
|
|
11059
12394
|
type: string
|
|
12395
|
+
MetricNotebookAsset:
|
|
12396
|
+
description: A notebook object with title.
|
|
12397
|
+
properties:
|
|
12398
|
+
attributes:
|
|
12399
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
|
12400
|
+
id:
|
|
12401
|
+
$ref: '#/components/schemas/MetricNotebookID'
|
|
12402
|
+
type:
|
|
12403
|
+
$ref: '#/components/schemas/MetricNotebookType'
|
|
12404
|
+
required:
|
|
12405
|
+
- id
|
|
12406
|
+
- type
|
|
12407
|
+
type: object
|
|
12408
|
+
MetricNotebookID:
|
|
12409
|
+
description: The related notebook's ID.
|
|
12410
|
+
example: '12345'
|
|
12411
|
+
type: string
|
|
12412
|
+
MetricNotebookType:
|
|
12413
|
+
description: Notebook resource type.
|
|
12414
|
+
enum:
|
|
12415
|
+
- notebooks
|
|
12416
|
+
example: notebooks
|
|
12417
|
+
type: string
|
|
12418
|
+
x-enum-varnames:
|
|
12419
|
+
- NOTEBOOKS
|
|
11060
12420
|
MetricOrigin:
|
|
11061
12421
|
description: Metric origin information.
|
|
11062
12422
|
properties:
|
|
@@ -11130,6 +12490,31 @@ components:
|
|
|
11130
12490
|
description: The type of the resource.
|
|
11131
12491
|
type: string
|
|
11132
12492
|
type: object
|
|
12493
|
+
MetricSLOAsset:
|
|
12494
|
+
description: A SLO object with title.
|
|
12495
|
+
properties:
|
|
12496
|
+
attributes:
|
|
12497
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
|
12498
|
+
id:
|
|
12499
|
+
$ref: '#/components/schemas/MetricSLOID'
|
|
12500
|
+
type:
|
|
12501
|
+
$ref: '#/components/schemas/MetricSLOType'
|
|
12502
|
+
required:
|
|
12503
|
+
- id
|
|
12504
|
+
- type
|
|
12505
|
+
type: object
|
|
12506
|
+
MetricSLOID:
|
|
12507
|
+
description: The SLO ID.
|
|
12508
|
+
example: 9ffef113b389520db54391d67d652dfb
|
|
12509
|
+
type: string
|
|
12510
|
+
MetricSLOType:
|
|
12511
|
+
description: SLO resource type.
|
|
12512
|
+
enum:
|
|
12513
|
+
- slos
|
|
12514
|
+
example: slos
|
|
12515
|
+
type: string
|
|
12516
|
+
x-enum-varnames:
|
|
12517
|
+
- SLOS
|
|
11133
12518
|
MetricSeries:
|
|
11134
12519
|
description: 'A metric to submit to Datadog.
|
|
11135
12520
|
|
|
@@ -11137,7 +12522,7 @@ components:
|
|
|
11137
12522
|
properties:
|
|
11138
12523
|
interval:
|
|
11139
12524
|
description: If the type of the metric is rate or count, define the corresponding
|
|
11140
|
-
interval.
|
|
12525
|
+
interval in seconds.
|
|
11141
12526
|
example: 20
|
|
11142
12527
|
format: int64
|
|
11143
12528
|
type: integer
|
|
@@ -11943,6 +13328,29 @@ components:
|
|
|
11943
13328
|
- id
|
|
11944
13329
|
- type
|
|
11945
13330
|
type: object
|
|
13331
|
+
NullableUserRelationship:
|
|
13332
|
+
description: Relationship to user.
|
|
13333
|
+
nullable: true
|
|
13334
|
+
properties:
|
|
13335
|
+
data:
|
|
13336
|
+
$ref: '#/components/schemas/NullableUserRelationshipData'
|
|
13337
|
+
required:
|
|
13338
|
+
- data
|
|
13339
|
+
type: object
|
|
13340
|
+
NullableUserRelationshipData:
|
|
13341
|
+
description: Relationship to user object.
|
|
13342
|
+
nullable: true
|
|
13343
|
+
properties:
|
|
13344
|
+
id:
|
|
13345
|
+
description: A unique identifier that represents the user.
|
|
13346
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
13347
|
+
type: string
|
|
13348
|
+
type:
|
|
13349
|
+
$ref: '#/components/schemas/UserResourceType'
|
|
13350
|
+
required:
|
|
13351
|
+
- id
|
|
13352
|
+
- type
|
|
13353
|
+
type: object
|
|
11946
13354
|
OktaAccount:
|
|
11947
13355
|
description: Schema for an Okta account.
|
|
11948
13356
|
properties:
|
|
@@ -13075,6 +14483,113 @@ components:
|
|
|
13075
14483
|
type: string
|
|
13076
14484
|
x-enum-varnames:
|
|
13077
14485
|
- PROCESS
|
|
14486
|
+
Project:
|
|
14487
|
+
description: A Project
|
|
14488
|
+
properties:
|
|
14489
|
+
attributes:
|
|
14490
|
+
$ref: '#/components/schemas/ProjectAttributes'
|
|
14491
|
+
id:
|
|
14492
|
+
description: The Project's identifier
|
|
14493
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
14494
|
+
type: string
|
|
14495
|
+
relationships:
|
|
14496
|
+
$ref: '#/components/schemas/ProjectRelationships'
|
|
14497
|
+
type:
|
|
14498
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
|
14499
|
+
required:
|
|
14500
|
+
- id
|
|
14501
|
+
- type
|
|
14502
|
+
- attributes
|
|
14503
|
+
type: object
|
|
14504
|
+
ProjectAttributes:
|
|
14505
|
+
description: Project attributes
|
|
14506
|
+
properties:
|
|
14507
|
+
key:
|
|
14508
|
+
description: The project's key
|
|
14509
|
+
example: CASEM
|
|
14510
|
+
type: string
|
|
14511
|
+
name:
|
|
14512
|
+
description: Project's name
|
|
14513
|
+
type: string
|
|
14514
|
+
type: object
|
|
14515
|
+
ProjectCreate:
|
|
14516
|
+
description: Project create
|
|
14517
|
+
properties:
|
|
14518
|
+
attributes:
|
|
14519
|
+
$ref: '#/components/schemas/ProjectCreateAttributes'
|
|
14520
|
+
type:
|
|
14521
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
|
14522
|
+
required:
|
|
14523
|
+
- attributes
|
|
14524
|
+
- type
|
|
14525
|
+
type: object
|
|
14526
|
+
ProjectCreateAttributes:
|
|
14527
|
+
description: Project creation attributes
|
|
14528
|
+
properties:
|
|
14529
|
+
key:
|
|
14530
|
+
description: Project's key. Cannot be "CASE"
|
|
14531
|
+
example: SEC
|
|
14532
|
+
type: string
|
|
14533
|
+
name:
|
|
14534
|
+
description: name
|
|
14535
|
+
example: Security Investigation
|
|
14536
|
+
type: string
|
|
14537
|
+
required:
|
|
14538
|
+
- name
|
|
14539
|
+
- key
|
|
14540
|
+
type: object
|
|
14541
|
+
ProjectCreateRequest:
|
|
14542
|
+
description: Project create request
|
|
14543
|
+
properties:
|
|
14544
|
+
data:
|
|
14545
|
+
$ref: '#/components/schemas/ProjectCreate'
|
|
14546
|
+
required:
|
|
14547
|
+
- data
|
|
14548
|
+
type: object
|
|
14549
|
+
ProjectRelationship:
|
|
14550
|
+
description: Relationship to project
|
|
14551
|
+
properties:
|
|
14552
|
+
data:
|
|
14553
|
+
$ref: '#/components/schemas/ProjectRelationshipData'
|
|
14554
|
+
required:
|
|
14555
|
+
- data
|
|
14556
|
+
type: object
|
|
14557
|
+
ProjectRelationshipData:
|
|
14558
|
+
description: Relationship to project object
|
|
14559
|
+
properties:
|
|
14560
|
+
id:
|
|
14561
|
+
description: A unique identifier that represents the project
|
|
14562
|
+
example: e555e290-ed65-49bd-ae18-8acbfcf18db7
|
|
14563
|
+
type: string
|
|
14564
|
+
type:
|
|
14565
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
|
14566
|
+
required:
|
|
14567
|
+
- id
|
|
14568
|
+
- type
|
|
14569
|
+
type: object
|
|
14570
|
+
ProjectRelationships:
|
|
14571
|
+
description: Project relationships
|
|
14572
|
+
properties:
|
|
14573
|
+
member_team:
|
|
14574
|
+
$ref: '#/components/schemas/RelationshipToTeamLinks'
|
|
14575
|
+
member_user:
|
|
14576
|
+
$ref: '#/components/schemas/UsersRelationship'
|
|
14577
|
+
type: object
|
|
14578
|
+
ProjectResourceType:
|
|
14579
|
+
default: project
|
|
14580
|
+
description: Project resource type
|
|
14581
|
+
enum:
|
|
14582
|
+
- project
|
|
14583
|
+
example: project
|
|
14584
|
+
type: string
|
|
14585
|
+
x-enum-varnames:
|
|
14586
|
+
- PROJECT
|
|
14587
|
+
ProjectResponse:
|
|
14588
|
+
description: Project response
|
|
14589
|
+
properties:
|
|
14590
|
+
data:
|
|
14591
|
+
$ref: '#/components/schemas/Project'
|
|
14592
|
+
type: object
|
|
13078
14593
|
ProjectedCost:
|
|
13079
14594
|
description: Projected Cost data.
|
|
13080
14595
|
properties:
|
|
@@ -13131,6 +14646,15 @@ components:
|
|
|
13131
14646
|
type: string
|
|
13132
14647
|
x-enum-varnames:
|
|
13133
14648
|
- PROJECt_COST
|
|
14649
|
+
ProjectsResponse:
|
|
14650
|
+
description: Response with projects
|
|
14651
|
+
properties:
|
|
14652
|
+
data:
|
|
14653
|
+
description: Projects response data
|
|
14654
|
+
items:
|
|
14655
|
+
$ref: '#/components/schemas/Project'
|
|
14656
|
+
type: array
|
|
14657
|
+
type: object
|
|
13134
14658
|
QueryFormula:
|
|
13135
14659
|
description: A formula for calculation based on one or more queries.
|
|
13136
14660
|
properties:
|
|
@@ -14221,6 +15745,22 @@ components:
|
|
|
14221
15745
|
- id
|
|
14222
15746
|
- type
|
|
14223
15747
|
type: object
|
|
15748
|
+
RelationshipToTeam:
|
|
15749
|
+
description: Relationship to team.
|
|
15750
|
+
properties:
|
|
15751
|
+
data:
|
|
15752
|
+
$ref: '#/components/schemas/RelationshipToTeamData'
|
|
15753
|
+
type: object
|
|
15754
|
+
RelationshipToTeamData:
|
|
15755
|
+
description: Relationship to Team object.
|
|
15756
|
+
properties:
|
|
15757
|
+
id:
|
|
15758
|
+
description: The unique identifier of the team.
|
|
15759
|
+
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
|
|
15760
|
+
type: string
|
|
15761
|
+
type:
|
|
15762
|
+
$ref: '#/components/schemas/TeamType'
|
|
15763
|
+
type: object
|
|
14224
15764
|
RelationshipToTeamLinkData:
|
|
14225
15765
|
description: Relationship between a link and a team
|
|
14226
15766
|
properties:
|
|
@@ -14532,6 +16072,7 @@ components:
|
|
|
14532
16072
|
- spans-sampling-processor
|
|
14533
16073
|
- spans-errors-sampling-processor
|
|
14534
16074
|
- spans-appsec-sampling-processor
|
|
16075
|
+
example: spans-sampling-processor
|
|
14535
16076
|
type: string
|
|
14536
16077
|
x-enum-varnames:
|
|
14537
16078
|
- SPANS_SAMPLING_PROCESSOR
|
|
@@ -14648,11 +16189,42 @@ components:
|
|
|
14648
16189
|
type: string
|
|
14649
16190
|
x-enum-varnames:
|
|
14650
16191
|
- SPANS_SAMPLING_PROCESSOR
|
|
16192
|
+
RetentionFilterUpdateAttributes:
|
|
16193
|
+
description: The object describing the configuration of the retention filter
|
|
16194
|
+
to create/update.
|
|
16195
|
+
properties:
|
|
16196
|
+
enabled:
|
|
16197
|
+
description: Enable/Disable the retention filter.
|
|
16198
|
+
example: true
|
|
16199
|
+
type: boolean
|
|
16200
|
+
filter:
|
|
16201
|
+
$ref: '#/components/schemas/SpansFilterCreate'
|
|
16202
|
+
filter_type:
|
|
16203
|
+
$ref: '#/components/schemas/RetentionFilterAllType'
|
|
16204
|
+
name:
|
|
16205
|
+
description: The name of the retention filter.
|
|
16206
|
+
example: my retention filter
|
|
16207
|
+
type: string
|
|
16208
|
+
rate:
|
|
16209
|
+
description: 'Sample rate to apply to spans going through this retention
|
|
16210
|
+
filter,
|
|
16211
|
+
|
|
16212
|
+
a value of 1.0 keeps all spans matching the query.'
|
|
16213
|
+
example: 1.0
|
|
16214
|
+
format: double
|
|
16215
|
+
type: number
|
|
16216
|
+
required:
|
|
16217
|
+
- name
|
|
16218
|
+
- filter
|
|
16219
|
+
- enabled
|
|
16220
|
+
- filter_type
|
|
16221
|
+
- rate
|
|
16222
|
+
type: object
|
|
14651
16223
|
RetentionFilterUpdateData:
|
|
14652
16224
|
description: The body of the retention filter to be updated.
|
|
14653
16225
|
properties:
|
|
14654
16226
|
attributes:
|
|
14655
|
-
$ref: '#/components/schemas/
|
|
16227
|
+
$ref: '#/components/schemas/RetentionFilterUpdateAttributes'
|
|
14656
16228
|
id:
|
|
14657
16229
|
description: The ID of the retention filter.
|
|
14658
16230
|
example: retention-filter-id
|
|
@@ -15041,6 +16613,74 @@ components:
|
|
|
15041
16613
|
type: string
|
|
15042
16614
|
x-enum-varnames:
|
|
15043
16615
|
- SAML_ASSERTION_ATTRIBUTES
|
|
16616
|
+
SLOReportInterval:
|
|
16617
|
+
description: The frequency at which report data is to be generated.
|
|
16618
|
+
enum:
|
|
16619
|
+
- weekly
|
|
16620
|
+
- monthly
|
|
16621
|
+
example: weekly
|
|
16622
|
+
type: string
|
|
16623
|
+
x-enum-varnames:
|
|
16624
|
+
- WEEKLY
|
|
16625
|
+
- MONTHLY
|
|
16626
|
+
SLOReportPostResponse:
|
|
16627
|
+
description: The SLO report response.
|
|
16628
|
+
properties:
|
|
16629
|
+
data:
|
|
16630
|
+
$ref: '#/components/schemas/SLOReportPostResponseData'
|
|
16631
|
+
type: object
|
|
16632
|
+
SLOReportPostResponseData:
|
|
16633
|
+
description: The data portion of the SLO report response.
|
|
16634
|
+
properties:
|
|
16635
|
+
id:
|
|
16636
|
+
description: The ID of the report job.
|
|
16637
|
+
example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
|
|
16638
|
+
type: string
|
|
16639
|
+
type:
|
|
16640
|
+
description: The type of ID.
|
|
16641
|
+
example: report_id
|
|
16642
|
+
type: string
|
|
16643
|
+
type: object
|
|
16644
|
+
SLOReportStatus:
|
|
16645
|
+
description: The status of the SLO report job.
|
|
16646
|
+
enum:
|
|
16647
|
+
- in_progress
|
|
16648
|
+
- completed
|
|
16649
|
+
- completed_with_errors
|
|
16650
|
+
- failed
|
|
16651
|
+
example: completed
|
|
16652
|
+
type: string
|
|
16653
|
+
x-enum-varnames:
|
|
16654
|
+
- IN_PROGRESS
|
|
16655
|
+
- COMPLETED
|
|
16656
|
+
- COMPLETED_WITH_ERRORS
|
|
16657
|
+
- FAILED
|
|
16658
|
+
SLOReportStatusGetResponse:
|
|
16659
|
+
description: The SLO report status response.
|
|
16660
|
+
properties:
|
|
16661
|
+
data:
|
|
16662
|
+
$ref: '#/components/schemas/SLOReportStatusGetResponseData'
|
|
16663
|
+
type: object
|
|
16664
|
+
SLOReportStatusGetResponseAttributes:
|
|
16665
|
+
description: The attributes portion of the SLO report status response.
|
|
16666
|
+
properties:
|
|
16667
|
+
status:
|
|
16668
|
+
$ref: '#/components/schemas/SLOReportStatus'
|
|
16669
|
+
type: object
|
|
16670
|
+
SLOReportStatusGetResponseData:
|
|
16671
|
+
description: The data portion of the SLO report status response.
|
|
16672
|
+
properties:
|
|
16673
|
+
attributes:
|
|
16674
|
+
$ref: '#/components/schemas/SLOReportStatusGetResponseAttributes'
|
|
16675
|
+
id:
|
|
16676
|
+
description: The ID of the report job.
|
|
16677
|
+
example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
|
|
16678
|
+
type: string
|
|
16679
|
+
type:
|
|
16680
|
+
description: The type of ID.
|
|
16681
|
+
example: report_id
|
|
16682
|
+
type: string
|
|
16683
|
+
type: object
|
|
15044
16684
|
ScalarColumn:
|
|
15045
16685
|
description: A single column in a scalar query response.
|
|
15046
16686
|
oneOf:
|
|
@@ -15837,7 +17477,8 @@ components:
|
|
|
15837
17477
|
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
|
|
15838
17478
|
filters:
|
|
15839
17479
|
description: Additional queries to filter matched events before they are
|
|
15840
|
-
processed.
|
|
17480
|
+
processed. This field is deprecated for log detection, signal correlation,
|
|
17481
|
+
and workload security rules.
|
|
15841
17482
|
items:
|
|
15842
17483
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
|
15843
17484
|
type: array
|
|
@@ -16085,7 +17726,8 @@ components:
|
|
|
16085
17726
|
type: array
|
|
16086
17727
|
filters:
|
|
16087
17728
|
description: Additional queries to filter matched events before they are
|
|
16088
|
-
processed.
|
|
17729
|
+
processed. This field is deprecated for log detection, signal correlation,
|
|
17730
|
+
and workload security rules.
|
|
16089
17731
|
items:
|
|
16090
17732
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
|
16091
17733
|
type: array
|
|
@@ -16187,7 +17829,8 @@ components:
|
|
|
16187
17829
|
type: integer
|
|
16188
17830
|
filters:
|
|
16189
17831
|
description: Additional queries to filter matched events before they are
|
|
16190
|
-
processed.
|
|
17832
|
+
processed. This field is deprecated for log detection, signal correlation,
|
|
17833
|
+
and workload security rules.
|
|
16191
17834
|
items:
|
|
16192
17835
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
|
16193
17836
|
type: array
|
|
@@ -16466,7 +18109,8 @@ components:
|
|
|
16466
18109
|
type: array
|
|
16467
18110
|
filters:
|
|
16468
18111
|
description: Additional queries to filter matched events before they are
|
|
16469
|
-
processed.
|
|
18112
|
+
processed. This field is deprecated for log detection, signal correlation,
|
|
18113
|
+
and workload security rules.
|
|
16470
18114
|
items:
|
|
16471
18115
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
|
16472
18116
|
type: array
|
|
@@ -16593,7 +18237,8 @@ components:
|
|
|
16593
18237
|
type: integer
|
|
16594
18238
|
filters:
|
|
16595
18239
|
description: Additional queries to filter matched events before they are
|
|
16596
|
-
processed.
|
|
18240
|
+
processed. This field is deprecated for log detection, signal correlation,
|
|
18241
|
+
and workload security rules.
|
|
16597
18242
|
items:
|
|
16598
18243
|
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
|
16599
18244
|
type: array
|
|
@@ -16669,6 +18314,13 @@ components:
|
|
|
16669
18314
|
type: integer
|
|
16670
18315
|
creator:
|
|
16671
18316
|
$ref: '#/components/schemas/SecurityMonitoringUser'
|
|
18317
|
+
data_exclusion_query:
|
|
18318
|
+
description: An exclusion query on the input data of the security rules,
|
|
18319
|
+
which could be logs, Agent events, or other types of data based on the
|
|
18320
|
+
security rule. Events matching this query are ignored by any detection
|
|
18321
|
+
rules referenced in the suppression rule.
|
|
18322
|
+
example: source:cloudtrail account_id:12345
|
|
18323
|
+
type: string
|
|
16672
18324
|
description:
|
|
16673
18325
|
description: A description for the suppression rule.
|
|
16674
18326
|
example: This rule suppresses low-severity signals in staging environments.
|
|
@@ -16717,6 +18369,13 @@ components:
|
|
|
16717
18369
|
description: Object containing the attributes of the suppression rule to be
|
|
16718
18370
|
created.
|
|
16719
18371
|
properties:
|
|
18372
|
+
data_exclusion_query:
|
|
18373
|
+
description: An exclusion query on the input data of the security rules,
|
|
18374
|
+
which could be logs, Agent events, or other types of data based on the
|
|
18375
|
+
security rule. Events matching this query are ignored by any detection
|
|
18376
|
+
rules referenced in the suppression rule.
|
|
18377
|
+
example: source:cloudtrail account_id:12345
|
|
18378
|
+
type: string
|
|
16720
18379
|
description:
|
|
16721
18380
|
description: A description for the suppression rule.
|
|
16722
18381
|
example: This rule suppresses low-severity signals in staging environments.
|
|
@@ -16742,15 +18401,14 @@ components:
|
|
|
16742
18401
|
type: string
|
|
16743
18402
|
suppression_query:
|
|
16744
18403
|
description: The suppression query of the suppression rule. If a signal
|
|
16745
|
-
matches this query, it is suppressed and is not triggered
|
|
16746
|
-
as the queries to search signals in the
|
|
18404
|
+
matches this query, it is suppressed and is not triggered. It uses the
|
|
18405
|
+
same syntax as the queries to search signals in the Signals Explorer.
|
|
16747
18406
|
example: env:staging status:low
|
|
16748
18407
|
type: string
|
|
16749
18408
|
required:
|
|
16750
18409
|
- name
|
|
16751
18410
|
- enabled
|
|
16752
18411
|
- rule_query
|
|
16753
|
-
- suppression_query
|
|
16754
18412
|
type: object
|
|
16755
18413
|
SecurityMonitoringSuppressionCreateData:
|
|
16756
18414
|
description: Object for a single suppression rule.
|
|
@@ -16794,6 +18452,13 @@ components:
|
|
|
16794
18452
|
SecurityMonitoringSuppressionUpdateAttributes:
|
|
16795
18453
|
description: The suppression rule properties to be updated.
|
|
16796
18454
|
properties:
|
|
18455
|
+
data_exclusion_query:
|
|
18456
|
+
description: An exclusion query on the input data of the security rules,
|
|
18457
|
+
which could be logs, Agent events, or other types of data based on the
|
|
18458
|
+
security rule. Events matching this query are ignored by any detection
|
|
18459
|
+
rules referenced in the suppression rule.
|
|
18460
|
+
example: source:cloudtrail account_id:12345
|
|
18461
|
+
type: string
|
|
16797
18462
|
description:
|
|
16798
18463
|
description: A description for the suppression rule.
|
|
16799
18464
|
example: This rule suppresses low-severity signals in staging environments.
|
|
@@ -17524,7 +19189,10 @@ components:
|
|
|
17524
19189
|
description: Name of the standard pattern.
|
|
17525
19190
|
type: string
|
|
17526
19191
|
pattern:
|
|
17527
|
-
|
|
19192
|
+
deprecated: true
|
|
19193
|
+
description: (Deprecated) Regex to match, optionally documented for older
|
|
19194
|
+
standard rules. Refer to the `description` field to understand what the
|
|
19195
|
+
rule does.
|
|
17528
19196
|
type: string
|
|
17529
19197
|
priority:
|
|
17530
19198
|
description: Integer from 1 (high) to 5 (low) indicating standard pattern
|
|
@@ -18234,6 +19902,14 @@ components:
|
|
|
18234
19902
|
feature, which the service is a part of.
|
|
18235
19903
|
example: my-app
|
|
18236
19904
|
type: string
|
|
19905
|
+
ci-pipeline-fingerprints:
|
|
19906
|
+
description: A set of CI fingerprints.
|
|
19907
|
+
example:
|
|
19908
|
+
- j88xdEy0J5lc
|
|
19909
|
+
- eZ7LMljCk8vo
|
|
19910
|
+
items:
|
|
19911
|
+
type: string
|
|
19912
|
+
type: array
|
|
18237
19913
|
contacts:
|
|
18238
19914
|
description: A list of contacts related to the services.
|
|
18239
19915
|
items:
|
|
@@ -18614,6 +20290,23 @@ components:
|
|
|
18614
20290
|
$ref: '#/components/schemas/ServiceDefinitionData'
|
|
18615
20291
|
type: array
|
|
18616
20292
|
type: object
|
|
20293
|
+
ServiceNowTicket:
|
|
20294
|
+
description: ServiceNow ticket attached to case
|
|
20295
|
+
nullable: true
|
|
20296
|
+
properties:
|
|
20297
|
+
result:
|
|
20298
|
+
$ref: '#/components/schemas/ServiceNowTicketResult'
|
|
20299
|
+
status:
|
|
20300
|
+
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
|
|
20301
|
+
readOnly: true
|
|
20302
|
+
type: object
|
|
20303
|
+
ServiceNowTicketResult:
|
|
20304
|
+
description: ServiceNow ticket information
|
|
20305
|
+
properties:
|
|
20306
|
+
sys_target_link:
|
|
20307
|
+
description: Link to the Incident created on ServiceNow
|
|
20308
|
+
type: string
|
|
20309
|
+
type: object
|
|
18617
20310
|
SlackIntegrationMetadata:
|
|
18618
20311
|
description: Incident integration metadata for the Slack integration.
|
|
18619
20312
|
properties:
|
|
@@ -18650,6 +20343,53 @@ components:
|
|
|
18650
20343
|
- channel_name
|
|
18651
20344
|
- redirect_url
|
|
18652
20345
|
type: object
|
|
20346
|
+
SloReportCreateRequest:
|
|
20347
|
+
description: The SLO report request body.
|
|
20348
|
+
properties:
|
|
20349
|
+
data:
|
|
20350
|
+
$ref: '#/components/schemas/SloReportCreateRequestData'
|
|
20351
|
+
required:
|
|
20352
|
+
- data
|
|
20353
|
+
type: object
|
|
20354
|
+
SloReportCreateRequestAttributes:
|
|
20355
|
+
description: The attributes portion of the SLO report request.
|
|
20356
|
+
properties:
|
|
20357
|
+
from_ts:
|
|
20358
|
+
description: The `from` timestamp for the report in epoch seconds.
|
|
20359
|
+
example: 1690901870
|
|
20360
|
+
format: int64
|
|
20361
|
+
type: integer
|
|
20362
|
+
interval:
|
|
20363
|
+
$ref: '#/components/schemas/SLOReportInterval'
|
|
20364
|
+
query:
|
|
20365
|
+
description: The query string used to filter SLO results. Some examples
|
|
20366
|
+
of queries include `service:<service-name>` and `slo-name`.
|
|
20367
|
+
example: slo_type:metric
|
|
20368
|
+
type: string
|
|
20369
|
+
timezone:
|
|
20370
|
+
description: The timezone used to determine the start and end of each interval.
|
|
20371
|
+
For example, weekly intervals start at 12am on Sunday in the specified
|
|
20372
|
+
timezone.
|
|
20373
|
+
example: America/New_York
|
|
20374
|
+
type: string
|
|
20375
|
+
to_ts:
|
|
20376
|
+
description: The `to` timestamp for the report in epoch seconds.
|
|
20377
|
+
example: 1706803070
|
|
20378
|
+
format: int64
|
|
20379
|
+
type: integer
|
|
20380
|
+
required:
|
|
20381
|
+
- query
|
|
20382
|
+
- from_ts
|
|
20383
|
+
- to_ts
|
|
20384
|
+
type: object
|
|
20385
|
+
SloReportCreateRequestData:
|
|
20386
|
+
description: The data portion of the SLO report request.
|
|
20387
|
+
properties:
|
|
20388
|
+
attributes:
|
|
20389
|
+
$ref: '#/components/schemas/SloReportCreateRequestAttributes'
|
|
20390
|
+
required:
|
|
20391
|
+
- attributes
|
|
20392
|
+
type: object
|
|
18653
20393
|
SortDirection:
|
|
18654
20394
|
default: desc
|
|
18655
20395
|
description: The direction to sort by.
|
|
@@ -20268,6 +22008,7 @@ components:
|
|
|
20268
22008
|
If the second element is not present, the API returns null.'
|
|
20269
22009
|
items:
|
|
20270
22010
|
$ref: '#/components/schemas/Unit'
|
|
22011
|
+
nullable: true
|
|
20271
22012
|
type: array
|
|
20272
22013
|
type: object
|
|
20273
22014
|
TimeseriesResponseSeriesList:
|
|
@@ -20615,12 +22356,34 @@ components:
|
|
|
20615
22356
|
type: string
|
|
20616
22357
|
x-enum-varnames:
|
|
20617
22358
|
- USER_INVITATIONS
|
|
22359
|
+
UserRelationshipData:
|
|
22360
|
+
description: Relationship to user object.
|
|
22361
|
+
properties:
|
|
22362
|
+
id:
|
|
22363
|
+
description: A unique identifier that represents the user.
|
|
22364
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
22365
|
+
type: string
|
|
22366
|
+
type:
|
|
22367
|
+
$ref: '#/components/schemas/UserResourceType'
|
|
22368
|
+
required:
|
|
22369
|
+
- id
|
|
22370
|
+
- type
|
|
22371
|
+
type: object
|
|
20618
22372
|
UserRelationships:
|
|
20619
22373
|
description: Relationships of the user object.
|
|
20620
22374
|
properties:
|
|
20621
22375
|
roles:
|
|
20622
22376
|
$ref: '#/components/schemas/RelationshipToRoles'
|
|
20623
22377
|
type: object
|
|
22378
|
+
UserResourceType:
|
|
22379
|
+
default: user
|
|
22380
|
+
description: User resource type.
|
|
22381
|
+
enum:
|
|
22382
|
+
- user
|
|
22383
|
+
example: user
|
|
22384
|
+
type: string
|
|
22385
|
+
x-enum-varnames:
|
|
22386
|
+
- USER
|
|
20624
22387
|
UserResponse:
|
|
20625
22388
|
description: Response containing information about a single user.
|
|
20626
22389
|
properties:
|
|
@@ -20699,6 +22462,10 @@ components:
|
|
|
20699
22462
|
required:
|
|
20700
22463
|
- type
|
|
20701
22464
|
type: object
|
|
22465
|
+
UserTeamIncluded:
|
|
22466
|
+
description: Included resources related to the team membership
|
|
22467
|
+
oneOf:
|
|
22468
|
+
- $ref: '#/components/schemas/User'
|
|
20702
22469
|
UserTeamPermission:
|
|
20703
22470
|
description: A user's permissions for a given team
|
|
20704
22471
|
properties:
|
|
@@ -20753,6 +22520,11 @@ components:
|
|
|
20753
22520
|
properties:
|
|
20754
22521
|
data:
|
|
20755
22522
|
$ref: '#/components/schemas/UserTeam'
|
|
22523
|
+
included:
|
|
22524
|
+
description: Resources related to the team memberships
|
|
22525
|
+
items:
|
|
22526
|
+
$ref: '#/components/schemas/UserTeamIncluded'
|
|
22527
|
+
type: array
|
|
20756
22528
|
type: object
|
|
20757
22529
|
UserTeamRole:
|
|
20758
22530
|
description: The user's role within the team
|
|
@@ -20815,6 +22587,11 @@ components:
|
|
|
20815
22587
|
items:
|
|
20816
22588
|
$ref: '#/components/schemas/UserTeam'
|
|
20817
22589
|
type: array
|
|
22590
|
+
included:
|
|
22591
|
+
description: Resources related to the team memberships
|
|
22592
|
+
items:
|
|
22593
|
+
$ref: '#/components/schemas/UserTeamIncluded'
|
|
22594
|
+
type: array
|
|
20818
22595
|
links:
|
|
20819
22596
|
$ref: '#/components/schemas/TeamsResponseLinks'
|
|
20820
22597
|
meta:
|
|
@@ -20857,6 +22634,18 @@ components:
|
|
|
20857
22634
|
required:
|
|
20858
22635
|
- data
|
|
20859
22636
|
type: object
|
|
22637
|
+
UsersRelationship:
|
|
22638
|
+
description: Relationship to users.
|
|
22639
|
+
properties:
|
|
22640
|
+
data:
|
|
22641
|
+
description: Relationships to user objects.
|
|
22642
|
+
example: []
|
|
22643
|
+
items:
|
|
22644
|
+
$ref: '#/components/schemas/UserRelationshipData'
|
|
22645
|
+
type: array
|
|
22646
|
+
required:
|
|
22647
|
+
- data
|
|
22648
|
+
type: object
|
|
20860
22649
|
UsersResponse:
|
|
20861
22650
|
description: Response containing information about multiple users.
|
|
20862
22651
|
properties:
|
|
@@ -20929,6 +22718,8 @@ components:
|
|
|
20929
22718
|
apm_service_catalog_read: View service catalog and service definitions.
|
|
20930
22719
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
|
20931
22720
|
when those definitions are maintained by Datadog.
|
|
22721
|
+
cases_read: Read all cases data.
|
|
22722
|
+
cases_write: Create, update and delete cases data.
|
|
20932
22723
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
|
20933
22724
|
the API.
|
|
20934
22725
|
ci_visibility_read: View CI Visibility.
|
|
@@ -21512,7 +23303,11 @@ paths:
|
|
|
21512
23303
|
post:
|
|
21513
23304
|
description: 'Create a retention filter to index spans in your organization.
|
|
21514
23305
|
|
|
21515
|
-
Returns the retention filter definition when the request is successful.
|
|
23306
|
+
Returns the retention filter definition when the request is successful.
|
|
23307
|
+
|
|
23308
|
+
|
|
23309
|
+
Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
|
|
23310
|
+
cannot be created.'
|
|
21516
23311
|
operationId: CreateApmRetentionFilter
|
|
21517
23312
|
requestBody:
|
|
21518
23313
|
content:
|
|
@@ -21566,7 +23361,11 @@ paths:
|
|
|
21566
23361
|
x-codegen-request-body-name: body
|
|
21567
23362
|
/api/v2/apm/config/retention-filters/{filter_id}:
|
|
21568
23363
|
delete:
|
|
21569
|
-
description: Delete a specific retention filter from your organization.
|
|
23364
|
+
description: 'Delete a specific retention filter from your organization.
|
|
23365
|
+
|
|
23366
|
+
|
|
23367
|
+
Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
|
|
23368
|
+
cannot be deleted.'
|
|
21570
23369
|
operationId: DeleteApmRetentionFilter
|
|
21571
23370
|
parameters:
|
|
21572
23371
|
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
@@ -21604,7 +23403,11 @@ paths:
|
|
|
21604
23403
|
tags:
|
|
21605
23404
|
- APM Retention Filters
|
|
21606
23405
|
put:
|
|
21607
|
-
description: Update a retention filter from your organization.
|
|
23406
|
+
description: 'Update a retention filter from your organization.
|
|
23407
|
+
|
|
23408
|
+
|
|
23409
|
+
Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor)
|
|
23410
|
+
cannot be renamed or removed.'
|
|
21608
23411
|
operationId: UpdateApmRetentionFilter
|
|
21609
23412
|
parameters:
|
|
21610
23413
|
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
@@ -22117,6 +23920,472 @@ paths:
|
|
|
22117
23920
|
- AuthN Mappings
|
|
22118
23921
|
x-codegen-request-body-name: body
|
|
22119
23922
|
x-permission: OR(USER_ACCESS_MANAGE)
|
|
23923
|
+
/api/v2/cases:
|
|
23924
|
+
get:
|
|
23925
|
+
description: Search cases.
|
|
23926
|
+
operationId: SearchCases
|
|
23927
|
+
parameters:
|
|
23928
|
+
- $ref: '#/components/parameters/PageSize'
|
|
23929
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
23930
|
+
- $ref: '#/components/parameters/CaseSortableFieldParameter'
|
|
23931
|
+
- description: Search query
|
|
23932
|
+
in: query
|
|
23933
|
+
name: filter
|
|
23934
|
+
required: false
|
|
23935
|
+
schema:
|
|
23936
|
+
example: status:open (team:case-management OR team:event-management)
|
|
23937
|
+
type: string
|
|
23938
|
+
- description: Specify if order is ascending or not
|
|
23939
|
+
in: query
|
|
23940
|
+
name: sort[asc]
|
|
23941
|
+
required: false
|
|
23942
|
+
schema:
|
|
23943
|
+
default: false
|
|
23944
|
+
type: boolean
|
|
23945
|
+
responses:
|
|
23946
|
+
'200':
|
|
23947
|
+
content:
|
|
23948
|
+
application/json:
|
|
23949
|
+
schema:
|
|
23950
|
+
$ref: '#/components/schemas/CasesResponse'
|
|
23951
|
+
description: OK
|
|
23952
|
+
'400':
|
|
23953
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23954
|
+
'401':
|
|
23955
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23956
|
+
'403':
|
|
23957
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23958
|
+
'404':
|
|
23959
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23960
|
+
'429':
|
|
23961
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23962
|
+
security:
|
|
23963
|
+
- apiKeyAuth: []
|
|
23964
|
+
appKeyAuth: []
|
|
23965
|
+
- AuthZ:
|
|
23966
|
+
- cases_read
|
|
23967
|
+
summary: Search cases
|
|
23968
|
+
tags:
|
|
23969
|
+
- Case Management
|
|
23970
|
+
x-pagination:
|
|
23971
|
+
limitParam: page[size]
|
|
23972
|
+
pageOffsetParam: page[offset]
|
|
23973
|
+
resultsPath: data
|
|
23974
|
+
post:
|
|
23975
|
+
description: Create a Case
|
|
23976
|
+
operationId: CreateCase
|
|
23977
|
+
requestBody:
|
|
23978
|
+
content:
|
|
23979
|
+
application/json:
|
|
23980
|
+
schema:
|
|
23981
|
+
$ref: '#/components/schemas/CaseCreateRequest'
|
|
23982
|
+
description: Case payload
|
|
23983
|
+
required: true
|
|
23984
|
+
responses:
|
|
23985
|
+
'201':
|
|
23986
|
+
content:
|
|
23987
|
+
application/json:
|
|
23988
|
+
schema:
|
|
23989
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
23990
|
+
description: CREATED
|
|
23991
|
+
'400':
|
|
23992
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23993
|
+
'401':
|
|
23994
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
23995
|
+
'403':
|
|
23996
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23997
|
+
'404':
|
|
23998
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23999
|
+
'429':
|
|
24000
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24001
|
+
security:
|
|
24002
|
+
- apiKeyAuth: []
|
|
24003
|
+
appKeyAuth: []
|
|
24004
|
+
- AuthZ:
|
|
24005
|
+
- cases_write
|
|
24006
|
+
summary: Create a case
|
|
24007
|
+
tags:
|
|
24008
|
+
- Case Management
|
|
24009
|
+
/api/v2/cases/projects:
|
|
24010
|
+
get:
|
|
24011
|
+
description: Get all projects.
|
|
24012
|
+
operationId: GetProjects
|
|
24013
|
+
responses:
|
|
24014
|
+
'200':
|
|
24015
|
+
content:
|
|
24016
|
+
application/json:
|
|
24017
|
+
schema:
|
|
24018
|
+
$ref: '#/components/schemas/ProjectsResponse'
|
|
24019
|
+
description: OK
|
|
24020
|
+
'400':
|
|
24021
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24022
|
+
'401':
|
|
24023
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24024
|
+
'403':
|
|
24025
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24026
|
+
'404':
|
|
24027
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24028
|
+
'429':
|
|
24029
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24030
|
+
security:
|
|
24031
|
+
- apiKeyAuth: []
|
|
24032
|
+
appKeyAuth: []
|
|
24033
|
+
- AuthZ:
|
|
24034
|
+
- cases_read
|
|
24035
|
+
summary: Get all projects
|
|
24036
|
+
tags:
|
|
24037
|
+
- Case Management
|
|
24038
|
+
post:
|
|
24039
|
+
description: Create a project.
|
|
24040
|
+
operationId: CreateProject
|
|
24041
|
+
requestBody:
|
|
24042
|
+
content:
|
|
24043
|
+
application/json:
|
|
24044
|
+
schema:
|
|
24045
|
+
$ref: '#/components/schemas/ProjectCreateRequest'
|
|
24046
|
+
description: Project payload
|
|
24047
|
+
required: true
|
|
24048
|
+
responses:
|
|
24049
|
+
'201':
|
|
24050
|
+
content:
|
|
24051
|
+
application/json:
|
|
24052
|
+
schema:
|
|
24053
|
+
$ref: '#/components/schemas/ProjectResponse'
|
|
24054
|
+
description: CREATED
|
|
24055
|
+
'400':
|
|
24056
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24057
|
+
'401':
|
|
24058
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24059
|
+
'403':
|
|
24060
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24061
|
+
'404':
|
|
24062
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24063
|
+
'429':
|
|
24064
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24065
|
+
security:
|
|
24066
|
+
- apiKeyAuth: []
|
|
24067
|
+
appKeyAuth: []
|
|
24068
|
+
- AuthZ:
|
|
24069
|
+
- cases_write
|
|
24070
|
+
summary: Create a project
|
|
24071
|
+
tags:
|
|
24072
|
+
- Case Management
|
|
24073
|
+
/api/v2/cases/projects/{project_id}:
|
|
24074
|
+
delete:
|
|
24075
|
+
description: Remove a project using the project's `id`.
|
|
24076
|
+
operationId: DeleteProject
|
|
24077
|
+
parameters:
|
|
24078
|
+
- $ref: '#/components/parameters/ProjectIDPathParameter'
|
|
24079
|
+
responses:
|
|
24080
|
+
'204':
|
|
24081
|
+
description: No Content
|
|
24082
|
+
'403':
|
|
24083
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24084
|
+
'404':
|
|
24085
|
+
content:
|
|
24086
|
+
application/json:
|
|
24087
|
+
schema:
|
|
24088
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24089
|
+
description: API error response
|
|
24090
|
+
'429':
|
|
24091
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24092
|
+
security:
|
|
24093
|
+
- apiKeyAuth: []
|
|
24094
|
+
appKeyAuth: []
|
|
24095
|
+
- AuthZ:
|
|
24096
|
+
- cases_write
|
|
24097
|
+
summary: Remove a project
|
|
24098
|
+
tags:
|
|
24099
|
+
- Case Management
|
|
24100
|
+
get:
|
|
24101
|
+
description: Get the details of a project by `project_id`.
|
|
24102
|
+
operationId: GetProject
|
|
24103
|
+
parameters:
|
|
24104
|
+
- $ref: '#/components/parameters/ProjectIDPathParameter'
|
|
24105
|
+
responses:
|
|
24106
|
+
'200':
|
|
24107
|
+
content:
|
|
24108
|
+
application/json:
|
|
24109
|
+
schema:
|
|
24110
|
+
$ref: '#/components/schemas/ProjectResponse'
|
|
24111
|
+
description: OK
|
|
24112
|
+
'400':
|
|
24113
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24114
|
+
'401':
|
|
24115
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24116
|
+
'403':
|
|
24117
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24118
|
+
'404':
|
|
24119
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24120
|
+
'429':
|
|
24121
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24122
|
+
security:
|
|
24123
|
+
- apiKeyAuth: []
|
|
24124
|
+
appKeyAuth: []
|
|
24125
|
+
- AuthZ:
|
|
24126
|
+
- cases_read
|
|
24127
|
+
summary: Get the details of a project
|
|
24128
|
+
tags:
|
|
24129
|
+
- Case Management
|
|
24130
|
+
/api/v2/cases/{case_id}:
|
|
24131
|
+
get:
|
|
24132
|
+
description: Get the details of case by `case_id`
|
|
24133
|
+
operationId: GetCase
|
|
24134
|
+
parameters:
|
|
24135
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24136
|
+
responses:
|
|
24137
|
+
'200':
|
|
24138
|
+
content:
|
|
24139
|
+
application/json:
|
|
24140
|
+
schema:
|
|
24141
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24142
|
+
description: OK
|
|
24143
|
+
'400':
|
|
24144
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24145
|
+
'401':
|
|
24146
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24147
|
+
'403':
|
|
24148
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24149
|
+
'404':
|
|
24150
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24151
|
+
'429':
|
|
24152
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24153
|
+
security:
|
|
24154
|
+
- apiKeyAuth: []
|
|
24155
|
+
appKeyAuth: []
|
|
24156
|
+
- AuthZ:
|
|
24157
|
+
- cases_read
|
|
24158
|
+
summary: Get the details of a case
|
|
24159
|
+
tags:
|
|
24160
|
+
- Case Management
|
|
24161
|
+
/api/v2/cases/{case_id}/archive:
|
|
24162
|
+
post:
|
|
24163
|
+
description: Archive case
|
|
24164
|
+
operationId: ArchiveCase
|
|
24165
|
+
parameters:
|
|
24166
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24167
|
+
requestBody:
|
|
24168
|
+
content:
|
|
24169
|
+
application/json:
|
|
24170
|
+
schema:
|
|
24171
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
|
24172
|
+
description: Archive case payload
|
|
24173
|
+
required: true
|
|
24174
|
+
responses:
|
|
24175
|
+
'200':
|
|
24176
|
+
content:
|
|
24177
|
+
application/json:
|
|
24178
|
+
schema:
|
|
24179
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24180
|
+
description: OK
|
|
24181
|
+
'400':
|
|
24182
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24183
|
+
'401':
|
|
24184
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24185
|
+
'403':
|
|
24186
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24187
|
+
'404':
|
|
24188
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24189
|
+
'429':
|
|
24190
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24191
|
+
security:
|
|
24192
|
+
- apiKeyAuth: []
|
|
24193
|
+
appKeyAuth: []
|
|
24194
|
+
- AuthZ:
|
|
24195
|
+
- cases_write
|
|
24196
|
+
summary: Archive case
|
|
24197
|
+
tags:
|
|
24198
|
+
- Case Management
|
|
24199
|
+
/api/v2/cases/{case_id}/assign:
|
|
24200
|
+
post:
|
|
24201
|
+
description: Assign case to a user
|
|
24202
|
+
operationId: AssignCase
|
|
24203
|
+
parameters:
|
|
24204
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24205
|
+
requestBody:
|
|
24206
|
+
content:
|
|
24207
|
+
application/json:
|
|
24208
|
+
schema:
|
|
24209
|
+
$ref: '#/components/schemas/CaseAssignRequest'
|
|
24210
|
+
description: Assign case payload
|
|
24211
|
+
required: true
|
|
24212
|
+
responses:
|
|
24213
|
+
'200':
|
|
24214
|
+
content:
|
|
24215
|
+
application/json:
|
|
24216
|
+
schema:
|
|
24217
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24218
|
+
description: OK
|
|
24219
|
+
'400':
|
|
24220
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24221
|
+
'401':
|
|
24222
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24223
|
+
'403':
|
|
24224
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24225
|
+
'404':
|
|
24226
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24227
|
+
'429':
|
|
24228
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24229
|
+
security:
|
|
24230
|
+
- apiKeyAuth: []
|
|
24231
|
+
appKeyAuth: []
|
|
24232
|
+
- AuthZ:
|
|
24233
|
+
- cases_write
|
|
24234
|
+
summary: Assign case
|
|
24235
|
+
tags:
|
|
24236
|
+
- Case Management
|
|
24237
|
+
/api/v2/cases/{case_id}/priority:
|
|
24238
|
+
post:
|
|
24239
|
+
description: Update case priority
|
|
24240
|
+
operationId: UpdatePriority
|
|
24241
|
+
parameters:
|
|
24242
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24243
|
+
requestBody:
|
|
24244
|
+
content:
|
|
24245
|
+
application/json:
|
|
24246
|
+
schema:
|
|
24247
|
+
$ref: '#/components/schemas/CaseUpdatePriorityRequest'
|
|
24248
|
+
description: Case priority update payload
|
|
24249
|
+
required: true
|
|
24250
|
+
responses:
|
|
24251
|
+
'200':
|
|
24252
|
+
content:
|
|
24253
|
+
application/json:
|
|
24254
|
+
schema:
|
|
24255
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24256
|
+
description: OK
|
|
24257
|
+
'400':
|
|
24258
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24259
|
+
'401':
|
|
24260
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24261
|
+
'403':
|
|
24262
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24263
|
+
'404':
|
|
24264
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24265
|
+
'429':
|
|
24266
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24267
|
+
security:
|
|
24268
|
+
- apiKeyAuth: []
|
|
24269
|
+
appKeyAuth: []
|
|
24270
|
+
- AuthZ:
|
|
24271
|
+
- cases_write
|
|
24272
|
+
summary: Update case priority
|
|
24273
|
+
tags:
|
|
24274
|
+
- Case Management
|
|
24275
|
+
/api/v2/cases/{case_id}/status:
|
|
24276
|
+
post:
|
|
24277
|
+
description: Update case status
|
|
24278
|
+
operationId: UpdateStatus
|
|
24279
|
+
parameters:
|
|
24280
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24281
|
+
requestBody:
|
|
24282
|
+
content:
|
|
24283
|
+
application/json:
|
|
24284
|
+
schema:
|
|
24285
|
+
$ref: '#/components/schemas/CaseUpdateStatusRequest'
|
|
24286
|
+
description: Case status update payload
|
|
24287
|
+
required: true
|
|
24288
|
+
responses:
|
|
24289
|
+
'200':
|
|
24290
|
+
content:
|
|
24291
|
+
application/json:
|
|
24292
|
+
schema:
|
|
24293
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24294
|
+
description: OK
|
|
24295
|
+
'400':
|
|
24296
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24297
|
+
'401':
|
|
24298
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24299
|
+
'403':
|
|
24300
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24301
|
+
'404':
|
|
24302
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24303
|
+
'429':
|
|
24304
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24305
|
+
security:
|
|
24306
|
+
- apiKeyAuth: []
|
|
24307
|
+
appKeyAuth: []
|
|
24308
|
+
- AuthZ:
|
|
24309
|
+
- cases_write
|
|
24310
|
+
summary: Update case status
|
|
24311
|
+
tags:
|
|
24312
|
+
- Case Management
|
|
24313
|
+
/api/v2/cases/{case_id}/unarchive:
|
|
24314
|
+
post:
|
|
24315
|
+
description: Unarchive case
|
|
24316
|
+
operationId: UnarchiveCase
|
|
24317
|
+
parameters:
|
|
24318
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24319
|
+
requestBody:
|
|
24320
|
+
content:
|
|
24321
|
+
application/json:
|
|
24322
|
+
schema:
|
|
24323
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
|
24324
|
+
description: Unarchive case payload
|
|
24325
|
+
required: true
|
|
24326
|
+
responses:
|
|
24327
|
+
'200':
|
|
24328
|
+
content:
|
|
24329
|
+
application/json:
|
|
24330
|
+
schema:
|
|
24331
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24332
|
+
description: OK
|
|
24333
|
+
'400':
|
|
24334
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24335
|
+
'401':
|
|
24336
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24337
|
+
'403':
|
|
24338
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24339
|
+
'404':
|
|
24340
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24341
|
+
'429':
|
|
24342
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24343
|
+
security:
|
|
24344
|
+
- apiKeyAuth: []
|
|
24345
|
+
appKeyAuth: []
|
|
24346
|
+
- AuthZ:
|
|
24347
|
+
- cases_write
|
|
24348
|
+
summary: Unarchive case
|
|
24349
|
+
tags:
|
|
24350
|
+
- Case Management
|
|
24351
|
+
/api/v2/cases/{case_id}/unassign:
|
|
24352
|
+
post:
|
|
24353
|
+
description: Unassign case
|
|
24354
|
+
operationId: UnassignCase
|
|
24355
|
+
parameters:
|
|
24356
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
|
24357
|
+
requestBody:
|
|
24358
|
+
content:
|
|
24359
|
+
application/json:
|
|
24360
|
+
schema:
|
|
24361
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
|
24362
|
+
description: Unassign case payload
|
|
24363
|
+
required: true
|
|
24364
|
+
responses:
|
|
24365
|
+
'200':
|
|
24366
|
+
content:
|
|
24367
|
+
application/json:
|
|
24368
|
+
schema:
|
|
24369
|
+
$ref: '#/components/schemas/CaseResponse'
|
|
24370
|
+
description: OK
|
|
24371
|
+
'400':
|
|
24372
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24373
|
+
'401':
|
|
24374
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
24375
|
+
'403':
|
|
24376
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24377
|
+
'404':
|
|
24378
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24379
|
+
'429':
|
|
24380
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24381
|
+
security:
|
|
24382
|
+
- apiKeyAuth: []
|
|
24383
|
+
appKeyAuth: []
|
|
24384
|
+
- AuthZ:
|
|
24385
|
+
- cases_write
|
|
24386
|
+
summary: Unassign case
|
|
24387
|
+
tags:
|
|
24388
|
+
- Case Management
|
|
22120
24389
|
/api/v2/ci/pipeline:
|
|
22121
24390
|
post:
|
|
22122
24391
|
description: 'Send your pipeline event to your Datadog platform over HTTP. For
|
|
@@ -22389,8 +24658,8 @@ paths:
|
|
|
22389
24658
|
x-codegen-request-body-name: body
|
|
22390
24659
|
/api/v2/ci/tests/events:
|
|
22391
24660
|
get:
|
|
22392
|
-
description: 'List endpoint returns CI Visibility test events that match a [
|
|
22393
|
-
|
|
24661
|
+
description: 'List endpoint returns CI Visibility test events that match a [search
|
|
24662
|
+
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
22394
24663
|
|
|
22395
24664
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
22396
24665
|
|
|
@@ -22473,8 +24742,8 @@ paths:
|
|
|
22473
24742
|
resultsPath: data
|
|
22474
24743
|
/api/v2/ci/tests/events/search:
|
|
22475
24744
|
post:
|
|
22476
|
-
description: 'List endpoint returns CI Visibility test events that match a [
|
|
22477
|
-
|
|
24745
|
+
description: 'List endpoint returns CI Visibility test events that match a [search
|
|
24746
|
+
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
22478
24747
|
|
|
22479
24748
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
22480
24749
|
|
|
@@ -22996,7 +25265,7 @@ paths:
|
|
|
22996
25265
|
/api/v2/cost_by_tag/active_billing_dimensions:
|
|
22997
25266
|
get:
|
|
22998
25267
|
description: Get active billing dimensions for cost attribution. Cost data for
|
|
22999
|
-
a given month becomes available no later than the
|
|
25268
|
+
a given month becomes available no later than the 19th of the following month.
|
|
23000
25269
|
operationId: GetActiveBillingDimensions
|
|
23001
25270
|
responses:
|
|
23002
25271
|
'200':
|
|
@@ -23038,7 +25307,7 @@ paths:
|
|
|
23038
25307
|
get:
|
|
23039
25308
|
description: "Get monthly cost attribution by tag across multi-org and single
|
|
23040
25309
|
root-org accounts.\nCost Attribution data for a given month becomes available
|
|
23041
|
-
no later than the
|
|
25310
|
+
no later than the 19th of the following month.\nThis API endpoint is paginated.
|
|
23042
25311
|
To make sure you receive all records, check if the value of `next_record_id`
|
|
23043
25312
|
is\nset in the response. If it is, make another request and pass `next_record_id`
|
|
23044
25313
|
as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month,
|
|
@@ -26397,6 +28666,135 @@ paths:
|
|
|
26397
28666
|
tags:
|
|
26398
28667
|
- Logs Archives
|
|
26399
28668
|
x-codegen-request-body-name: body
|
|
28669
|
+
/api/v2/logs/config/custom-destinations:
|
|
28670
|
+
get:
|
|
28671
|
+
description: Get the list of configured custom destinations in your organization
|
|
28672
|
+
with their definitions.
|
|
28673
|
+
operationId: ListLogsCustomDestinations
|
|
28674
|
+
responses:
|
|
28675
|
+
'200':
|
|
28676
|
+
content:
|
|
28677
|
+
application/json:
|
|
28678
|
+
schema:
|
|
28679
|
+
$ref: '#/components/schemas/CustomDestinationsResponse'
|
|
28680
|
+
description: OK
|
|
28681
|
+
'403':
|
|
28682
|
+
content:
|
|
28683
|
+
application/json:
|
|
28684
|
+
schema:
|
|
28685
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
28686
|
+
description: Forbidden
|
|
28687
|
+
'429':
|
|
28688
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28689
|
+
summary: Get all custom destinations
|
|
28690
|
+
tags:
|
|
28691
|
+
- Logs Custom Destinations
|
|
28692
|
+
post:
|
|
28693
|
+
description: Create a custom destination in your organization.
|
|
28694
|
+
operationId: CreateLogsCustomDestination
|
|
28695
|
+
requestBody:
|
|
28696
|
+
content:
|
|
28697
|
+
application/json:
|
|
28698
|
+
schema:
|
|
28699
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequest'
|
|
28700
|
+
description: The definition of the new custom destination.
|
|
28701
|
+
required: true
|
|
28702
|
+
responses:
|
|
28703
|
+
'200':
|
|
28704
|
+
content:
|
|
28705
|
+
application/json:
|
|
28706
|
+
schema:
|
|
28707
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
|
28708
|
+
description: OK
|
|
28709
|
+
'400':
|
|
28710
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28711
|
+
'403':
|
|
28712
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28713
|
+
'409':
|
|
28714
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
28715
|
+
'429':
|
|
28716
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28717
|
+
summary: Create a custom destination
|
|
28718
|
+
tags:
|
|
28719
|
+
- Logs Custom Destinations
|
|
28720
|
+
x-codegen-request-body-name: body
|
|
28721
|
+
/api/v2/logs/config/custom-destinations/{custom_destination_id}:
|
|
28722
|
+
delete:
|
|
28723
|
+
description: Delete a specific custom destination in your organization.
|
|
28724
|
+
operationId: DeleteLogsCustomDestination
|
|
28725
|
+
parameters:
|
|
28726
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
|
28727
|
+
responses:
|
|
28728
|
+
'204':
|
|
28729
|
+
description: OK
|
|
28730
|
+
'400':
|
|
28731
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28732
|
+
'403':
|
|
28733
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28734
|
+
'404':
|
|
28735
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
28736
|
+
'429':
|
|
28737
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28738
|
+
summary: Delete a custom destination
|
|
28739
|
+
tags:
|
|
28740
|
+
- Logs Custom Destinations
|
|
28741
|
+
get:
|
|
28742
|
+
description: Get a specific custom destination in your organization.
|
|
28743
|
+
operationId: GetLogsCustomDestination
|
|
28744
|
+
parameters:
|
|
28745
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
|
28746
|
+
responses:
|
|
28747
|
+
'200':
|
|
28748
|
+
content:
|
|
28749
|
+
application/json:
|
|
28750
|
+
schema:
|
|
28751
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
|
28752
|
+
description: OK
|
|
28753
|
+
'400':
|
|
28754
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28755
|
+
'403':
|
|
28756
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28757
|
+
'404':
|
|
28758
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
28759
|
+
'429':
|
|
28760
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28761
|
+
summary: Get a custom destination
|
|
28762
|
+
tags:
|
|
28763
|
+
- Logs Custom Destinations
|
|
28764
|
+
patch:
|
|
28765
|
+
description: Update the given fields of a specific custom destination in your
|
|
28766
|
+
organization.
|
|
28767
|
+
operationId: UpdateLogsCustomDestination
|
|
28768
|
+
parameters:
|
|
28769
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
|
28770
|
+
requestBody:
|
|
28771
|
+
content:
|
|
28772
|
+
application/json:
|
|
28773
|
+
schema:
|
|
28774
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequest'
|
|
28775
|
+
description: New definition of the custom destination's fields.
|
|
28776
|
+
required: true
|
|
28777
|
+
responses:
|
|
28778
|
+
'200':
|
|
28779
|
+
content:
|
|
28780
|
+
application/json:
|
|
28781
|
+
schema:
|
|
28782
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
|
28783
|
+
description: OK
|
|
28784
|
+
'400':
|
|
28785
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
28786
|
+
'403':
|
|
28787
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
28788
|
+
'404':
|
|
28789
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
28790
|
+
'409':
|
|
28791
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
28792
|
+
'429':
|
|
28793
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
28794
|
+
summary: Update a custom destination
|
|
28795
|
+
tags:
|
|
28796
|
+
- Logs Custom Destinations
|
|
28797
|
+
x-codegen-request-body-name: body
|
|
26400
28798
|
/api/v2/logs/config/metrics:
|
|
26401
28799
|
get:
|
|
26402
28800
|
description: Get the list of configured log-based metrics with their definitions.
|
|
@@ -26910,8 +29308,8 @@ paths:
|
|
|
26910
29308
|
x-codegen-request-body-name: body
|
|
26911
29309
|
/api/v2/metrics/{metric_name}/active-configurations:
|
|
26912
29310
|
get:
|
|
26913
|
-
description: List tags and aggregations that are actively queried on dashboards
|
|
26914
|
-
|
|
29311
|
+
description: List tags and aggregations that are actively queried on dashboards,
|
|
29312
|
+
notebooks, monitors, and the Metrics Explorer for a given metric name.
|
|
26915
29313
|
operationId: ListActiveMetricConfigurations
|
|
26916
29314
|
parameters:
|
|
26917
29315
|
- $ref: '#/components/parameters/MetricName'
|
|
@@ -27010,6 +29408,51 @@ paths:
|
|
|
27010
29408
|
summary: List tags by metric name
|
|
27011
29409
|
tags:
|
|
27012
29410
|
- Metrics
|
|
29411
|
+
/api/v2/metrics/{metric_name}/assets:
|
|
29412
|
+
get:
|
|
29413
|
+
description: Returns dashboards, monitors, notebooks, and SLOs that a metric
|
|
29414
|
+
is stored in, if any. Updated every 24 hours.
|
|
29415
|
+
operationId: ListMetricAssets
|
|
29416
|
+
parameters:
|
|
29417
|
+
- $ref: '#/components/parameters/MetricName'
|
|
29418
|
+
responses:
|
|
29419
|
+
'200':
|
|
29420
|
+
content:
|
|
29421
|
+
application/json:
|
|
29422
|
+
schema:
|
|
29423
|
+
$ref: '#/components/schemas/MetricAssetsResponse'
|
|
29424
|
+
description: Success
|
|
29425
|
+
'400':
|
|
29426
|
+
content:
|
|
29427
|
+
application/json:
|
|
29428
|
+
schema:
|
|
29429
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29430
|
+
description: API error response.
|
|
29431
|
+
'403':
|
|
29432
|
+
content:
|
|
29433
|
+
application/json:
|
|
29434
|
+
schema:
|
|
29435
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29436
|
+
description: API error response.
|
|
29437
|
+
'404':
|
|
29438
|
+
content:
|
|
29439
|
+
application/json:
|
|
29440
|
+
schema:
|
|
29441
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29442
|
+
description: API error response.
|
|
29443
|
+
'429':
|
|
29444
|
+
content:
|
|
29445
|
+
application/json:
|
|
29446
|
+
schema:
|
|
29447
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
29448
|
+
description: Too Many Requests
|
|
29449
|
+
security:
|
|
29450
|
+
- apiKeyAuth: []
|
|
29451
|
+
appKeyAuth: []
|
|
29452
|
+
- AuthZ: []
|
|
29453
|
+
summary: Related Assets to a Metric
|
|
29454
|
+
tags:
|
|
29455
|
+
- Metrics
|
|
27013
29456
|
/api/v2/metrics/{metric_name}/estimate:
|
|
27014
29457
|
get:
|
|
27015
29458
|
description: Returns the estimated cardinality for a metric with a given tag,
|
|
@@ -27026,7 +29469,8 @@ paths:
|
|
|
27026
29469
|
schema:
|
|
27027
29470
|
type: string
|
|
27028
29471
|
- description: The number of hours of look back (from now) to estimate cardinality
|
|
27029
|
-
with.
|
|
29472
|
+
with. Estimates are based on historical data, and unspecified fields default
|
|
29473
|
+
to the minimum 49 hours.
|
|
27030
29474
|
example: 49
|
|
27031
29475
|
in: query
|
|
27032
29476
|
name: filter[hours_ago]
|
|
@@ -27034,6 +29478,7 @@ paths:
|
|
|
27034
29478
|
schema:
|
|
27035
29479
|
format: int32
|
|
27036
29480
|
maximum: 2147483647
|
|
29481
|
+
minimum: 49
|
|
27037
29482
|
type: integer
|
|
27038
29483
|
- description: The number of aggregations that a `count`, `rate`, or `gauge`
|
|
27039
29484
|
metric is configured to use. Max number of aggregation combos is 9.
|
|
@@ -27101,19 +29546,6 @@ paths:
|
|
|
27101
29546
|
summary: Tag Configuration Cardinality Estimator
|
|
27102
29547
|
tags:
|
|
27103
29548
|
- Metrics
|
|
27104
|
-
x-dd-ownership:
|
|
27105
|
-
notification_configuration:
|
|
27106
|
-
manual_escalation_policy: '[Points Aggregation] Primary'
|
|
27107
|
-
prod_high_urgency: '@pagerduty-Points-Aggregation @slack-points-aggr-ops'
|
|
27108
|
-
prod_low_urgency: '@slack-points-aggr-ops'
|
|
27109
|
-
slack_support_channel: '#points-aggregation'
|
|
27110
|
-
staging_high_urgency: '@slack-points-aggr-stg-ops'
|
|
27111
|
-
staging_low_urgency: '@slack-points-aggr-stg-ops'
|
|
27112
|
-
team: points-aggregation
|
|
27113
|
-
team_escalation: '[Points Aggregation] Primary'
|
|
27114
|
-
x-permission:
|
|
27115
|
-
operator: OPEN
|
|
27116
|
-
permissions: []
|
|
27117
29549
|
/api/v2/metrics/{metric_name}/tags:
|
|
27118
29550
|
delete:
|
|
27119
29551
|
description: 'Deletes a metric''s tag configuration. Can only be used with application
|
|
@@ -28224,6 +30656,154 @@ paths:
|
|
|
28224
30656
|
We are gradually onboarding support for more sources. If you have any
|
|
28225
30657
|
|
|
28226
30658
|
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
|
30659
|
+
/api/v2/remote_config/products/cws/agent_rules:
|
|
30660
|
+
get:
|
|
30661
|
+
description: Get the list of Cloud Security Management Threats Agent rules.
|
|
30662
|
+
operationId: ListCSMThreatsAgentRules
|
|
30663
|
+
responses:
|
|
30664
|
+
'200':
|
|
30665
|
+
content:
|
|
30666
|
+
application/json:
|
|
30667
|
+
schema:
|
|
30668
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse'
|
|
30669
|
+
description: OK
|
|
30670
|
+
'403':
|
|
30671
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30672
|
+
'429':
|
|
30673
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30674
|
+
summary: Get all CSM Threats Agent rules
|
|
30675
|
+
tags:
|
|
30676
|
+
- Cloud Workload Security
|
|
30677
|
+
post:
|
|
30678
|
+
description: Create a new Cloud Security Management Threats Agent rule with
|
|
30679
|
+
the given parameters.
|
|
30680
|
+
operationId: CreateCSMThreatsAgentRule
|
|
30681
|
+
requestBody:
|
|
30682
|
+
content:
|
|
30683
|
+
application/json:
|
|
30684
|
+
schema:
|
|
30685
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest'
|
|
30686
|
+
description: The definition of the new Agent rule.
|
|
30687
|
+
required: true
|
|
30688
|
+
responses:
|
|
30689
|
+
'200':
|
|
30690
|
+
content:
|
|
30691
|
+
application/json:
|
|
30692
|
+
schema:
|
|
30693
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
|
30694
|
+
description: OK
|
|
30695
|
+
'400':
|
|
30696
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
30697
|
+
'403':
|
|
30698
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30699
|
+
'409':
|
|
30700
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
30701
|
+
'429':
|
|
30702
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30703
|
+
summary: Create a CSM Threats Agent rule
|
|
30704
|
+
tags:
|
|
30705
|
+
- Cloud Workload Security
|
|
30706
|
+
x-codegen-request-body-name: body
|
|
30707
|
+
/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}:
|
|
30708
|
+
delete:
|
|
30709
|
+
description: Delete a specific Cloud Security Management Threats Agent rule.
|
|
30710
|
+
operationId: DeleteCSMThreatsAgentRule
|
|
30711
|
+
parameters:
|
|
30712
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
|
30713
|
+
responses:
|
|
30714
|
+
'204':
|
|
30715
|
+
description: OK
|
|
30716
|
+
'403':
|
|
30717
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30718
|
+
'404':
|
|
30719
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
30720
|
+
'429':
|
|
30721
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30722
|
+
summary: Delete a CSM Threats Agent rule
|
|
30723
|
+
tags:
|
|
30724
|
+
- Cloud Workload Security
|
|
30725
|
+
get:
|
|
30726
|
+
description: Get the details of a specific Cloud Security Management Threats
|
|
30727
|
+
Agent rule.
|
|
30728
|
+
operationId: GetCSMThreatsAgentRule
|
|
30729
|
+
parameters:
|
|
30730
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
|
30731
|
+
responses:
|
|
30732
|
+
'200':
|
|
30733
|
+
content:
|
|
30734
|
+
application/json:
|
|
30735
|
+
schema:
|
|
30736
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
|
30737
|
+
description: OK
|
|
30738
|
+
'403':
|
|
30739
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30740
|
+
'404':
|
|
30741
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
30742
|
+
'429':
|
|
30743
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30744
|
+
summary: Get a CSM Threats Agent rule
|
|
30745
|
+
tags:
|
|
30746
|
+
- Cloud Workload Security
|
|
30747
|
+
patch:
|
|
30748
|
+
description: 'Update a specific Cloud Security Management Threats Agent rule.
|
|
30749
|
+
|
|
30750
|
+
Returns the Agent rule object when the request is successful.'
|
|
30751
|
+
operationId: UpdateCSMThreatsAgentRule
|
|
30752
|
+
parameters:
|
|
30753
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
|
30754
|
+
requestBody:
|
|
30755
|
+
content:
|
|
30756
|
+
application/json:
|
|
30757
|
+
schema:
|
|
30758
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest'
|
|
30759
|
+
description: New definition of the Agent rule.
|
|
30760
|
+
required: true
|
|
30761
|
+
responses:
|
|
30762
|
+
'200':
|
|
30763
|
+
content:
|
|
30764
|
+
application/json:
|
|
30765
|
+
schema:
|
|
30766
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
|
30767
|
+
description: OK
|
|
30768
|
+
'400':
|
|
30769
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
30770
|
+
'403':
|
|
30771
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30772
|
+
'404':
|
|
30773
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
30774
|
+
'409':
|
|
30775
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
|
30776
|
+
'429':
|
|
30777
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30778
|
+
summary: Update a CSM Threats Agent rule
|
|
30779
|
+
tags:
|
|
30780
|
+
- Cloud Workload Security
|
|
30781
|
+
x-codegen-request-body-name: body
|
|
30782
|
+
/api/v2/remote_config/products/cws/policy/download:
|
|
30783
|
+
get:
|
|
30784
|
+
description: 'The download endpoint generates a CSM Threats policy file from
|
|
30785
|
+
your currently active
|
|
30786
|
+
|
|
30787
|
+
CSM Threats rules, and downloads them as a `.policy` file. This file can then
|
|
30788
|
+
be deployed to
|
|
30789
|
+
|
|
30790
|
+
your Agents to update the policy running in your environment.'
|
|
30791
|
+
operationId: DownloadCSMThreatsPolicy
|
|
30792
|
+
responses:
|
|
30793
|
+
'200':
|
|
30794
|
+
content:
|
|
30795
|
+
application/zip:
|
|
30796
|
+
schema:
|
|
30797
|
+
format: binary
|
|
30798
|
+
type: string
|
|
30799
|
+
description: OK
|
|
30800
|
+
'403':
|
|
30801
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
30802
|
+
'429':
|
|
30803
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30804
|
+
summary: Get the latest CSM Threats policy
|
|
30805
|
+
tags:
|
|
30806
|
+
- Cloud Workload Security
|
|
28227
30807
|
/api/v2/restriction_policy/{resource_id}:
|
|
28228
30808
|
delete:
|
|
28229
30809
|
description: Deletes the restriction policy associated with a specified resource.
|
|
@@ -29986,6 +32566,34 @@ paths:
|
|
|
29986
32566
|
tags:
|
|
29987
32567
|
- Security Monitoring
|
|
29988
32568
|
x-codegen-request-body-name: body
|
|
32569
|
+
/api/v2/security_monitoring/rules/validation:
|
|
32570
|
+
post:
|
|
32571
|
+
description: Validate a detection rule.
|
|
32572
|
+
operationId: ValidateSecurityMonitoringRule
|
|
32573
|
+
requestBody:
|
|
32574
|
+
content:
|
|
32575
|
+
application/json:
|
|
32576
|
+
schema:
|
|
32577
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
|
|
32578
|
+
required: true
|
|
32579
|
+
responses:
|
|
32580
|
+
'204':
|
|
32581
|
+
description: OK
|
|
32582
|
+
'400':
|
|
32583
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
32584
|
+
'403':
|
|
32585
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
32586
|
+
'429':
|
|
32587
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32588
|
+
security:
|
|
32589
|
+
- apiKeyAuth: []
|
|
32590
|
+
appKeyAuth: []
|
|
32591
|
+
- AuthZ:
|
|
32592
|
+
- security_monitoring_rules_write
|
|
32593
|
+
summary: Validate a detection rule
|
|
32594
|
+
tags:
|
|
32595
|
+
- Security Monitoring
|
|
32596
|
+
x-codegen-request-body-name: body
|
|
29989
32597
|
/api/v2/security_monitoring/rules/{rule_id}:
|
|
29990
32598
|
delete:
|
|
29991
32599
|
description: Delete an existing rule. Default rules cannot be deleted.
|
|
@@ -30991,6 +33599,7 @@ paths:
|
|
|
30991
33599
|
x-codegen-request-body-name: body
|
|
30992
33600
|
/api/v2/services:
|
|
30993
33601
|
get:
|
|
33602
|
+
deprecated: true
|
|
30994
33603
|
description: Get all incident services uploaded for the requesting user's organization.
|
|
30995
33604
|
If the `include[users]` query parameter is provided, the included attribute
|
|
30996
33605
|
will contain the users related to these incident services.
|
|
@@ -31025,10 +33634,9 @@ paths:
|
|
|
31025
33634
|
summary: Get a list of all incident services
|
|
31026
33635
|
tags:
|
|
31027
33636
|
- Incident Services
|
|
31028
|
-
x-unstable: '**Note**: This endpoint is
|
|
31029
|
-
|
|
31030
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33637
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
31031
33638
|
post:
|
|
33639
|
+
deprecated: true
|
|
31032
33640
|
description: Creates a new incident service.
|
|
31033
33641
|
operationId: CreateIncidentService
|
|
31034
33642
|
requestBody:
|
|
@@ -31064,9 +33672,7 @@ paths:
|
|
|
31064
33672
|
tags:
|
|
31065
33673
|
- Incident Services
|
|
31066
33674
|
x-codegen-request-body-name: body
|
|
31067
|
-
x-unstable: '**Note**: This endpoint is
|
|
31068
|
-
|
|
31069
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33675
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
31070
33676
|
/api/v2/services/definitions:
|
|
31071
33677
|
get:
|
|
31072
33678
|
description: Get a list of all service definitions from the Datadog Service
|
|
@@ -31097,7 +33703,7 @@ paths:
|
|
|
31097
33703
|
- Service Definition
|
|
31098
33704
|
x-pagination:
|
|
31099
33705
|
limitParam: page[size]
|
|
31100
|
-
|
|
33706
|
+
pageParam: page[number]
|
|
31101
33707
|
resultsPath: data
|
|
31102
33708
|
post:
|
|
31103
33709
|
description: Create or update service definition in the Datadog Service Catalog.
|
|
@@ -31191,6 +33797,7 @@ paths:
|
|
|
31191
33797
|
- Service Definition
|
|
31192
33798
|
/api/v2/services/{service_id}:
|
|
31193
33799
|
delete:
|
|
33800
|
+
deprecated: true
|
|
31194
33801
|
description: Deletes an existing incident service.
|
|
31195
33802
|
operationId: DeleteIncidentService
|
|
31196
33803
|
parameters:
|
|
@@ -31216,10 +33823,9 @@ paths:
|
|
|
31216
33823
|
summary: Delete an existing incident service
|
|
31217
33824
|
tags:
|
|
31218
33825
|
- Incident Services
|
|
31219
|
-
x-unstable: '**Note**: This endpoint is
|
|
31220
|
-
|
|
31221
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33826
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
31222
33827
|
get:
|
|
33828
|
+
deprecated: true
|
|
31223
33829
|
description: 'Get details of an incident service. If the `include[users]` query
|
|
31224
33830
|
parameter is provided,
|
|
31225
33831
|
|
|
@@ -31253,10 +33859,9 @@ paths:
|
|
|
31253
33859
|
summary: Get details of an incident service
|
|
31254
33860
|
tags:
|
|
31255
33861
|
- Incident Services
|
|
31256
|
-
x-unstable: '**Note**: This endpoint is
|
|
31257
|
-
|
|
31258
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33862
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
31259
33863
|
patch:
|
|
33864
|
+
deprecated: true
|
|
31260
33865
|
description: Updates an existing incident service. Only provide the attributes
|
|
31261
33866
|
which should be updated as this request is a partial update.
|
|
31262
33867
|
operationId: UpdateIncidentService
|
|
@@ -31295,9 +33900,150 @@ paths:
|
|
|
31295
33900
|
tags:
|
|
31296
33901
|
- Incident Services
|
|
31297
33902
|
x-codegen-request-body-name: body
|
|
31298
|
-
x-unstable: '**Note**: This endpoint is
|
|
33903
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
|
33904
|
+
/api/v2/slo/report:
|
|
33905
|
+
post:
|
|
33906
|
+
description: 'Create a job to generate an SLO report. The report job is processed
|
|
33907
|
+
asynchronously and eventually results in a CSV report being available for
|
|
33908
|
+
download.
|
|
31299
33909
|
|
|
31300
|
-
|
|
33910
|
+
|
|
33911
|
+
Check the status of the job and download the CSV report using the returned
|
|
33912
|
+
`report_id`.'
|
|
33913
|
+
operationId: CreateSLOReportJob
|
|
33914
|
+
requestBody:
|
|
33915
|
+
content:
|
|
33916
|
+
application/json:
|
|
33917
|
+
schema:
|
|
33918
|
+
$ref: '#/components/schemas/SloReportCreateRequest'
|
|
33919
|
+
description: Create SLO report job request body.
|
|
33920
|
+
required: true
|
|
33921
|
+
responses:
|
|
33922
|
+
'200':
|
|
33923
|
+
content:
|
|
33924
|
+
application/json:
|
|
33925
|
+
schema:
|
|
33926
|
+
$ref: '#/components/schemas/SLOReportPostResponse'
|
|
33927
|
+
description: OK
|
|
33928
|
+
'400':
|
|
33929
|
+
content:
|
|
33930
|
+
application/json:
|
|
33931
|
+
schema:
|
|
33932
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
33933
|
+
description: Bad Request
|
|
33934
|
+
'403':
|
|
33935
|
+
content:
|
|
33936
|
+
application/json:
|
|
33937
|
+
schema:
|
|
33938
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
33939
|
+
description: Forbidden
|
|
33940
|
+
'429':
|
|
33941
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
33942
|
+
security:
|
|
33943
|
+
- apiKeyAuth: []
|
|
33944
|
+
appKeyAuth: []
|
|
33945
|
+
- AuthZ:
|
|
33946
|
+
- slos_read
|
|
33947
|
+
summary: Create a new SLO report
|
|
33948
|
+
tags:
|
|
33949
|
+
- Service Level Objectives
|
|
33950
|
+
x-codegen-request-body-name: body
|
|
33951
|
+
x-unstable: '**Note**: This feature is in private beta. To request access, use
|
|
33952
|
+
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
|
|
33953
|
+
docs.'
|
|
33954
|
+
/api/v2/slo/report/{report_id}/download:
|
|
33955
|
+
get:
|
|
33956
|
+
description: 'Download an SLO report. This can only be performed after the report
|
|
33957
|
+
job has completed.
|
|
33958
|
+
|
|
33959
|
+
|
|
33960
|
+
Reports are not guaranteed to exist indefinitely. Datadog recommends that
|
|
33961
|
+
you download the report as soon as it is available.'
|
|
33962
|
+
operationId: GetSLOReport
|
|
33963
|
+
parameters:
|
|
33964
|
+
- $ref: '#/components/parameters/ReportID'
|
|
33965
|
+
responses:
|
|
33966
|
+
'200':
|
|
33967
|
+
content:
|
|
33968
|
+
text/csv:
|
|
33969
|
+
schema:
|
|
33970
|
+
type: string
|
|
33971
|
+
description: OK
|
|
33972
|
+
'400':
|
|
33973
|
+
content:
|
|
33974
|
+
application/json:
|
|
33975
|
+
schema:
|
|
33976
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
33977
|
+
description: Bad Request
|
|
33978
|
+
'403':
|
|
33979
|
+
content:
|
|
33980
|
+
application/json:
|
|
33981
|
+
schema:
|
|
33982
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
33983
|
+
description: Forbidden
|
|
33984
|
+
'404':
|
|
33985
|
+
content:
|
|
33986
|
+
application/json:
|
|
33987
|
+
schema:
|
|
33988
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
33989
|
+
description: Not Found
|
|
33990
|
+
'429':
|
|
33991
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
33992
|
+
security:
|
|
33993
|
+
- apiKeyAuth: []
|
|
33994
|
+
appKeyAuth: []
|
|
33995
|
+
- AuthZ:
|
|
33996
|
+
- slos_read
|
|
33997
|
+
summary: Get SLO report
|
|
33998
|
+
tags:
|
|
33999
|
+
- Service Level Objectives
|
|
34000
|
+
x-unstable: '**Note**: This feature is in private beta. To request access, use
|
|
34001
|
+
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
|
|
34002
|
+
docs.'
|
|
34003
|
+
/api/v2/slo/report/{report_id}/status:
|
|
34004
|
+
get:
|
|
34005
|
+
description: Get the status of the SLO report job.
|
|
34006
|
+
operationId: GetSLOReportJobStatus
|
|
34007
|
+
parameters:
|
|
34008
|
+
- $ref: '#/components/parameters/ReportID'
|
|
34009
|
+
responses:
|
|
34010
|
+
'200':
|
|
34011
|
+
content:
|
|
34012
|
+
application/json:
|
|
34013
|
+
schema:
|
|
34014
|
+
$ref: '#/components/schemas/SLOReportStatusGetResponse'
|
|
34015
|
+
description: OK
|
|
34016
|
+
'400':
|
|
34017
|
+
content:
|
|
34018
|
+
application/json:
|
|
34019
|
+
schema:
|
|
34020
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
34021
|
+
description: Bad Request
|
|
34022
|
+
'403':
|
|
34023
|
+
content:
|
|
34024
|
+
application/json:
|
|
34025
|
+
schema:
|
|
34026
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
34027
|
+
description: Forbidden
|
|
34028
|
+
'404':
|
|
34029
|
+
content:
|
|
34030
|
+
application/json:
|
|
34031
|
+
schema:
|
|
34032
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
34033
|
+
description: Not Found
|
|
34034
|
+
'429':
|
|
34035
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
34036
|
+
security:
|
|
34037
|
+
- apiKeyAuth: []
|
|
34038
|
+
appKeyAuth: []
|
|
34039
|
+
- AuthZ:
|
|
34040
|
+
- slos_read
|
|
34041
|
+
summary: Get SLO report status
|
|
34042
|
+
tags:
|
|
34043
|
+
- Service Level Objectives
|
|
34044
|
+
x-unstable: '**Note**: This feature is in private beta. To request access, use
|
|
34045
|
+
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
|
|
34046
|
+
docs.'
|
|
31301
34047
|
/api/v2/spans/analytics/aggregate:
|
|
31302
34048
|
post:
|
|
31303
34049
|
description: 'The API endpoint to aggregate spans into buckets and compute metrics
|
|
@@ -32398,10 +35144,11 @@ paths:
|
|
|
32398
35144
|
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
|
|
32399
35145
|
/api/v2/usage/application_security:
|
|
32400
35146
|
get:
|
|
35147
|
+
deprecated: true
|
|
32401
35148
|
description: 'Get hourly usage for application security .
|
|
32402
35149
|
|
|
32403
|
-
**Note:**
|
|
32404
|
-
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
|
35150
|
+
**Note:** This endpoint has been deprecated. Hourly usage data for all products
|
|
35151
|
+
is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
|
32405
35152
|
operationId: GetUsageApplicationSecurityMonitoring
|
|
32406
35153
|
parameters:
|
|
32407
35154
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
@@ -32699,10 +35446,10 @@ paths:
|
|
|
32699
35446
|
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
|
|
32700
35447
|
|
|
32701
35448
|
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
|
|
32702
|
-
`cws`, `dbm`, `
|
|
35449
|
+
`cws`, `dbm`, `error_tracking`,
|
|
32703
35450
|
|
|
32704
|
-
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
|
|
32705
|
-
`iot`,
|
|
35451
|
+
`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
|
|
35452
|
+
`ingested_spans`, `iot`,
|
|
32706
35453
|
|
|
32707
35454
|
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `netflow_monitoring`,
|
|
32708
35455
|
`observability_pipelines`,
|
|
@@ -32799,10 +35546,11 @@ paths:
|
|
|
32799
35546
|
- Usage Metering
|
|
32800
35547
|
/api/v2/usage/lambda_traced_invocations:
|
|
32801
35548
|
get:
|
|
35549
|
+
deprecated: true
|
|
32802
35550
|
description: 'Get hourly usage for Lambda traced invocations.
|
|
32803
35551
|
|
|
32804
|
-
**Note:**
|
|
32805
|
-
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
|
35552
|
+
**Note:** This endpoint has been deprecated.. Hourly usage data for all products
|
|
35553
|
+
is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
|
32806
35554
|
operationId: GetUsageLambdaTracedInvocations
|
|
32807
35555
|
parameters:
|
|
32808
35556
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
@@ -32858,10 +35606,11 @@ paths:
|
|
|
32858
35606
|
- Usage Metering
|
|
32859
35607
|
/api/v2/usage/observability_pipelines:
|
|
32860
35608
|
get:
|
|
35609
|
+
deprecated: true
|
|
32861
35610
|
description: 'Get hourly usage for observability pipelines.
|
|
32862
35611
|
|
|
32863
|
-
**Note:**
|
|
32864
|
-
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
|
35612
|
+
**Note:** This endpoint has been deprecated. Hourly usage data for all products
|
|
35613
|
+
is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
|
32865
35614
|
operationId: GetUsageObservabilityPipelines
|
|
32866
35615
|
parameters:
|
|
32867
35616
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
@@ -33463,6 +36212,15 @@ tags:
|
|
|
33463
36212
|
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
|
|
33464
36213
|
information.
|
|
33465
36214
|
name: CI Visibility Tests
|
|
36215
|
+
- description: Cloud Security Management Threats (CSM Threats) monitors file, network,
|
|
36216
|
+
and process activity across your environment to detect real-time threats to your
|
|
36217
|
+
infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/)
|
|
36218
|
+
for more information on setting up CSM Threats.
|
|
36219
|
+
name: CSM Threats
|
|
36220
|
+
- description: View and manage cases and projects within Case Management. See the
|
|
36221
|
+
[Case Management page](https://docs.datadoghq.com/service_management/case_management/)
|
|
36222
|
+
for more information.
|
|
36223
|
+
name: Case Management
|
|
33466
36224
|
- description: The Cloud Cost Management API allows you to set up, edit, and delete
|
|
33467
36225
|
Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management
|
|
33468
36226
|
page](https://docs.datadoghq.com/cloud_cost_management/) for more information.
|
|
@@ -33534,7 +36292,8 @@ tags:
|
|
|
33534
36292
|
|
|
33535
36293
|
This is an enterprise-only feature. Request access by
|
|
33536
36294
|
|
|
33537
|
-
contacting Datadog support.
|
|
36295
|
+
contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/)
|
|
36296
|
+
for more information.'
|
|
33538
36297
|
name: IP Allowlist
|
|
33539
36298
|
- description: Create, update, delete, and retrieve services which can be associated
|
|
33540
36299
|
with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
|
|
@@ -33560,17 +36319,32 @@ tags:
|
|
|
33560
36319
|
url: https://docs.datadoghq.com/account_management/api-app-keys/
|
|
33561
36320
|
name: Key Management
|
|
33562
36321
|
- description: Search your logs and send them to your Datadog platform over HTTP.
|
|
36322
|
+
See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.
|
|
33563
36323
|
name: Logs
|
|
33564
36324
|
- description: 'Archives forward all the logs ingested to a cloud storage system.
|
|
33565
36325
|
|
|
33566
36326
|
|
|
33567
36327
|
See the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives)
|
|
33568
36328
|
|
|
33569
|
-
for a list of the archives currently configured in
|
|
36329
|
+
for a list of the archives currently configured in Datadog.'
|
|
33570
36330
|
externalDocs:
|
|
33571
36331
|
description: Find out more at
|
|
33572
36332
|
url: https://docs.datadoghq.com/logs/archives/
|
|
33573
36333
|
name: Logs Archives
|
|
36334
|
+
- description: 'Custom Destinations forward all the logs ingested to an external destination.
|
|
36335
|
+
|
|
36336
|
+
|
|
36337
|
+
**Note**: Log forwarding is not available for the Government (US1-FED) site. Contact
|
|
36338
|
+
your account representative for more information.
|
|
36339
|
+
|
|
36340
|
+
|
|
36341
|
+
See the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations)
|
|
36342
|
+
|
|
36343
|
+
for a list of the custom destinations currently configured in web UI.'
|
|
36344
|
+
externalDocs:
|
|
36345
|
+
description: Find out more at
|
|
36346
|
+
url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/
|
|
36347
|
+
name: Logs Custom Destinations
|
|
33574
36348
|
- description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
|
|
33575
36349
|
for your organization.
|
|
33576
36350
|
externalDocs:
|
|
@@ -33584,7 +36358,8 @@ tags:
|
|
|
33584
36358
|
points\nand as the timeframe over which a metric is viewed increases,\naggregation
|
|
33585
36359
|
between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete
|
|
33586
36360
|
`manage_tags` API methods can only be performed by\na user who has the `Manage
|
|
33587
|
-
Tags for Metrics` permission.
|
|
36361
|
+
Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/)
|
|
36362
|
+
for more information."
|
|
33588
36363
|
name: Metrics
|
|
33589
36364
|
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
|
|
33590
36365
|
a metric or check that you care about and
|
|
@@ -33600,8 +36375,8 @@ tags:
|
|
|
33600
36375
|
description: Find out more at
|
|
33601
36376
|
url: https://docs.datadoghq.com/monitors/create/types/
|
|
33602
36377
|
name: Monitors
|
|
33603
|
-
- description: Configure your Datadog Okta integration
|
|
33604
|
-
API.
|
|
36378
|
+
- description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/)
|
|
36379
|
+
directly through the Datadog API.
|
|
33605
36380
|
name: Okta Integration
|
|
33606
36381
|
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
|
33607
36382
|
|
|
@@ -33615,25 +36390,33 @@ tags:
|
|
|
33615
36390
|
description: Find out more at
|
|
33616
36391
|
url: https://docs.datadoghq.com/account_management/multi_organization
|
|
33617
36392
|
name: Organizations
|
|
33618
|
-
- description: 'The
|
|
36393
|
+
- description: 'The Powerpack endpoints allow you to:
|
|
36394
|
+
|
|
36395
|
+
|
|
36396
|
+
- Get a Powerpack
|
|
33619
36397
|
|
|
36398
|
+
- Create a Powerpack
|
|
33620
36399
|
|
|
33621
|
-
-
|
|
36400
|
+
- Delete a Powerpack
|
|
33622
36401
|
|
|
33623
|
-
-
|
|
36402
|
+
- Get a list of all Powerpacks
|
|
33624
36403
|
|
|
33625
|
-
- Delete a powerpack
|
|
33626
36404
|
|
|
33627
|
-
|
|
36405
|
+
The Patch and Delete API methods can only be performed on a Powerpack by
|
|
33628
36406
|
|
|
36407
|
+
a user who has the powerpack create permission for that specific Powerpack.
|
|
33629
36408
|
|
|
33630
|
-
The Patch and Delete API methods can only be performed on a powerpack by
|
|
33631
36409
|
|
|
33632
|
-
|
|
36410
|
+
Read [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/)
|
|
36411
|
+
for more information.'
|
|
33633
36412
|
name: Powerpack
|
|
33634
36413
|
- description: The processes API allows you to query processes data for your organization.
|
|
36414
|
+
See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
|
|
36415
|
+
for more information.
|
|
33635
36416
|
name: Processes
|
|
33636
|
-
- description:
|
|
36417
|
+
- description: Manage your Real User Monitoring (RUM) applications, and search or
|
|
36418
|
+
aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
|
|
36419
|
+
for more information
|
|
33637
36420
|
name: RUM
|
|
33638
36421
|
- description: 'A restriction policy defines the access control rules for a resource,
|
|
33639
36422
|
mapping a set of relations
|
|
@@ -33659,20 +36442,36 @@ tags:
|
|
|
33659
36442
|
|
|
33660
36443
|
[Pipelines page](https://app.datadoghq.com/logs/pipelines).'
|
|
33661
36444
|
name: Roles
|
|
33662
|
-
- description:
|
|
33663
|
-
|
|
33664
|
-
|
|
36445
|
+
- description: Create and manage your security rules, signals, filters, and more.
|
|
36446
|
+
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
|
|
36447
|
+
information.
|
|
33665
36448
|
name: Security Monitoring
|
|
33666
36449
|
- description: Create, update, delete, and retrieve sensitive data scanner groups
|
|
33667
|
-
and rules.
|
|
36450
|
+
and rules. See the [Sensitive Data Scanner page](https://docs.datadoghq.com/sensitive_data_scanner/)
|
|
36451
|
+
for more information.
|
|
33668
36452
|
name: Sensitive Data Scanner
|
|
33669
|
-
- description: Create, edit, and disable service accounts.
|
|
36453
|
+
- description: Create, edit, and disable service accounts. See the [Service Accounts
|
|
36454
|
+
page](https://docs.datadoghq.com/account_management/org_settings/service_accounts/)
|
|
36455
|
+
for more information.
|
|
33670
36456
|
name: Service Accounts
|
|
33671
36457
|
- description: API to create, update, retrieve and delete service definitions.
|
|
33672
36458
|
externalDocs:
|
|
33673
36459
|
url: https://docs.datadoghq.com/tracing/service_catalog/
|
|
33674
36460
|
name: Service Definition
|
|
33675
|
-
- description: '
|
|
36461
|
+
- description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)
|
|
36462
|
+
|
|
36463
|
+
(SLOs) are a key part of the site reliability engineering toolkit.
|
|
36464
|
+
|
|
36465
|
+
SLOs provide a framework for defining clear targets around application performance,
|
|
36466
|
+
|
|
36467
|
+
which ultimately help teams provide a consistent customer experience,
|
|
36468
|
+
|
|
36469
|
+
balance feature development with platform stability,
|
|
36470
|
+
|
|
36471
|
+
and improve communication with internal and external users.'
|
|
36472
|
+
name: Service Level Objectives
|
|
36473
|
+
- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
|
|
36474
|
+
for more information.
|
|
33676
36475
|
|
|
33677
36476
|
|
|
33678
36477
|
This feature is currently in BETA. If you have any feedback, contact [Datadog
|
|
@@ -33681,7 +36480,8 @@ tags:
|
|
|
33681
36480
|
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
|
33682
36481
|
name: Spans
|
|
33683
36482
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|
|
33684
|
-
for your organization.
|
|
36483
|
+
for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/)
|
|
36484
|
+
for more information.
|
|
33685
36485
|
externalDocs:
|
|
33686
36486
|
description: Find out more at
|
|
33687
36487
|
url: https://docs.datadoghq.com/tracing/metrics/metrics_namespace/
|
|
@@ -33693,7 +36493,8 @@ tags:
|
|
|
33693
36493
|
use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more
|
|
33694
36494
|
information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)."
|
|
33695
36495
|
name: Synthetics
|
|
33696
|
-
- description: View and manage teams within Datadog.
|
|
36496
|
+
- description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/)
|
|
36497
|
+
for more information.
|
|
33697
36498
|
name: Teams
|
|
33698
36499
|
- description: 'The usage metering API allows you to get hourly, daily, and
|
|
33699
36500
|
|